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_7.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 // Push titles down one level.
 139 :leveloffset: 1
 140
 141 include::TechRef/KidsOPAC.txt[]
 142
 143 // Return to normal title levels.
 144 :leveloffset: 0
 145
 146 include::admin/customize_staff_client.txt[]
 147
 148 include::admin/patron_address_by_zip_code.txt[]
 149
 150 // Push titles down one level.
 151 :leveloffset: 1
 152
 153 include::admin/phonelist.txt[]
 154
 155 // Return to normal title levels.
 156 :leveloffset: 0
 157
 158 include::admin/sip_server.txt[]
 159
 160 Using the Staff Client
 161 ======================
 162
 163
 164 Introduction
 165 ------------
 166
 167 This part of the documentation deals with general Staff Client usage including
 168 logging in, navigation and shortcuts.
 169
 170
 171 include::admin/staff_client-login.txt[]
 172
 173 include::admin/staff_client-button_bar_toolbar.txt[]
 174
 175 include::admin/staff_client-sticky_settings.txt[]
 176
 177 include::admin/staff_client-tab_buttons.txt[]
 178
 179 include::admin/staff_client-double_clicking.txt[]
 180
 181 include::admin/staff_client-patron_border.txt[]
 182
 183 include::admin/staff_client-sorting_columns.txt[]
 184
 185 include::admin/staff_client-column_picker.txt[]
 186
 187 include::admin/staff_client-recent_searches.txt[]
 188
 189 include::admin/staff_client-return_to_results_from_marc.txt[]
 190
 191 include::admin/workstation_admin.txt[]
 192
 193 // Push titles down one level.
 194 :leveloffset: 1
 195
 196 include::admin/workstation_admin_receipt_template_editor.txt[]
 197
 198 // Return to normal title levels.
 199 :leveloffset: 0
 200
 201 include::admin/workstation_admin_customizable_toolbar.txt[]
 202
 203 System Administration From the Staff Client
 204 ===========================================
 205
 206 Introduction
 207 ------------
 208
 209 This part deals with the options in the Server Administration menu found in the
 210 staff client.
 211
 212 // Follow structure from staff client system admin menu.
 213
 214 include::admin/acquisitions_admin.txt[]
 215
 216 include::admin/authorities.txt[]
 217
 218 include::admin/Best_Hold_Selection_Sort_Order.txt[]
 219
 220 include::admin/booking-admin.txt[]
 221
 222 include::admin/cn_prefixes_and_suffixes.txt[]
 223
 224 include::admin/circulation_limit_groups.txt[]
 225
 226 include::admin/copy_statuses.txt[]
 227
 228 // Push titles down one level.
 229 :leveloffset: 1
 230
 231 include::admin/floating_groups.txt[]
 232
 233 // Return to normal title levels.
 234 :leveloffset: 0
 235
 236 include::admin/MARC_Import_Remove_Fields.txt[]
 237
 238 include::admin/MARC_RAD_MVF_CRA.txt[]
 239
 240 include::admin/Org_Unit_Proximity_Adjustments.txt[]
 241
 242 include::admin/permissions.txt[]
 243
 244 include::admin/SMS_messaging.txt[]
 245
 246 include::admin/user_activity_type.txt[]
 247
 248 include::admin/restrict_Z39.50_sources_by_perm_group.txt[]
 249
 250
 251 Local Administration
 252 ====================
 253
 254 Introduction
 255 ------------
 256
 257 This part covers the options in the Local Administration menu found in the staff
 258 client.
 259
 260 // Follow structure from staff client local admin menu.
 261
 262 include::admin/lsa-address_alert.txt[]
 263
 264 // Push titles down one level.
 265 :leveloffset: 1
 266
 267 include::admin/hold_driven_recalls.txt[]
 268
 269 // Return to normal title levels.
 270 :leveloffset: 0
 271
 272 include::admin/actiontriggers.txt[]
 273
 274 include::admin/recent_staff_searches.txt[]
 275
 276 include::admin/lsa-library_settings_editor.txt[]
 277
 278 include::admin/lsa-standing_penalties.txt[]
 279
 280 include::admin/lsa-statcat.txt[]
 281
 282 include::admin/lsa-work_log.txt[]
 283
 284 Acquisitions
 285 ===========
 286
 287 include::acquisitions/introduction.txt[]
 288
 289 include::acquisitions/selection_lists_po.txt[]
 290
 291 include::acquisitions/invoices.txt[]
 292
 293 include::acquisitions/receive_items_from_invoice.txt[]
 294
 295 include::acquisitions/vandelay_acquisitions_integration.txt[]
 296
 297
 298 Cataloging
 299 ==========
 300
 301 Introduction
 302 ------------
 303
 304 Cataloguers should use this part for understanding the cataloguing procedures
 305 used in Evergreen.
 306
 307 include::cataloging/MARC_Fixed_Field.txt[]
 308
 309 include::cataloging/physical_char_wizard.txt[]
 310
 311 include::cataloging/batch_importing_MARC.txt[]
 312
 313 include::cataloging/overlay_record_3950_import.txt[]
 314
 315 include::cataloging/z39.50_search_enhancements.txt[]
 316
 317 include::cataloging/monograph_parts.txt[]
 318
 319 include::cataloging/conjoined_items.txt[]
 320
 321 include::cataloging/cataloging_electronic_resources.txt[]
 322
 323 include::cataloging/tpac_copy_edit_links.txt[]
 324
 325 include::cataloging/MARC_batch_edit.txt[]
 326
 327 include::cataloging/link_checker.txt[]
 328
 329
 330 Serials
 331 =======
 332
 333 include::serials/A-intro.txt[]
 334
 335 include::serials/B-copy_template.txt[]
 336
 337 include::serials/C-subscription-SCV.txt[]
 338
 339 include::serials/D-subscription-ASCV.txt[]
 340
 341 include::serials/E-edit_subscriptions.txt[]
 342
 343 include::serials/F-Receiving.txt[]
 344
 345 include::serials/G-Special_issue.txt[]
 346
 347 include::serials/H-holdings_statements.txt[]
 348
 349 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.txt[]
 350
 351 Circulation
 352 ===========
 353
 354 Introduction
 355 ------------
 356
 357 Use this section for understanding the circulation procedures in the Evergreen
 358 system.
 359
 360 include::circulation/circulating_items.txt[]
 361
 362 include::circulation/holds.txt[]
 363
 364 include::circulation/booking.txt[]
 365
 366 include::circulation/circulation_patron_records.txt[]
 367
 368 include::circulation/triggered_events.txt[]
 369
 370 // Push titles down one level.
 371 :leveloffset: 1
 372
 373 include::circulation/offline_mode.txt[]
 374
 375 include::circulation/self_check.txt[]
 376
 377 include::circulation/rfid_product_integration.txt[]
 378
 379 // Return to normal title levels.
 380 :leveloffset: 0
 381
 382 Reports
 383 =======
 384
 385 Introduction
 386 ------------
 387
 388 Learn how to create and use reports in Evergreen.
 389
 390 include::reports/reporter_daemon.txt[]
 391
 392 include::reports/reporter_folder.txt[]
 393
 394 include::reports/reporter_create_templates.txt[]
 395
 396 include::reports/reporter_generating_reports.txt[]
 397
 398 include::reports/reporter_view_output.txt[]
 399
 400 include::reports/reporter_cloning_shared_templates.txt[]
 401
 402 include::reports/reporter_add_data_source.txt[]
 403
 404 include::reports/reporter_running_recurring_reports.txt[]
 405
 406 include::reports/reporter_template_terminology.txt[]
 407
 408 include::reports/reporter_template_enhancements.txt[]
 409
 410 include::reports/reporter_export_usingpgAdmin.txt[]
 411
 412 Web Client Preview
 413 ==================
 414
 415 Introduction
 416 ------------
 417
 418 Using the Web Client
 419 --------------------
 420
 421 Introduction
 422 ~~~~~~~~~~~~
 423 This part of the documentation deals with general client usage including
 424 logging in, navigation and shortcuts.
 425
 426 Circulation
 427 -----------
 428 Use this section for understanding the circulation procedures in the Evergreen system.
 429
 430
 431 Using the Public Access Catalog
 432 ===============================
 433
 434 Introduction
 435 ------------
 436
 437 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.
 438
 439 include::opac/using_the_public_access_catalog.txt[]
 440
 441 include::opac/my_lists.txt[]
 442
 443 include::opac/kids_opac.txt[]
 444
 445 include::opac/catalog_browse.txt[]
 446
 447 include::opac/advanced_features.txt[]
 448
 449 include::opac/tpac_meta_record_holds.txt[]
 450
 451 include::opac/linked_libraries.txt[]
 452
 453 include::opac/opensearch.txt[]
 454
 455 // Push titles down one level.
 456 :leveloffset: 1
 457
 458 include::opac/search_form.txt[]
 459
 460 // Return to normal title levels.
 461 :leveloffset: 0
 462
 463
 464 Developer Resources
 465 ===================
 466
 467 Introduction
 468 ------------
 469
 470 Developers can use this part to learn more about the programming languages,
 471 communication protocols and standards used in Evergreen.
 472
 473 include::development/support_scripts.txt[]
 474
 475 // Push titles down one level.
 476 :leveloffset: 1
 477
 478 include::development/pgtap.txt[]
 479 include::development/intro_opensrf.txt[]
 480 include::development/updating_translations_launchpad.txt[]
 481
 482 // Return to normal title levels.
 483 :leveloffset: 0
 484
 485 include::attributions.txt[]
 486
 487 include::licensing.txt[]
 488
 489 [appendix]
 490 Admonitions
 491 ===========
 492
 493 * Note
 494
 495 image::media/note.png[]
 496
 497 * warning
 498
 499 image::media/warning.png[]
 500
 501 * caution
 502
 503 image::media/caution.png[]
 504
 505 * tip
 506
 507 image::media/tip.png[]
 508
 509 [index]
 510 Index
 511 =====
 512