docs/root.txt

   1 Evergreen Documentation
   2 =======================
   3 Documentation Interest Group
   4 :doctype: book
   5 :toc:
   6 :numbered:
   7
   8 Introduction
   9 ============
  10
  11 About This Documentation
  12 ------------------------
  13
  14 This guide was produced by the Evergreen Documentation Interest Group (DIG),
  15 consisting of numerous volunteers from many different organizations. The DIG
  16 has drawn together, edited, and supplemented pre-existing documentation
  17 contributed by libraries and consortia running Evergreen that were kind enough
  18 to release their documentation into the creative commons. Please see the
  19 <<attributions,Attributions>> section for a full list of authors and
  20 contributing organizations. Just like the software it describes, this guide is
  21 a work in progress, continually revised to meet the needs of its users, so if
  22 you find errors or omissions, please let us know, by contacting the DIG
  23 facilitators at docs@evergreen-ils.org.
  24
  25 This guide to Evergreen is intended to meet the needs of front-line library
  26 staff, catalogers, library administrators, system administrators, and software
  27 developers. It is organized into Parts, Chapters, and Sections addressing key
  28 aspects of the software, beginning with the topics of broadest interest to the
  29 largest groups of users and progressing to some of the more specialized and
  30 technical topics of interest to smaller numbers of users.
  31
  32 Copies of this guide can be accessed in PDF and HTML formats from http://docs.evergreen-ils.org/.
  33
  34 About Evergreen
  35 ---------------
  36
  37 Evergreen is an open source library automation software designed to meet the
  38 needs of the very smallest to the very largest libraries and consortia. Through
  39 its staff interface, it facilitates the management, cataloging, and circulation
  40 of library materials, and through its online public access interface it helps
  41 patrons find those materials.
  42
  43 The Evergreen software is freely licensed under the GNU General Public License,
  44 meaning that it is free to download, use, view, modify, and share. It has an
  45 active development and user community, as well as several companies offering
  46 migration, support, hosting, and development services.
  47
  48 The community’s development requirements state that Evergreen must be:
  49
  50 * Stable, even under extreme load.
  51 * Robust, and capable of handling a high volume of transactions and simultaneous users.
  52 * Flexible, to accommodate the varied needs of libraries.
  53 * Secure, to protect our patrons’ privacy and data.
  54 * User-friendly, to facilitate patron and staff use of the system.
  55
  56 Evergreen, which first launched in 2006 now powers over 544 libraries of every
  57 type – public, academic, special, school, and even tribal and home libraries –
  58 in over a dozen countries worldwide.
  59
  60
  61 include::RELEASE_NOTES_2_6.txt[]
  62
  63
  64 Software Installation
  65 =====================
  66
  67
  68 Introduction
  69 ------------
  70
  71 This part will guide you through the installation steps installation or
  72 upgrading your Evergreen system. It is intended for system administrators.
  73
  74
  75 include::installation/system_requirements.txt[]
  76
  77 // Push titles down one level.
  78 :leveloffset: 1
  79
  80 include::installation/server_installation.txt[]
  81
  82 // Return to normal title levels.
  83 :leveloffset: 0
  84
  85 include::installation/staff_client_installation.txt[]
  86
  87 include::installation/server_upgrade.txt[]
  88
  89 include::installation/edi_setup.txt[]
  90
  91
  92 System Configuration and Customization
  93 ======================================
  94
  95 Introduction
  96 ------------
  97
  98 The Evergreen system allows a free range of customizations to every aspect of
  99 the system. Use this part of the documentation to become familiar with the tools
 100 for configuring the system as well as customizing the catalog and staff client.
 101
 102 // Push titles down one level.
 103 :leveloffset: 1
 104
 105 include::admin_initial_setup/describing_your_organization.txt[]
 106
 107 include::admin_initial_setup/describing_your_people.txt[]
 108
 109 include::admin_initial_setup/migrating_patron_data.txt[]
 110
 111 include::admin_initial_setup/migrating_your_data.txt[]
 112
 113 include::admin_initial_setup/importing_via_staff_client.txt[]
 114
 115 include::admin_initial_setup/ordering_materials.txt[]
 116
 117 include::admin_initial_setup/designing_your_catalog.txt[]
 118
 119 include::admin_initial_setup/borrowing_items.txt[]
 120
 121 // Return to normal title levels.
 122 :leveloffset: 0
 123
 124 include::admin/template_toolkit.txt[]
 125
 126 // Push titles down one level.
 127 :leveloffset: 1
 128
 129 include::opac/new_skin_customizations.txt[]
 130
 131 // Return to normal title levels.
 132 :leveloffset: 0
 133
 134 include::admin/auto_suggest_search.txt[]
 135
 136 include::admin/authentication_proxy.txt[]
 137
 138 include::admin/customize_staff_client.txt[]
 139
 140 // Push titles down one level.
 141 :leveloffset: 1
 142
 143 include::admin/phonelist.txt[]
 144
 145 // Return to normal title levels.
 146 :leveloffset: 0
 147
 148 include::admin/sip_server.txt[]
 149
 150
 151 Using the Staff Client
 152 ======================
 153
 154
 155 Introduction
 156 ------------
 157
 158 This part of the documentation deals with general Staff Client usage including
 159 logging in, navigation and shortcuts.
 160
 161
 162 include::admin/staff_client-login.txt[]
 163
 164 include::admin/staff_client-button_bar_toolbar.txt[]
 165
 166 include::admin/staff_client-sticky_settings.txt[]
 167
 168 include::admin/staff_client-tab_buttons.txt[]
 169
 170 include::admin/staff_client-double_clicking.txt[]
 171
 172 include::admin/staff_client-patron_border.txt[]
 173
 174 include::admin/staff_client-sorting_columns.txt[]
 175
 176 include::admin/staff_client-column_picker.txt[]
 177
 178 include::admin/staff_client-recent_searches.txt[]
 179
 180 include::admin/staff_client-return_to_results_from_marc.txt[]
 181
 182 include::admin/workstation_admin.txt[]
 183
 184 System Administration From the Staff Client
 185 ===========================================
 186
 187 Introduction
 188 ------------
 189
 190 This part deals with the options in the Server Administration menu found in the
 191 staff client.
 192
 193 // Follow structure from staff client system admin menu.
 194
 195 include::admin/acquisitions_admin.txt[]
 196
 197 include::admin/authorities.txt[]
 198
 199 include::admin/Best_Hold_Selection_Sort_Order.txt[]
 200
 201 include::admin/cn_prefixes_and_suffixes.txt[]
 202
 203 include::admin/circulation_limit_groups.txt[]
 204
 205 include::admin/booking-admin.txt[]
 206
 207 // Push titles down one level.
 208 :leveloffset: 1
 209
 210 include::admin/floating_groups.txt[]
 211
 212 // Return to normal title levels.
 213 :leveloffset: 0
 214
 215 include::admin/MARC_Import_Remove_Fields.txt[]
 216
 217 include::admin/Org_Unit_Proximity_Adjustments.txt[]
 218
 219 include::admin/permissions.txt[]
 220
 221 include::admin/SMS_messaging.txt[]
 222
 223 include::admin/user_activity_type.txt[]
 224
 225 include::admin/restrict_Z39.50_sources_by_perm_group.txt[]
 226
 227
 228 Local Administration
 229 ====================
 230
 231 Introduction
 232 ------------
 233
 234 This part covers the options in the Local Administration menu found in the staff
 235 client.
 236
 237 // Follow structure from staff client local admin menu.
 238
 239 // Push titles down one level.
 240 :leveloffset: 1
 241
 242 include::admin/hold_driven_recalls.txt[]
 243
 244 // Return to normal title levels.
 245 :leveloffset: 0
 246
 247 include::admin/actiontriggers.txt[]
 248
 249 include::admin/recent_staff_searches.txt[]
 250
 251 include::admin/lsa-library_settings_editor.txt[]
 252
 253 include::admin/lsa-standing_penalties.txt[]
 254
 255 include::admin/lsa-statcat.txt[]
 256
 257 include::admin/lsa-work_log.txt[]
 258
 259 Acquisitions
 260 ===========
 261
 262 include::acquisitions/introduction.txt[]
 263
 264 include::acquisitions/selection_lists_po.txt[]
 265
 266 include::acquisitions/invoices.txt[]
 267
 268 include::acquisitions/receive_items_from_invoice.txt[]
 269
 270 include::acquisitions/vandelay_acquisitions_integration.txt[]
 271
 272
 273 Cataloging
 274 ==========
 275
 276 Introduction
 277 ------------
 278
 279 Cataloguers should use this part for understanding the cataloguing procedures
 280 used in Evergreen.
 281
 282 include::cataloging/batch_importing_MARC.txt[]
 283
 284 include::cataloging/overlay_record_3950_import.txt[]
 285
 286 include::cataloging/z39.50_search_enhancements.txt[]
 287
 288 include::cataloging/monograph_parts.txt[]
 289
 290 include::cataloging/conjoined_items.txt[]
 291
 292 include::cataloging/cataloging_electronic_resources.txt[]
 293
 294 include::cataloging/link_checker.txt[]
 295
 296
 297 Serials
 298 =======
 299
 300 include::serials/A-intro.txt[]
 301
 302 include::serials/B-copy_template.txt[]
 303
 304 include::serials/C-subscription-SCV.txt[]
 305
 306 include::serials/D-subscription-ASCV.txt[]
 307
 308 include::serials/E-edit_subscriptions.txt[]
 309
 310 include::serials/F-Receiving.txt[]
 311
 312 include::serials/G-Special_issue.txt[]
 313
 314 include::serials/H-holdings_statements.txt[]
 315
 316 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.txt[]
 317
 318 Circulation
 319 ===========
 320
 321 Introduction
 322 ------------
 323
 324 Use this section for understanding the circulation procedures in the Evergreen
 325 system.
 326
 327 include::circulation/circulating_items.txt[]
 328
 329 include::circulation/holds.txt[]
 330
 331 include::circulation/booking.txt[]
 332
 333 include::circulation/circulation_patron_records.txt[]
 334
 335 include::circulation/triggered_events.txt[]
 336
 337 // Push titles down one level.
 338 :leveloffset: 1
 339
 340 include::circulation/offline_mode.txt[]
 341
 342 include::circulation/self_check.txt[]
 343
 344 include::circulation/rfid_product_integration.txt[]
 345
 346 // Return to normal title levels.
 347 :leveloffset: 0
 348
 349 Reports
 350 =======
 351
 352 Introduction
 353 ------------
 354
 355 Learn how to create and use reports in Evergreen.
 356
 357 include::reports/reporter_daemon.txt[]
 358
 359 include::reports/reporter_folder.txt[]
 360
 361 include::reports/reporter_create_templates.txt[]
 362
 363 include::reports/reporter_generating_reports.txt[]
 364
 365 include::reports/reporter_view_output.txt[]
 366
 367 include::reports/reporter_cloning_shared_templates.txt[]
 368
 369 include::reports/reporter_add_data_source.txt[]
 370
 371 include::reports/reporter_running_recurring_reports.txt[]
 372
 373 include::reports/reporter_template_terminology.txt[]
 374
 375 include::reports/reporter_export_usingpgAdmin.txt[]
 376
 377 Using the Public Access Catalog
 378 ===============================
 379
 380 Introduction
 381 ------------
 382
 383 Evergreen has a public OPAC that meets WCAG guidelines (http://www.w3.org/WAI/intro/wcag), which helps make the OPAC accessible to users with a range of disabilities. This part of the documentation explains how to use the Evergreen public OPAC. It covers the basic catalog and more advanced search topics. It also describes the ``My Account'' tools users have to find information and manage their personal library accounts through the OPAC. This section could be used by staff and patrons but would be more useful for staff as a generic reference when developing custom guides and tutorials for their users.
 384
 385 include::opac/using_the_public_access_catalog.txt[]
 386
 387 include::opac/my_lists.txt[]
 388
 389 include::opac/kids_opac.txt[]
 390
 391 include::opac/catalog_browse.txt[]
 392
 393 include::opac/advanced_features.txt[]
 394
 395 include::opac/linked_libraries.txt[]
 396
 397 include::opac/opensearch.txt[]
 398
 399 // Push titles down one level.
 400 :leveloffset: 1
 401
 402 include::opac/search_form.txt[]
 403
 404 // Return to normal title levels.
 405 :leveloffset: 0
 406
 407
 408 Developer Resources
 409 ===================
 410
 411 Introduction
 412 ------------
 413
 414 Developers can use this part to learn more about the programming languages,
 415 communication protocols and standards used in Evergreen.
 416
 417 include::development/support_scripts.txt[]
 418
 419 // Push titles down one level.
 420 :leveloffset: 1
 421
 422 include::development/pgtap.txt[]
 423 include::development/intro_opensrf.txt[]
 424 include::development/updating_translations_launchpad.txt[]
 425
 426 // Return to normal title levels.
 427 :leveloffset: 0
 428
 429 include::attributions.txt[]
 430
 431 include::licensing.txt[]
 432
 433 [appendix]
 434 Admonitions
 435 ===========
 436
 437 * Note
 438
 439 image::media/note.png[]
 440
 441 * warning
 442
 443 image::media/warning.png[]
 444
 445 * caution
 446
 447 image::media/caution.png[]
 448
 449 * tip
 450
 451 image::media/tip.png[]
 452
 453 [index]
 454 Index
 455 =====
 456