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_11.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.adoc[]
77 // Push titles down one level.
80 include::installation/server_installation.adoc[]
82 // Return to normal title levels.
85 include::installation/staff_client_installation.adoc[]
87 include::installation/server_upgrade.adoc[]
89 include::installation/edi_setup.adoc[]
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.adoc[]
107 include::admin_initial_setup/describing_your_people.adoc[]
109 include::admin_initial_setup/migrating_patron_data.adoc[]
111 include::admin_initial_setup/migrating_your_data.adoc[]
113 include::admin_initial_setup/importing_via_staff_client.adoc[]
115 include::admin_initial_setup/ordering_materials.adoc[]
117 include::admin_initial_setup/designing_your_catalog.adoc[]
119 include::admin_initial_setup/borrowing_items.adoc[]
121 // Return to normal title levels.
124 include::admin_initial_setup/hard_due_dates.adoc[]
128 include::admin/template_toolkit.adoc[]
130 // Push titles down one level.
133 include::opac/new_skin_customizations.adoc[]
135 // Return to normal title levels.
138 include::admin/auto_suggest_search.adoc[]
140 include::admin/authentication_proxy.adoc[]
142 // Push titles down one level.
145 include::TechRef/KidsOPAC.adoc[]
147 // Return to normal title levels.
150 include::admin/customize_staff_client.adoc[]
152 include::admin/patron_address_by_zip_code.adoc[]
154 // Push titles down one level.
157 include::admin/phonelist.adoc[]
159 // Return to normal title levels.
162 include::admin/sip_server.adoc[]
164 include::admin/apache_rewrite_tricks.adoc[]
166 include::admin/apache_access_handler.adoc[]
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.adoc[]
182 include::admin/staff_client-button_bar_toolbar.adoc[]
184 include::admin/staff_client-sticky_settings.adoc[]
186 include::admin/staff_client-tab_buttons.adoc[]
188 include::admin/staff_client-double_clicking.adoc[]
190 include::admin/staff_client-patron_border.adoc[]
192 include::admin/staff_client-sorting_columns.adoc[]
194 include::admin/staff_client-column_picker.adoc[]
196 include::admin/staff_client-recent_searches.adoc[]
198 include::admin/staff_client-return_to_results_from_marc.adoc[]
200 include::admin/workstation_admin.adoc[]
202 // Push titles down one level.
205 include::admin/workstation_admin_receipt_template_editor.adoc[]
207 // Return to normal title levels.
210 include::admin/workstation_admin_customizable_toolbar.adoc[]
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.adoc[]
225 include::admin/age_hold_protection.adoc[]
227 include::admin/authorities.adoc[]
229 include::admin/Best_Hold_Selection_Sort_Order.adoc[]
231 include::admin/booking-admin.adoc[]
233 include::admin/cn_prefixes_and_suffixes.adoc[]
235 include::admin/circulation_limit_groups.adoc[]
237 include::admin/copy_statuses.adoc[]
239 // Push titles down one level.
242 include::admin/floating_groups.adoc[]
244 // Return to normal title levels.
247 include::admin/MARC_Import_Remove_Fields.adoc[]
249 include::admin/MARC_RAD_MVF_CRA.adoc[]
251 include::admin/Org_Unit_Proximity_Adjustments.adoc[]
253 include::admin/permissions.adoc[]
255 include::admin/SMS_messaging.adoc[]
257 include::admin/user_activity_type.adoc[]
259 include::admin/restrict_Z39.50_sources_by_perm_group.adoc[]
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.adoc[]
278 // Barcode Completion Feature
279 include::admin/lsa-barcode_completion.adoc[]
281 // Push titles down one level.
284 include::admin/hold_driven_recalls.adoc[]
286 // Return to normal title levels.
289 include::admin/actiontriggers.adoc[]
291 include::admin/recent_staff_searches.adoc[]
293 include::admin/lsa-standing_penalties.adoc[]
295 include::admin/lsa-statcat.adoc[]
297 include::admin/lsa-work_log.adoc[]
302 include::acquisitions/introduction.adoc[]
304 include::acquisitions/selection_lists_po.adoc[]
306 include::acquisitions/invoices.adoc[]
308 include::acquisitions/receive_items_from_invoice.adoc[]
310 include::acquisitions/vandelay_acquisitions_integration.adoc[]
312 include::acquisitions/purchase_requests_patron_view.adoc[]
314 include::acquisitions/purchase_requests_management.adoc[]
316 include::acquisitions/blanket.adoc[]
325 Cataloguers should use this part for understanding the cataloguing procedures
328 include::cataloging/MARC_Editor.adoc[]
330 // Push titles down one level.
333 include::cataloging/physical_char_wizard.adoc[]
335 // Return titles to correct level.
338 include::cataloging/batch_importing_MARC.adoc[]
340 include::cataloging/overlay_record_3950_import.adoc[]
342 include::cataloging/z39.50_search_enhancements.adoc[]
344 include::cataloging/monograph_parts.adoc[]
346 include::cataloging/conjoined_items.adoc[]
348 include::cataloging/cataloging_electronic_resources.adoc[]
350 include::cataloging/tpac_copy_edit_links.adoc[]
352 include::cataloging/MARC_batch_edit.adoc[]
354 include::cataloging/authorities.adoc[]
356 include::cataloging/link_checker.adoc[]
362 include::serials/A-intro.adoc[]
364 include::serials/B-copy_template.adoc[]
366 include::serials/C-subscription-SCV.adoc[]
368 include::serials/D-subscription-ASCV.adoc[]
370 include::serials/E-edit_subscriptions.adoc[]
372 include::serials/F-Receiving.adoc[]
374 include::serials/G-Special_issue.adoc[]
376 include::serials/H-holdings_statements.adoc[]
378 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.adoc[]
386 Use this section for understanding the circulation procedures in the Evergreen
389 include::circulation/circulating_items.adoc[]
391 include::circulation/holds.adoc[]
393 include::circulation/booking.adoc[]
395 include::circulation/circulation_patron_records.adoc[]
397 include::circulation/triggered_events.adoc[]
399 // Push titles down one level.
402 include::circulation/offline_mode.adoc[]
404 include::circulation/self_check.adoc[]
406 include::circulation/rfid_product_integration.adoc[]
408 // Return to normal title levels.
417 Learn how to create and use reports in Evergreen.
419 include::reports/reporter_daemon.adoc[]
421 include::reports/reporter_folder.adoc[]
423 include::reports/reporter_create_templates.adoc[]
425 include::reports/reporter_generating_reports.adoc[]
427 include::reports/reporter_view_output.adoc[]
429 include::reports/reporter_cloning_shared_templates.adoc[]
431 include::reports/reporter_add_data_source.adoc[]
433 include::reports/reporter_running_recurring_reports.adoc[]
435 include::reports/reporter_template_terminology.adoc[]
437 include::reports/reporter_template_enhancements.adoc[]
439 include::reports/reporter_export_usingpgAdmin.adoc[]
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:
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].
456 . *It is changing rapidly.* Features are being added in "sprints" grouped by
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
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.
475 The following rationale was published in the Release Notes for Evergreen 2.7:
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.
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.
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.
495 Evergreen 2.9 includes the following improvements to the web client preview:
497 The web staff client now includes additional functionality to support
498 cataloging and item maintenance, including:
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
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.
521 This part of the documentation deals with general client usage including
522 logging in, navigation and shortcuts.
524 // Push titles down one level.
527 include::admin/web_client-login.adoc[]
529 include::admin/web_client-browser-tab-shortcuts.adoc[]
531 // Return to normal title levels.
536 Use this section for understanding the circulation procedures in the Evergreen system.
538 // Push titles down one level.
541 include::circulation/circulating_items_web_client.adoc[]
543 include::circulation/circulation_patron_records_web_client.adoc[]
545 // Return to normal title levels.
551 // Push titles down one level.
554 include::cataloging/cataloging_web_client.adoc[]
556 include::cataloging/copy-buckets_web_client.adoc[]
558 // Return to normal title levels.
562 Using the Public Access Catalog
563 ===============================
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.
570 include::opac/using_the_public_access_catalog.adoc[]
572 include::opac/my_lists.adoc[]
574 include::opac/kids_opac.adoc[]
576 include::opac/catalog_browse.adoc[]
578 include::opac/advanced_features.adoc[]
580 include::opac/tpac_meta_record_holds.adoc[]
582 include::opac/linked_libraries.adoc[]
584 include::opac/opensearch.adoc[]
586 // Push titles down one level.
589 include::opac/search_form.adoc[]
591 // Return to normal title levels.
601 Developers can use this part to learn more about the programming languages,
602 communication protocols and standards used in Evergreen.
604 include::development/support_scripts.adoc[]
606 // Push titles down one level.
609 include::development/pgtap.adoc[]
610 include::development/intro_opensrf.adoc[]
611 include::development/updating_translations_launchpad.adoc[]
613 // Return to normal title levels.
617 Getting Data from Evergreen
618 ===========================
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
627 // Push titles down one level.
630 include::development/data_supercat.adoc[]
632 include::development/data_unapi.adoc[]
634 // Return to normal title levels.
637 include::attributions.adoc[]
639 include::licensing.adoc[]
647 image::media/note.png[]
651 image::media/warning.png[]
655 image::media/caution.png[]
659 image::media/tip.png[]