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_3_0.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/server_upgrade.adoc[]
87 include::installation/edi_setup.adoc[]
90 System Configuration and Customization
91 ======================================
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.
100 // Push titles down one level.
103 include::admin_initial_setup/describing_your_organization.adoc[]
105 include::admin_initial_setup/describing_your_people.adoc[]
107 include::admin_initial_setup/migrating_patron_data.adoc[]
109 include::admin_initial_setup/migrating_your_data.adoc[]
111 include::admin_initial_setup/importing_via_staff_client.adoc[]
113 include::admin_initial_setup/ordering_materials.adoc[]
115 include::admin_initial_setup/designing_your_catalog.adoc[]
117 include::admin/search_interface.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/patron_address_by_zip_code.adoc[]
152 // Push titles down one level.
155 include::admin/phonelist.adoc[]
157 // Return to normal title levels.
160 include::admin/sip_server.adoc[]
164 include::admin/sip_privacy.adoc[]
168 include::admin/apache_rewrite_tricks.adoc[]
170 include::admin/apache_access_handler.adoc[]
172 include::admin/ebook_api_service.adoc[]
174 include::admin/hold_targeter_service.adoc[]
176 // Push titles down one level.
179 include::admin/backups.adoc[]
181 // Return to normal title levels.
186 Using the Browser Staff Client
187 ==============================
193 This part of the documentation deals with general Browser Client usage including
194 logging in, navigation and shortcuts.
196 For information about the XUL client, consult the http://docs.evergreen-ils.org/2.11/[Evergreen 2.11 documentation].
198 include::admin/web_client-login.adoc[]
200 include::admin/web-client-browser-best-practices.adoc[]
202 include::admin/staff_client-column_picker.adoc[]
204 include::admin/staff_client-recent_searches.adoc[]
206 include::admin/workstation_admin.adoc[]
208 // Push titles down one level.
211 include::admin/workstation_admin_receipt_template_editor.adoc[]
213 // Return to normal title levels.
216 System Administration From the Staff Client
217 ===========================================
222 This part deals with the options in the Server Administration menu found in the
225 // Follow structure from staff client system admin menu.
227 include::admin/acquisitions_admin.adoc[]
229 include::admin/age_hold_protection.adoc[]
231 include::admin/authorities.adoc[]
233 include::admin/Best_Hold_Selection_Sort_Order.adoc[]
235 include::admin/booking-admin.adoc[]
237 include::admin/cn_prefixes_and_suffixes.adoc[]
239 include::admin/desk_payments.adoc[]
241 include::admin/circulation_limit_groups.adoc[]
243 include::admin/copy_statuses.adoc[]
245 // Push titles down one level.
248 include::admin/floating_groups.adoc[]
250 // Return to normal title levels.
253 include::admin/MARC_Import_Remove_Fields.adoc[]
255 include::admin/copy_tags_admin.adoc[]
257 include::admin/MARC_RAD_MVF_CRA.adoc[]
259 include::admin/Org_Unit_Proximity_Adjustments.adoc[]
261 include::admin/permissions.adoc[]
263 include::admin/SMS_messaging.adoc[]
265 include::admin/user_activity_type.adoc[]
267 include::admin/restrict_Z39.50_sources_by_perm_group.adoc[]
276 This part covers the options in the Local Administration menu found in the staff
279 // Follow structure from staff client local admin menu.
281 include::admin/librarysettings.adoc[]
283 // Address Alert Feature
284 include::admin/lsa-address_alert.adoc[]
286 // Barcode Completion Feature
287 include::admin/lsa-barcode_completion.adoc[]
289 // Push titles down one level.
292 include::admin/hold_driven_recalls.adoc[]
294 // Return to normal title levels.
297 include::admin/actiontriggers.adoc[]
299 include::admin/actiontriggers_process.adoc[]
301 include::admin/staff_client-recent_searches.adoc[]
303 include::admin/lsa-standing_penalties.adoc[]
305 include::admin/lsa-statcat.adoc[]
307 include::admin/popularity_badges_web_client.adoc[]
309 include::admin/lsa-work_log.adoc[]
314 include::acquisitions/introduction.adoc[]
316 include::acquisitions/selection_lists_po.adoc[]
318 include::acquisitions/invoices.adoc[]
320 include::acquisitions/receive_items_from_invoice.adoc[]
322 include::acquisitions/vandelay_acquisitions_integration.adoc[]
324 include::acquisitions/purchase_requests_patron_view.adoc[]
326 include::acquisitions/purchase_requests_management.adoc[]
328 include::acquisitions/blanket.adoc[]
337 This part describes cataloging in Evergreen.
339 include::cataloging/marc_tag_table.adoc[]
341 include::cataloging/copy-buckets_web_client.adoc[]
343 include::cataloging/copy_tags_cataloging.adoc[]
345 include::cataloging/MARC_Editor.adoc[]
349 include::cataloging/record_buckets.adoc[]
351 // Push titles down one level.
354 include::cataloging/physical_char_wizard.adoc[]
356 // Return titles to correct level.
359 include::admin/staff_client-return_to_results_from_marc.adoc[]
361 include::cataloging/batch_importing_MARC.adoc[]
363 include::cataloging/overlay_record_3950_import.adoc[]
365 include::cataloging/z39.50_search_enhancements.adoc[]
368 include::cataloging/monograph_parts.adoc[]
371 include::cataloging/conjoined_items.adoc[]
373 include::cataloging/cataloging_electronic_resources.adoc[]
375 include::cataloging/tpac_copy_edit_links.adoc[]
377 include::cataloging/MARC_batch_edit.adoc[]
379 include::cataloging/authorities.adoc[]
381 include::cataloging/link_checker.adoc[]
387 include::serials/A-intro.adoc[]
389 include::serials/B-serials_admin.adoc[]
391 include::serials/C-serials_workflow.adoc[]
393 include::serials/D-Receiving.adoc[]
395 include::serials/E-routing_lists.adoc[]
397 include::serials/F-Special_issue.adoc[]
399 include::serials/G-binding.adoc[]
401 include::serials/H-holdings_statements.adoc[]
403 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.adoc[]
411 Use this section for understanding the circulation procedures in the Evergreen
414 include::circulation/circulating_items_web_client.adoc[]
419 include::circulation/basic_holds.adoc[]
421 include::circulation/advanced_holds.adoc[]
423 include::circulation/booking.adoc[]
425 include::circulation/circulation_patron_records_web_client.adoc[]
427 include::admin/patron_self_registration.adoc[]
429 include::circulation/triggered_events.adoc[]
431 // Push titles down one level.
434 include::circulation/offline_circ_webclient.adoc[]
436 include::circulation/self_check.adoc[]
438 // Return to normal title levels.
447 Learn how to create and use reports in Evergreen.
449 include::reports/reporter_daemon.adoc[]
451 include::reports/reporter_folder.adoc[]
453 include::reports/reporter_create_templates.adoc[]
455 include::reports/reporter_generating_reports.adoc[]
457 include::reports/reporter_view_output.adoc[]
459 include::reports/reporter_cloning_shared_templates.adoc[]
461 include::reports/reporter_add_data_source.adoc[]
463 include::reports/reporter_running_recurring_reports.adoc[]
465 include::reports/reporter_template_terminology.adoc[]
467 include::reports/reporter_template_enhancements.adoc[]
469 include::reports/reporter_export_usingpgAdmin.adoc[]
471 Using the Public Access Catalog
472 ===============================
477 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.
479 include::opac/using_the_public_access_catalog.adoc[]
481 include::opac/my_lists.adoc[]
483 include::opac/kids_opac.adoc[]
485 include::opac/catalog_browse.adoc[]
487 include::opac/advanced_features.adoc[]
489 include::opac/tpac_meta_record_holds.adoc[]
491 include::opac/linked_libraries.adoc[]
493 include::opac/opensearch.adoc[]
495 // Push titles down one level.
498 include::opac/search_form.adoc[]
500 // Return to normal title levels.
510 Developers can use this part to learn more about the programming languages,
511 communication protocols and standards used in Evergreen.
513 include::development/support_scripts.adoc[]
515 // Push titles down one level.
518 include::development/pgtap.adoc[]
519 include::development/intro_opensrf.adoc[]
520 include::development/updating_translations_launchpad.adoc[]
522 // Return to normal title levels.
526 Getting Data from Evergreen
527 ===========================
532 You may be interested in re-using data from your Evergreen installation in
533 another application. This part describes several methods to get the data
536 // Push titles down one level.
539 include::development/data_supercat.adoc[]
541 include::development/data_unapi.adoc[]
543 include::development/data_opensearch.adoc[]
545 // Return to normal title levels.
548 include::shared/attributions.adoc[]
550 include::licensing.adoc[]
558 image::media/note.png[]
562 image::media/warning.png[]
566 image::media/caution.png[]
570 image::media/tip.png[]