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_2_11.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/staff_client_installation.adoc[]
  86
  87 include::installation/server_upgrade.adoc[]
  88
  89 include::installation/edi_setup.adoc[]
  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.adoc[]
 106
 107 include::admin_initial_setup/describing_your_people.adoc[]
 108
 109 include::admin_initial_setup/migrating_patron_data.adoc[]
 110
 111 include::admin_initial_setup/migrating_your_data.adoc[]
 112
 113 include::admin_initial_setup/importing_via_staff_client.adoc[]
 114
 115 include::admin_initial_setup/ordering_materials.adoc[]
 116
 117 include::admin_initial_setup/designing_your_catalog.adoc[]
 118
 119 include::admin_initial_setup/borrowing_items.adoc[]
 120
 121 // Return to normal title levels.
 122 :leveloffset: 0
 123
 124 include::admin_initial_setup/hard_due_dates.adoc[]
 125
 126
 127
 128 include::admin/template_toolkit.adoc[]
 129
 130 // Push titles down one level.
 131 :leveloffset: 1
 132
 133 include::opac/new_skin_customizations.adoc[]
 134
 135 // Return to normal title levels.
 136 :leveloffset: 0
 137
 138 include::admin/auto_suggest_search.adoc[]
 139
 140 include::admin/authentication_proxy.adoc[]
 141
 142 // Push titles down one level.
 143 :leveloffset: 1
 144
 145 include::TechRef/KidsOPAC.adoc[]
 146
 147 // Return to normal title levels.
 148 :leveloffset: 0
 149
 150 include::admin/customize_staff_client.adoc[]
 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 include::admin/apache_rewrite_tricks.adoc[]
 165
 166 include::admin/apache_access_handler.adoc[]
 167
 168
 169 Using the Staff Client
 170 ======================
 171
 172
 173 Introduction
 174 ------------
 175
 176 This part of the documentation deals with general Staff Client usage including
 177 logging in, navigation and shortcuts.
 178
 179
 180 include::admin/staff_client-login.adoc[]
 181
 182 include::admin/staff_client-button_bar_toolbar.adoc[]
 183
 184 include::admin/staff_client-sticky_settings.adoc[]
 185
 186 include::admin/staff_client-tab_buttons.adoc[]
 187
 188 include::admin/staff_client-double_clicking.adoc[]
 189
 190 include::admin/staff_client-patron_border.adoc[]
 191
 192 include::admin/staff_client-sorting_columns.adoc[]
 193
 194 include::admin/staff_client-column_picker.adoc[]
 195
 196 include::admin/staff_client-recent_searches.adoc[]
 197
 198 include::admin/staff_client-return_to_results_from_marc.adoc[]
 199
 200 include::admin/workstation_admin.adoc[]
 201
 202 // Push titles down one level.
 203 :leveloffset: 1
 204
 205 include::admin/workstation_admin_receipt_template_editor.adoc[]
 206
 207 // Return to normal title levels.
 208 :leveloffset: 0
 209
 210 include::admin/workstation_admin_customizable_toolbar.adoc[]
 211
 212 System Administration From the Staff Client
 213 ===========================================
 214
 215 Introduction
 216 ------------
 217
 218 This part deals with the options in the Server Administration menu found in the
 219 staff client.
 220
 221 // Follow structure from staff client system admin menu.
 222
 223 include::admin/acquisitions_admin.adoc[]
 224
 225 include::admin/age_hold_protection.adoc[]
 226
 227 include::admin/authorities.adoc[]
 228
 229 include::admin/Best_Hold_Selection_Sort_Order.adoc[]
 230
 231 include::admin/booking-admin.adoc[]
 232
 233 include::admin/cn_prefixes_and_suffixes.adoc[]
 234
 235 include::admin/circulation_limit_groups.adoc[]
 236
 237 include::admin/copy_statuses.adoc[]
 238
 239 // Push titles down one level.
 240 :leveloffset: 1
 241
 242 include::admin/floating_groups.adoc[]
 243
 244 // Return to normal title levels.
 245 :leveloffset: 0
 246
 247 include::admin/MARC_Import_Remove_Fields.adoc[]
 248
 249 include::admin/MARC_RAD_MVF_CRA.adoc[]
 250
 251 include::admin/Org_Unit_Proximity_Adjustments.adoc[]
 252
 253 include::admin/permissions.adoc[]
 254
 255 include::admin/SMS_messaging.adoc[]
 256
 257 include::admin/user_activity_type.adoc[]
 258
 259 include::admin/restrict_Z39.50_sources_by_perm_group.adoc[]
 260
 261
 262 Local Administration
 263 ====================
 264
 265 Introduction
 266 ------------
 267
 268 This part covers the options in the Local Administration menu found in the staff
 269 client.
 270
 271 // Follow structure from staff client local admin menu.
 272
 273 include::admin/librarysettings.adoc[]
 274
 275 //    Address Alert Feature
 276 include::admin/lsa-address_alert.adoc[]
 277
 278 //    Barcode Completion Feature
 279 include::admin/lsa-barcode_completion.adoc[]
 280
 281 // Push titles down one level.
 282 :leveloffset: 1
 283
 284 include::admin/hold_driven_recalls.adoc[]
 285
 286 // Return to normal title levels.
 287 :leveloffset: 0
 288
 289 include::admin/actiontriggers.adoc[]
 290
 291 include::admin/recent_staff_searches.adoc[]
 292
 293 include::admin/lsa-standing_penalties.adoc[]
 294
 295 include::admin/lsa-statcat.adoc[]
 296
 297 include::admin/lsa-work_log.adoc[]
 298
 299 Acquisitions
 300 ===========
 301
 302 include::acquisitions/introduction.adoc[]
 303
 304 include::acquisitions/selection_lists_po.adoc[]
 305
 306 include::acquisitions/invoices.adoc[]
 307
 308 include::acquisitions/receive_items_from_invoice.adoc[]
 309
 310 include::acquisitions/vandelay_acquisitions_integration.adoc[]
 311
 312 include::acquisitions/purchase_requests_patron_view.adoc[]
 313
 314 include::acquisitions/purchase_requests_management.adoc[]
 315
 316 include::acquisitions/blanket.adoc[]
 317
 318
 319 Cataloging
 320 ==========
 321
 322 Introduction
 323 ------------
 324
 325 Cataloguers should use this part for understanding the cataloguing procedures
 326 used in Evergreen.
 327
 328 include::cataloging/MARC_Editor.adoc[]
 329
 330 // Push titles down one level.
 331 :leveloffset: 2
 332
 333 include::cataloging/physical_char_wizard.adoc[]
 334
 335 // Return titles to correct level.
 336 :leveloffset: 0
 337
 338 include::cataloging/batch_importing_MARC.adoc[]
 339
 340 include::cataloging/overlay_record_3950_import.adoc[]
 341
 342 include::cataloging/z39.50_search_enhancements.adoc[]
 343
 344 include::cataloging/monograph_parts.adoc[]
 345
 346 include::cataloging/conjoined_items.adoc[]
 347
 348 include::cataloging/cataloging_electronic_resources.adoc[]
 349
 350 include::cataloging/tpac_copy_edit_links.adoc[]
 351
 352 include::cataloging/MARC_batch_edit.adoc[]
 353
 354 include::cataloging/authorities.adoc[]
 355
 356 include::cataloging/link_checker.adoc[]
 357
 358
 359 Serials
 360 =======
 361
 362 include::serials/A-intro.adoc[]
 363
 364 include::serials/B-copy_template.adoc[]
 365
 366 include::serials/C-subscription-SCV.adoc[]
 367
 368 include::serials/D-subscription-ASCV.adoc[]
 369
 370 include::serials/E-edit_subscriptions.adoc[]
 371
 372 include::serials/F-Receiving.adoc[]
 373
 374 include::serials/G-Special_issue.adoc[]
 375
 376 include::serials/H-holdings_statements.adoc[]
 377
 378 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.adoc[]
 379
 380 Circulation
 381 ===========
 382
 383 Introduction
 384 ------------
 385
 386 Use this section for understanding the circulation procedures in the Evergreen
 387 system.
 388
 389 include::circulation/circulating_items.adoc[]
 390
 391 include::circulation/holds.adoc[]
 392
 393 include::circulation/booking.adoc[]
 394
 395 include::circulation/circulation_patron_records.adoc[]
 396
 397 include::circulation/triggered_events.adoc[]
 398
 399 // Push titles down one level.
 400 :leveloffset: 1
 401
 402 include::circulation/offline_mode.adoc[]
 403
 404 include::circulation/self_check.adoc[]
 405
 406 include::circulation/rfid_product_integration.adoc[]
 407
 408 // Return to normal title levels.
 409 :leveloffset: 0
 410
 411 Reports
 412 =======
 413
 414 Introduction
 415 ------------
 416
 417 Learn how to create and use reports in Evergreen.
 418
 419 include::reports/reporter_daemon.adoc[]
 420
 421 include::reports/reporter_folder.adoc[]
 422
 423 include::reports/reporter_create_templates.adoc[]
 424
 425 include::reports/reporter_generating_reports.adoc[]
 426
 427 include::reports/reporter_view_output.adoc[]
 428
 429 include::reports/reporter_cloning_shared_templates.adoc[]
 430
 431 include::reports/reporter_add_data_source.adoc[]
 432
 433 include::reports/reporter_running_recurring_reports.adoc[]
 434
 435 include::reports/reporter_template_terminology.adoc[]
 436
 437 include::reports/reporter_template_enhancements.adoc[]
 438
 439 include::reports/reporter_export_usingpgAdmin.adoc[]
 440
 441 Web Client Preview
 442 ==================
 443
 444 Introduction
 445 ------------
 446
 447 The Evergreen Web Staff Client is in the early stages of development and is
 448 being provided as a "preview" version beginning in Evergreen version 2.7.  If
 449 you are an early adopter, thank you!  Please keep in mind:
 450
 451   . *We want your feedback!* Please report any errors, bugs, strange behavior,
 452 etc. using https://bugs.launchpad.net/evergreen/[Launchpad]. And please send
 453 requested features or design improvements to the
 454 mailto:open-ils-dev@list.georgialibraries.org[Evergreen Developers email list].
 455
 456   . *It is changing rapidly.* Features are being added in "sprints" grouped by
 457 workflow. Read the
 458 http://evergreen-ils.org/dokuwiki/doku.php?id=dev:browser_staff:dev_sprints[development
 459 wiki page] and watch the
 460 http://libmail.georgialibraries.org/mailman/listinfo/open-ils-general[general
 461 email list] for updates. (However, these changes will only appear on your client
 462 when your version of Evergreen is upgraded. Ask your server administrator for
 463 details.)
 464
 465   . *The design may change significantly.* Initially, it will follow the design
 466 of the current XUL-based staff client. But the browser framework provides more
 467 flexibility for design choices. Also, Evergreen hired an
 468 http://lima-julia.tumblr.com/EG-style-guide[intern] from December 2014 through
 469 March 2015 to create a
 470 http://evergreen-ils.org/documentation/previews/proposed_style_guide.html[User
 471 Interface Style Guide]. Watch http://evergreen-ils.org/communicate/irc/[IRC] and the
 472 http://libmail.georgialibraries.org/mailman/listinfo/open-ils-general[general
 473 email list] to follow the progress.
 474
 475 The following rationale was published in the Release Notes for Evergreen 2.7:
 476 ====
 477 The 2.7 release will contain a preview of web client circulation features.
 478 Circulation is the first step in moving all staff functions from the existing
 479 XULRunner-based client to a web application that will be based on AngularJS.
 480
 481 Evergreen is moving away from the existing client because XULRunner no longer
 482 supports features critical to the Evergreen software, including remote XUL,
 483 multi-part streaming, and XML JavaScript. The new web client is expected to show
 484 some speed improvements, to provide comprehensive support for
 485 internationalization/localization, to provide good support for assistive
 486 technologies, to be easier to customize locally, and to be more mobile friendly.
 487
 488 The intent of the preview is to make it easier for end users at Evergreen sites
 489 to try the new client, become familiar with its features, and to discover/report
 490 bugs that are found. Instructions to implement the web client can be found in
 491 the code in Open-ILS/web/js/ui/default/staff/README.install. These will be
 492 revised and moved to the full README for 2.7.1.
 493 ====
 494
 495 Evergreen 2.9 includes the following improvements to the web client preview:
 496 ====
 497 The web staff client now includes additional functionality to support
 498 cataloging and item maintenance, including:
 499
 500 - a new MARC editor
 501 - the service backing the authority headings chooser now has the ability
 502   to filter the browse by subject thesaurus
 503 - Z39.50 search and record import
 504 - improvements to copy and record bucket functionality
 505 - embedding the link checker interface
 506 - embedding the MARC batch import/export interface
 507 - the web staff volume/copy editor
 508
 509 Nearly all of the cataloging functionality available in the XUL staff client is
 510 now present in the web staff client with the exception of printing spine
 511 labels. Nonetheless, the web staff client remains a preview and is not
 512 recommended for production use.
 513 ====
 514
 515
 516 Using the Web Client
 517 --------------------
 518
 519 Introduction
 520 ~~~~~~~~~~~~
 521 This part of the documentation deals with general client usage including
 522 logging in, navigation and shortcuts.
 523
 524 // Push titles down one level.
 525 :leveloffset: 1
 526
 527 include::admin/web_client-login.adoc[]
 528
 529 include::admin/web_client-browser-tab-shortcuts.adoc[]
 530
 531 // Return to normal title levels.
 532 :leveloffset: 0
 533
 534 Circulation
 535 -----------
 536 Use this section for understanding the circulation procedures in the Evergreen system.
 537
 538 // Push titles down one level.
 539 :leveloffset: 1
 540
 541 include::circulation/circulating_items_web_client.adoc[]
 542
 543 include::circulation/circulation_patron_records_web_client.adoc[]
 544
 545 // Return to normal title levels.
 546 :leveloffset: 0
 547
 548 Cataloging
 549 ----------
 550
 551 // Push titles down one level.
 552 :leveloffset: 1
 553
 554 include::cataloging/cataloging_web_client.adoc[]
 555
 556 include::cataloging/copy-buckets_web_client.adoc[]
 557
 558 // Return to normal title levels.
 559 :leveloffset: 0
 560
 561
 562 Using the Public Access Catalog
 563 ===============================
 564
 565 Introduction
 566 ------------
 567
 568 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.
 569
 570 include::opac/using_the_public_access_catalog.adoc[]
 571
 572 include::opac/my_lists.adoc[]
 573
 574 include::opac/kids_opac.adoc[]
 575
 576 include::opac/catalog_browse.adoc[]
 577
 578 include::opac/advanced_features.adoc[]
 579
 580 include::opac/tpac_meta_record_holds.adoc[]
 581
 582 include::opac/linked_libraries.adoc[]
 583
 584 include::opac/opensearch.adoc[]
 585
 586 // Push titles down one level.
 587 :leveloffset: 1
 588
 589 include::opac/search_form.adoc[]
 590
 591 // Return to normal title levels.
 592 :leveloffset: 0
 593
 594
 595 Developer Resources
 596 ===================
 597
 598 Introduction
 599 ------------
 600
 601 Developers can use this part to learn more about the programming languages,
 602 communication protocols and standards used in Evergreen.
 603
 604 include::development/support_scripts.adoc[]
 605
 606 // Push titles down one level.
 607 :leveloffset: 1
 608
 609 include::development/pgtap.adoc[]
 610 include::development/intro_opensrf.adoc[]
 611 include::development/updating_translations_launchpad.adoc[]
 612
 613 // Return to normal title levels.
 614 :leveloffset: 0
 615
 616
 617 Getting Data from Evergreen
 618 ===========================
 619
 620 Introduction
 621 ------------
 622
 623 You may be interested in re-using data from your Evergreen installation in
 624 another application.  This part describes several methods to get the data
 625 you need.
 626
 627 // Push titles down one level.
 628 :leveloffset: 1
 629
 630 include::development/data_supercat.adoc[]
 631
 632 include::development/data_unapi.adoc[]
 633
 634 // Return to normal title levels.
 635 :leveloffset: 0
 636
 637 include::attributions.adoc[]
 638
 639 include::licensing.adoc[]
 640
 641 [appendix]
 642 Admonitions
 643 ===========
 644
 645 * Note
 646
 647 image::media/note.png[]
 648
 649 * warning
 650
 651 image::media/warning.png[]
 652
 653 * caution
 654
 655 image::media/caution.png[]
 656
 657 * tip
 658
 659 image::media/tip.png[]
 660
 661 [index]
 662 Index
 663 =====
 664