docs/root.adoc

   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_3_2.adoc[]
  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.adoc[]
  76
  77 // Push titles down one level.
  78 :leveloffset: 1
  79
  80 include::installation/server_installation.adoc[]
  81
  82 // Return to normal title levels.
  83 :leveloffset: 0
  84
  85 include::installation/server_upgrade.adoc[]
  86
  87 include::installation/edi_setup.adoc[]
  88
  89
  90 System Configuration and Customization
  91 ======================================
  92
  93 Introduction
  94 ------------
  95
  96 The Evergreen system allows a free range of customizations to every aspect of
  97 the system. Use this part of the documentation to become familiar with the tools
  98 for configuring the system as well as customizing the catalog and staff client.
  99
 100 // Push titles down one level.
 101 :leveloffset: 1
 102
 103 include::admin_initial_setup/describing_your_organization.adoc[]
 104
 105 include::admin_initial_setup/describing_your_people.adoc[]
 106
 107 include::admin_initial_setup/migrating_patron_data.adoc[]
 108
 109 include::admin_initial_setup/migrating_your_data.adoc[]
 110
 111 include::admin_initial_setup/importing_via_staff_client.adoc[]
 112
 113 include::admin_initial_setup/ordering_materials.adoc[]
 114
 115 include::admin_initial_setup/designing_your_catalog.adoc[]
 116
 117 include::admin_initial_setup/different_styles_for_searchbar.adoc[]
 118
 119 include::admin/search_interface.adoc[]
 120
 121 include::admin_initial_setup/borrowing_items.adoc[]
 122
 123 // Return to normal title levels.
 124 :leveloffset: 0
 125
 126 include::admin_initial_setup/hard_due_dates.adoc[]
 127
 128
 129
 130 include::admin/template_toolkit.adoc[]
 131
 132 // Push titles down one level.
 133 :leveloffset: 1
 134
 135 include::opac/new_skin_customizations.adoc[]
 136
 137 // Return to normal title levels.
 138 :leveloffset: 0
 139
 140 include::admin/auto_suggest_search.adoc[]
 141
 142 include::admin/authentication_proxy.adoc[]
 143
 144 // Push titles down one level.
 145 :leveloffset: 1
 146
 147 include::TechRef/KidsOPAC.adoc[]
 148
 149 // Return to normal title levels.
 150 :leveloffset: 0
 151
 152 include::admin/patron_address_by_zip_code.adoc[]
 153
 154 // Push titles down one level.
 155 :leveloffset: 1
 156
 157 include::admin/phonelist.adoc[]
 158
 159 // Return to normal title levels.
 160 :leveloffset: 0
 161
 162 include::admin/sip_server.adoc[]
 163
 164 :leveloffset: 1
 165
 166 include::admin/sip_privacy.adoc[]
 167
 168 :leveloffset: 0
 169
 170 include::admin/apache_rewrite_tricks.adoc[]
 171
 172 include::admin/apache_access_handler.adoc[]
 173
 174 include::admin/ebook_api_service.adoc[]
 175
 176 include::admin/hold_targeter_service.adoc[]
 177
 178 // Push titles down one level.
 179 :leveloffset: 1
 180
 181 include::admin/backups.adoc[]
 182
 183 // Return to normal title levels.
 184 :leveloffset: 0
 185
 186
 187
 188 Using the Browser Staff Client
 189 ==============================
 190
 191
 192 Introduction
 193 ------------
 194
 195 This part of the documentation deals with general Browser Client usage including
 196 logging in, navigation and shortcuts.
 197
 198 For information about the XUL client, consult the http://docs.evergreen-ils.org/2.11/[Evergreen 2.11 documentation].
 199
 200 include::admin/web_client-login.adoc[]
 201
 202 include::admin/web-client-browser-best-practices.adoc[]
 203
 204 include::admin/staff_client-column_picker.adoc[]
 205
 206 include::admin/staff_client-recent_searches.adoc[]
 207
 208 include::admin/workstation_admin.adoc[]
 209
 210 // Push titles down one level.
 211 :leveloffset: 1
 212
 213 include::admin/receipt_template_editor.adoc[]
 214
 215 // Return to normal title levels.
 216 :leveloffset: 0
 217
 218 System Administration From the Staff Client
 219 ===========================================
 220
 221 Introduction
 222 ------------
 223
 224 This part deals with the options in the Server Administration menu found in the
 225 staff client.
 226
 227 // Follow structure from staff client system admin menu.
 228
 229 include::admin/acquisitions_admin.adoc[]
 230
 231 include::admin/age_hold_protection.adoc[]
 232
 233 include::admin/authorities.adoc[]
 234
 235 include::admin/Best_Hold_Selection_Sort_Order.adoc[]
 236
 237 include::admin/booking-admin.adoc[]
 238
 239 include::admin/cn_prefixes_and_suffixes.adoc[]
 240
 241 include::admin/desk_payments.adoc[]
 242
 243 include::admin/circulation_limit_groups.adoc[]
 244
 245 include::admin/copy_statuses.adoc[]
 246
 247 // Push titles down one level.
 248 :leveloffset: 1
 249
 250 include::admin/floating_groups.adoc[]
 251
 252 // Return to normal title levels.
 253 :leveloffset: 0
 254
 255 include::admin/MARC_Import_Remove_Fields.adoc[]
 256
 257 include::admin/copy_tags_admin.adoc[]
 258
 259 include::admin/MARC_RAD_MVF_CRA.adoc[]
 260
 261 include::admin/multilingual_search.adoc[]
 262
 263 include::admin/Org_Unit_Proximity_Adjustments.adoc[]
 264
 265 :leveloffset: -1
 266
 267 include::admin/physical_char_wizard_db.adoc[]
 268
 269 :leveloffset: 0
 270
 271 include::admin/permissions.adoc[]
 272
 273 include::admin/SMS_messaging.adoc[]
 274
 275 include::admin/user_activity_type.adoc[]
 276
 277 include::admin/restrict_Z39.50_sources_by_perm_group.adoc[]
 278
 279
 280 Local Administration
 281 ====================
 282
 283 Introduction
 284 ------------
 285
 286 This part covers the options in the Local Administration menu found in the staff
 287 client.
 288
 289 // Follow structure from staff client local admin menu.
 290
 291 include::admin/librarysettings.adoc[]
 292
 293 //    Address Alert Feature
 294 include::admin/lsa-address_alert.adoc[]
 295
 296 //    Barcode Completion Feature
 297 include::admin/lsa-barcode_completion.adoc[]
 298
 299 // Push titles down one level.
 300 :leveloffset: 1
 301
 302 include::admin/hold_driven_recalls.adoc[]
 303
 304 // Return to normal title levels.
 305 :leveloffset: 0
 306
 307 include::admin/emergency_closing_handler.adoc[]
 308
 309 include::admin/actiontriggers.adoc[]
 310
 311 include::admin/actiontriggers_process.adoc[]
 312
 313 include::admin/staff_client-recent_searches.adoc[]
 314
 315 include::admin/lsa-standing_penalties.adoc[]
 316
 317 include::admin/lsa-statcat.adoc[]
 318
 319 include::admin/popularity_badges_web_client.adoc[]
 320
 321 include::admin/lsa-work_log.adoc[]
 322
 323 Acquisitions
 324 ===========
 325
 326 include::acquisitions/introduction.adoc[]
 327
 328 include::acquisitions/selection_lists_po.adoc[]
 329
 330 include::acquisitions/invoices.adoc[]
 331
 332 include::acquisitions/receive_items_from_invoice.adoc[]
 333
 334 include::acquisitions/vandelay_acquisitions_integration.adoc[]
 335
 336 include::acquisitions/purchase_requests_patron_view.adoc[]
 337
 338 include::acquisitions/purchase_requests_management.adoc[]
 339
 340 include::acquisitions/blanket.adoc[]
 341
 342
 343 Cataloging
 344 ==========
 345
 346 Introduction
 347 ------------
 348
 349 This part describes cataloging in Evergreen.
 350
 351 include::cataloging/marc_tag_table.adoc[]
 352
 353 include::cataloging/copy-buckets_web_client.adoc[]
 354
 355 include::cataloging/copy_tags_cataloging.adoc[]
 356
 357 include::cataloging/MARC_Editor.adoc[]
 358
 359 :leveloffset: 1
 360
 361 include::cataloging/record_buckets.adoc[]
 362
 363 // Return titles to correct level.
 364 :leveloffset: 0
 365
 366 include::cataloging/physical_char_wizard.adoc[]
 367
 368 include::admin/staff_client-return_to_results_from_marc.adoc[]
 369
 370 include::cataloging/batch_importing_MARC.adoc[]
 371
 372 include::cataloging/overlay_record_3950_import.adoc[]
 373
 374 include::cataloging/z39.50_search_enhancements.adoc[]
 375
 376
 377 include::cataloging/monograph_parts.adoc[]
 378
 379
 380 include::cataloging/conjoined_items.adoc[]
 381
 382 include::cataloging/cataloging_electronic_resources.adoc[]
 383
 384 include::cataloging/item_status.adoc[]
 385
 386 include::cataloging/volcopy_editor.adoc[]
 387
 388 :leveloffset: 1
 389
 390 include::cataloging/tpac_copy_edit_links.adoc[]
 391
 392 :leveloffset: 0
 393
 394 include::cataloging/MARC_batch_edit.adoc[]
 395
 396 include::cataloging/authorities.adoc[]
 397
 398 include::cataloging/link_checker.adoc[]
 399
 400 include::admin/schema_bibliographic.adoc[]
 401
 402 include::admin/marc_templates.adoc[]
 403
 404
 405 Serials
 406 =======
 407
 408 include::serials/A-intro.adoc[]
 409
 410 include::serials/B-serials_admin.adoc[]
 411
 412 include::serials/C-serials_workflow.adoc[]
 413
 414 include::serials/D-Receiving.adoc[]
 415
 416 include::serials/E-routing_lists.adoc[]
 417
 418 include::serials/F-Special_issue.adoc[]
 419
 420 include::serials/G-binding.adoc[]
 421
 422 include::serials/H-holdings_statements.adoc[]
 423
 424 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.adoc[]
 425
 426 Circulation
 427 ===========
 428
 429 Introduction
 430 ------------
 431
 432 Use this section for understanding the circulation procedures in the Evergreen
 433 system.
 434
 435 include::circulation/circulating_items_web_client.adoc[]
 436
 437 Holds Management
 438 ----------------
 439
 440 include::circulation/basic_holds.adoc[]
 441
 442 include::circulation/advanced_holds.adoc[]
 443
 444 include::circulation/booking.adoc[]
 445
 446 include::circulation/circulation_patron_records_web_client.adoc[]
 447
 448 include::admin/patron_self_registration.adoc[]
 449
 450 include::circulation/triggered_events.adoc[]
 451
 452 // Push titles down one level.
 453 :leveloffset: 1
 454
 455 include::circulation/offline_circ_webclient.adoc[]
 456
 457 include::circulation/self_check.adoc[]
 458
 459 // Return to normal title levels.
 460 :leveloffset: 0
 461
 462 Reports
 463 =======
 464
 465 Introduction
 466 ------------
 467
 468 Learn how to create and use reports in Evergreen.
 469
 470 include::reports/reporter_daemon.adoc[]
 471
 472 include::reports/reporter_folder.adoc[]
 473
 474 include::reports/reporter_create_templates.adoc[]
 475
 476 include::reports/reporter_generating_reports.adoc[]
 477
 478 include::reports/reporter_view_output.adoc[]
 479
 480 include::reports/reporter_cloning_shared_templates.adoc[]
 481
 482 include::reports/reporter_add_data_source.adoc[]
 483
 484 include::reports/reporter_running_recurring_reports.adoc[]
 485
 486 include::reports/reporter_template_terminology.adoc[]
 487
 488 include::reports/reporter_template_enhancements.adoc[]
 489
 490 include::reports/reporter_export_usingpgAdmin.adoc[]
 491
 492 Using the Public Access Catalog
 493 ===============================
 494
 495 Introduction
 496 ------------
 497
 498 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.
 499
 500 include::opac/using_the_public_access_catalog.adoc[]
 501
 502 include::opac/my_lists.adoc[]
 503
 504 include::opac/kids_opac.adoc[]
 505
 506 include::opac/catalog_browse.adoc[]
 507
 508 include::opac/advanced_features.adoc[]
 509
 510 include::opac/tpac_meta_record_holds.adoc[]
 511
 512 include::opac/linked_libraries.adoc[]
 513
 514 include::opac/opensearch.adoc[]
 515
 516 // Push titles down one level.
 517 :leveloffset: 1
 518
 519 include::opac/search_form.adoc[]
 520
 521 // Return to normal title levels.
 522 :leveloffset: 0
 523
 524
 525 Developer Resources
 526 ===================
 527
 528 Introduction
 529 ------------
 530
 531 Developers can use this part to learn more about the programming languages,
 532 communication protocols and standards used in Evergreen.
 533
 534 include::development/support_scripts.adoc[]
 535
 536 // Push titles down one level.
 537 :leveloffset: 1
 538
 539 include::development/pgtap.adoc[]
 540 include::development/intro_opensrf.adoc[]
 541 include::development/updating_translations_launchpad.adoc[]
 542
 543 // Return to normal title levels.
 544 :leveloffset: 0
 545
 546
 547 Getting Data from Evergreen
 548 ===========================
 549
 550 Introduction
 551 ------------
 552
 553 You may be interested in re-using data from your Evergreen installation in
 554 another application.  This part describes several methods to get the data
 555 you need.
 556
 557 // Push titles down one level.
 558 :leveloffset: 1
 559
 560 include::development/data_supercat.adoc[]
 561
 562 include::development/data_unapi.adoc[]
 563
 564 include::development/data_opensearch.adoc[]
 565
 566 // Return to normal title levels.
 567 :leveloffset: 0
 568
 569 include::shared/attributions.adoc[]
 570
 571 include::licensing.adoc[]
 572
 573 [appendix]
 574 Admonitions
 575 ===========
 576
 577 * Note
 578
 579 image::media/note.png[]
 580
 581 * warning
 582
 583 image::media/warning.png[]
 584
 585 * caution
 586
 587 image::media/caution.png[]
 588
 589 * tip
 590
 591 image::media/tip.png[]
 592
 593 [index]
 594 Index
 595 =====
 596