1 Evergreen Documentation
2 =======================
3 Documentation Interest Group
11 About This Documentation
12 ------------------------
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.
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.
32 Copies of this guide can be accessed in PDF and HTML formats from http://docs.evergreen-ils.org/.
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.
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.
48 The community’s development requirements state that Evergreen must be:
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.
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.
61 include::RELEASE_NOTES_2_10.adoc[]
71 This part will guide you through the installation steps installation or
72 upgrading your Evergreen system. It is intended for system administrators.
75 include::installation/system_requirements.txt[]
77 // Push titles down one level.
80 include::installation/server_installation.txt[]
82 // Return to normal title levels.
85 include::installation/staff_client_installation.txt[]
87 include::installation/server_upgrade.txt[]
89 include::installation/edi_setup.txt[]
92 System Configuration and Customization
93 ======================================
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.
102 // Push titles down one level.
105 include::admin_initial_setup/describing_your_organization.txt[]
107 include::admin_initial_setup/describing_your_people.txt[]
109 include::admin_initial_setup/migrating_patron_data.txt[]
111 include::admin_initial_setup/migrating_your_data.txt[]
113 include::admin_initial_setup/importing_via_staff_client.txt[]
115 include::admin_initial_setup/ordering_materials.txt[]
117 include::admin_initial_setup/designing_your_catalog.txt[]
119 include::admin_initial_setup/borrowing_items.txt[]
121 // Return to normal title levels.
124 include::admin_initial_setup/hard_due_dates.txt[]
128 include::admin/template_toolkit.txt[]
130 // Push titles down one level.
133 include::opac/new_skin_customizations.txt[]
135 // Return to normal title levels.
138 include::admin/auto_suggest_search.txt[]
140 include::admin/authentication_proxy.txt[]
142 // Push titles down one level.
145 include::TechRef/KidsOPAC.txt[]
147 // Return to normal title levels.
150 include::admin/customize_staff_client.txt[]
152 include::admin/patron_address_by_zip_code.txt[]
154 // Push titles down one level.
157 include::admin/phonelist.txt[]
159 // Return to normal title levels.
162 include::admin/sip_server.txt[]
164 include::admin/apache_rewrite_tricks.txt[]
166 include::admin/apache_access_handler.txt[]
169 Using the Staff Client
170 ======================
176 This part of the documentation deals with general Staff Client usage including
177 logging in, navigation and shortcuts.
180 include::admin/staff_client-login.txt[]
182 include::admin/staff_client-button_bar_toolbar.txt[]
184 include::admin/staff_client-sticky_settings.txt[]
186 include::admin/staff_client-tab_buttons.txt[]
188 include::admin/staff_client-double_clicking.txt[]
190 include::admin/staff_client-patron_border.txt[]
192 include::admin/staff_client-sorting_columns.txt[]
194 include::admin/staff_client-column_picker.txt[]
196 include::admin/staff_client-recent_searches.txt[]
198 include::admin/staff_client-return_to_results_from_marc.txt[]
200 include::admin/workstation_admin.txt[]
202 // Push titles down one level.
205 include::admin/workstation_admin_receipt_template_editor.txt[]
207 // Return to normal title levels.
210 include::admin/workstation_admin_customizable_toolbar.txt[]
212 System Administration From the Staff Client
213 ===========================================
218 This part deals with the options in the Server Administration menu found in the
221 // Follow structure from staff client system admin menu.
223 include::admin/acquisitions_admin.txt[]
225 include::admin/age_hold_protection.txt[]
227 include::admin/authorities.txt[]
229 include::admin/Best_Hold_Selection_Sort_Order.txt[]
231 include::admin/booking-admin.txt[]
233 include::admin/cn_prefixes_and_suffixes.txt[]
235 include::admin/circulation_limit_groups.txt[]
237 include::admin/copy_statuses.txt[]
239 // Push titles down one level.
242 include::admin/floating_groups.txt[]
244 // Return to normal title levels.
247 include::admin/MARC_Import_Remove_Fields.txt[]
249 include::admin/MARC_RAD_MVF_CRA.txt[]
251 include::admin/Org_Unit_Proximity_Adjustments.txt[]
253 include::admin/permissions.txt[]
255 include::admin/SMS_messaging.txt[]
257 include::admin/user_activity_type.txt[]
259 include::admin/restrict_Z39.50_sources_by_perm_group.txt[]
268 This part covers the options in the Local Administration menu found in the staff
271 // Follow structure from staff client local admin menu.
273 include::admin/librarysettings.adoc[]
275 // Address Alert Feature
276 include::admin/lsa-address_alert.txt[]
278 // Barcode Completion Feature
279 include::admin/lsa-barcode_completion.txt[]
281 // Push titles down one level.
284 include::admin/hold_driven_recalls.txt[]
286 // Return to normal title levels.
289 include::admin/actiontriggers.txt[]
291 include::admin/recent_staff_searches.txt[]
293 include::admin/lsa-standing_penalties.txt[]
295 include::admin/lsa-statcat.txt[]
297 include::admin/lsa-work_log.txt[]
302 include::acquisitions/introduction.txt[]
304 include::acquisitions/selection_lists_po.txt[]
306 include::acquisitions/invoices.txt[]
308 include::acquisitions/receive_items_from_invoice.txt[]
310 include::acquisitions/vandelay_acquisitions_integration.txt[]
312 include::acquisitions/purchase_requests_patron_view.txt[]
314 include::acquisitions/purchase_requests_management.txt[]
323 Cataloguers should use this part for understanding the cataloguing procedures
326 include::cataloging/MARC_Editor.txt[]
328 // Push titles down one level.
331 include::cataloging/physical_char_wizard.txt[]
333 // Return titles to correct level.
336 include::cataloging/batch_importing_MARC.txt[]
338 include::cataloging/overlay_record_3950_import.txt[]
340 include::cataloging/z39.50_search_enhancements.txt[]
342 include::cataloging/monograph_parts.txt[]
344 include::cataloging/conjoined_items.txt[]
346 include::cataloging/cataloging_electronic_resources.txt[]
348 include::cataloging/tpac_copy_edit_links.txt[]
350 include::cataloging/MARC_batch_edit.txt[]
352 include::cataloging/authorities.txt[]
354 include::cataloging/link_checker.txt[]
360 include::serials/A-intro.txt[]
362 include::serials/B-copy_template.txt[]
364 include::serials/C-subscription-SCV.txt[]
366 include::serials/D-subscription-ASCV.txt[]
368 include::serials/E-edit_subscriptions.txt[]
370 include::serials/F-Receiving.txt[]
372 include::serials/G-Special_issue.txt[]
374 include::serials/H-holdings_statements.txt[]
376 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.txt[]
384 Use this section for understanding the circulation procedures in the Evergreen
387 include::circulation/circulating_items.txt[]
389 include::circulation/holds.txt[]
391 include::circulation/booking.txt[]
393 include::circulation/circulation_patron_records.txt[]
395 include::circulation/triggered_events.txt[]
397 // Push titles down one level.
400 include::circulation/offline_mode.txt[]
402 include::circulation/self_check.txt[]
404 include::circulation/rfid_product_integration.txt[]
406 // Return to normal title levels.
415 Learn how to create and use reports in Evergreen.
417 include::reports/reporter_daemon.txt[]
419 include::reports/reporter_folder.txt[]
421 include::reports/reporter_create_templates.txt[]
423 include::reports/reporter_generating_reports.txt[]
425 include::reports/reporter_view_output.txt[]
427 include::reports/reporter_cloning_shared_templates.txt[]
429 include::reports/reporter_add_data_source.txt[]
431 include::reports/reporter_running_recurring_reports.txt[]
433 include::reports/reporter_template_terminology.txt[]
435 include::reports/reporter_template_enhancements.txt[]
437 include::reports/reporter_export_usingpgAdmin.txt[]
445 The Evergreen Web Staff Client is in the early stages of development and is
446 being provided as a "preview" version beginning in Evergreen version 2.7. If
447 you are an early adopter, thank you! Please keep in mind:
449 . *We want your feedback!* Please report any errors, bugs, strange behavior,
450 etc. using https://bugs.launchpad.net/evergreen/[Launchpad]. And please send
451 requested features or design improvements to the
452 mailto:open-ils-dev@list.georgialibraries.org[Evergreen Developers email list].
454 . *It is changing rapidly.* Features are being added in "sprints" grouped by
456 http://evergreen-ils.org/dokuwiki/doku.php?id=dev:browser_staff:dev_sprints[development
457 wiki page] and watch the
458 http://libmail.georgialibraries.org/mailman/listinfo/open-ils-general[general
459 email list] for updates. (However, these changes will only appear on your client
460 when your version of Evergreen is upgraded. Ask your server administrator for
463 . *The design may change significantly.* Initially, it will follow the design
464 of the current XUL-based staff client. But the browser framework provides more
465 flexibility for design choices. Also, Evergreen hired an
466 http://lima-julia.tumblr.com/EG-style-guide[intern] from December 2014 through
467 March 2015 to create a
468 http://evergreen-ils.org/documentation/previews/proposed_style_guide.html[User
469 Interface Style Guide]. Watch http://evergreen-ils.org/communicate/irc/[IRC] and the
470 http://libmail.georgialibraries.org/mailman/listinfo/open-ils-general[general
471 email list] to follow the progress.
473 The following rationale was published in the Release Notes for Evergreen 2.7:
475 The 2.7 release will contain a preview of web client circulation features.
476 Circulation is the first step in moving all staff functions from the existing
477 XULRunner-based client to a web application that will be based on AngularJS.
479 Evergreen is moving away from the existing client because XULRunner no longer
480 supports features critical to the Evergreen software, including remote XUL,
481 multi-part streaming, and XML JavaScript. The new web client is expected to show
482 some speed improvements, to provide comprehensive support for
483 internationalization/localization, to provide good support for assistive
484 technologies, to be easier to customize locally, and to be more mobile friendly.
486 The intent of the preview is to make it easier for end users at Evergreen sites
487 to try the new client, become familiar with its features, and to discover/report
488 bugs that are found. Instructions to implement the web client can be found in
489 the code in Open-ILS/web/js/ui/default/staff/README.install. These will be
490 revised and moved to the full README for 2.7.1.
493 Evergreen 2.9 includes the following improvements to the web client preview:
495 The web staff client now includes additional functionality to support
496 cataloging and item maintenance, including:
499 - the service backing the authority headings chooser now has the ability
500 to filter the browse by subject thesaurus
501 - Z39.50 search and record import
502 - improvements to copy and record bucket functionality
503 - embedding the link checker interface
504 - embedding the MARC batch import/export interface
505 - the web staff volume/copy editor
507 Nearly all of the cataloging functionality available in the XUL staff client is
508 now present in the web staff client with the exception of printing spine
509 labels. Nonetheless, the web staff client remains a preview and is not
510 recommended for production use.
519 This part of the documentation deals with general client usage including
520 logging in, navigation and shortcuts.
522 // Push titles down one level.
525 include::admin/web_client-login.txt[]
527 include::admin/web_client-browser-tab-shortcuts.txt[]
529 // Return to normal title levels.
534 Use this section for understanding the circulation procedures in the Evergreen system.
536 // Push titles down one level.
539 include::circulation/circulation_patron_records_web_client.txt[]
541 // Return to normal title levels.
547 // Push titles down one level.
550 include::cataloging/cataloging_web_client.txt[]
552 include::cataloging/copy-buckets_web_client.txt[]
554 // Return to normal title levels.
558 Using the Public Access Catalog
559 ===============================
564 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.
566 include::opac/using_the_public_access_catalog.txt[]
568 include::opac/my_lists.txt[]
570 include::opac/kids_opac.txt[]
572 include::opac/catalog_browse.txt[]
574 include::opac/advanced_features.txt[]
576 include::opac/tpac_meta_record_holds.txt[]
578 include::opac/linked_libraries.txt[]
580 include::opac/opensearch.txt[]
582 // Push titles down one level.
585 include::opac/search_form.txt[]
587 // Return to normal title levels.
597 Developers can use this part to learn more about the programming languages,
598 communication protocols and standards used in Evergreen.
600 include::development/support_scripts.txt[]
602 // Push titles down one level.
605 include::development/pgtap.txt[]
606 include::development/intro_opensrf.txt[]
607 include::development/updating_translations_launchpad.txt[]
609 // Return to normal title levels.
613 Getting Data from Evergreen
614 ===========================
619 You may be interested in re-using data from your Evergreen installation in
620 another application. This part describes several methods to get the data
623 // Push titles down one level.
626 include::development/data_supercat.txt[]
628 include::development/data_unapi.txt[]
630 // Return to normal title levels.
633 include::attributions.txt[]
635 include::licensing.txt[]
643 image::media/note.png[]
647 image::media/warning.png[]
651 image::media/caution.png[]
655 image::media/tip.png[]