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_2.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_initial_setup/different_styles_for_searchbar.adoc[]
119 include::admin/search_interface.adoc[]
121 include::admin_initial_setup/borrowing_items.adoc[]
123 // Return to normal title levels.
126 include::admin_initial_setup/hard_due_dates.adoc[]
130 include::admin/template_toolkit.adoc[]
132 // Push titles down one level.
135 include::opac/new_skin_customizations.adoc[]
137 // Return to normal title levels.
140 include::admin/auto_suggest_search.adoc[]
142 include::admin/authentication_proxy.adoc[]
144 // Push titles down one level.
147 include::TechRef/KidsOPAC.adoc[]
149 // Return to normal title levels.
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[]
166 include::admin/sip_privacy.adoc[]
170 include::admin/apache_rewrite_tricks.adoc[]
172 include::admin/apache_access_handler.adoc[]
174 include::admin/ebook_api_service.adoc[]
176 include::admin/hold_targeter_service.adoc[]
178 // Push titles down one level.
181 include::admin/backups.adoc[]
183 // Return to normal title levels.
188 Using the Browser Staff Client
189 ==============================
195 This part of the documentation deals with general Browser Client usage including
196 logging in, navigation and shortcuts.
198 For information about the XUL client, consult the http://docs.evergreen-ils.org/2.11/[Evergreen 2.11 documentation].
200 include::admin/web_client-login.adoc[]
202 include::admin/web-client-browser-best-practices.adoc[]
204 include::admin/staff_client-column_picker.adoc[]
206 include::admin/staff_client-recent_searches.adoc[]
208 include::admin/workstation_admin.adoc[]
210 // Push titles down one level.
213 include::admin/receipt_template_editor.adoc[]
215 // Return to normal title levels.
218 System Administration From the Staff Client
219 ===========================================
224 This part deals with the options in the Server Administration menu found in the
227 // Follow structure from staff client system admin menu.
229 include::admin/acquisitions_admin.adoc[]
231 include::admin/age_hold_protection.adoc[]
233 include::admin/authorities.adoc[]
235 include::admin/Best_Hold_Selection_Sort_Order.adoc[]
237 include::admin/booking-admin.adoc[]
239 include::admin/cn_prefixes_and_suffixes.adoc[]
241 include::admin/desk_payments.adoc[]
243 include::admin/circulation_limit_groups.adoc[]
245 include::admin/copy_statuses.adoc[]
247 // Push titles down one level.
250 include::admin/floating_groups.adoc[]
252 // Return to normal title levels.
255 include::admin/MARC_Import_Remove_Fields.adoc[]
257 include::admin/copy_tags_admin.adoc[]
259 include::admin/MARC_RAD_MVF_CRA.adoc[]
261 include::admin/Org_Unit_Proximity_Adjustments.adoc[]
265 include::admin/physical_char_wizard_db.adoc[]
269 include::admin/permissions.adoc[]
271 include::admin/SMS_messaging.adoc[]
273 include::admin/user_activity_type.adoc[]
275 include::admin/restrict_Z39.50_sources_by_perm_group.adoc[]
284 This part covers the options in the Local Administration menu found in the staff
287 // Follow structure from staff client local admin menu.
289 include::admin/librarysettings.adoc[]
291 // Address Alert Feature
292 include::admin/lsa-address_alert.adoc[]
294 // Barcode Completion Feature
295 include::admin/lsa-barcode_completion.adoc[]
297 // Push titles down one level.
300 include::admin/hold_driven_recalls.adoc[]
302 // Return to normal title levels.
305 include::admin/emergency_closing_handler.adoc[]
307 include::admin/actiontriggers.adoc[]
309 include::admin/actiontriggers_process.adoc[]
311 include::admin/staff_client-recent_searches.adoc[]
313 include::admin/lsa-standing_penalties.adoc[]
315 include::admin/lsa-statcat.adoc[]
317 include::admin/popularity_badges_web_client.adoc[]
319 include::admin/lsa-work_log.adoc[]
324 include::acquisitions/introduction.adoc[]
326 include::acquisitions/selection_lists_po.adoc[]
328 include::acquisitions/invoices.adoc[]
330 include::acquisitions/receive_items_from_invoice.adoc[]
332 include::acquisitions/vandelay_acquisitions_integration.adoc[]
334 include::acquisitions/purchase_requests_patron_view.adoc[]
336 include::acquisitions/purchase_requests_management.adoc[]
338 include::acquisitions/blanket.adoc[]
347 This part describes cataloging in Evergreen.
349 include::cataloging/marc_tag_table.adoc[]
351 include::cataloging/copy-buckets_web_client.adoc[]
353 include::cataloging/copy_tags_cataloging.adoc[]
355 include::cataloging/MARC_Editor.adoc[]
359 include::cataloging/record_buckets.adoc[]
361 // Return titles to correct level.
364 include::cataloging/physical_char_wizard.adoc[]
366 include::admin/staff_client-return_to_results_from_marc.adoc[]
368 include::cataloging/batch_importing_MARC.adoc[]
370 include::cataloging/overlay_record_3950_import.adoc[]
372 include::cataloging/z39.50_search_enhancements.adoc[]
375 include::cataloging/monograph_parts.adoc[]
378 include::cataloging/conjoined_items.adoc[]
380 include::cataloging/cataloging_electronic_resources.adoc[]
382 include::cataloging/item_status.adoc[]
384 include::cataloging/volcopy_editor.adoc[]
388 include::cataloging/tpac_copy_edit_links.adoc[]
392 include::cataloging/MARC_batch_edit.adoc[]
394 include::cataloging/authorities.adoc[]
396 include::cataloging/link_checker.adoc[]
398 include::admin/schema_bibliographic.adoc[]
400 include::admin/marc_templates.adoc[]
406 include::serials/A-intro.adoc[]
408 include::serials/B-serials_admin.adoc[]
410 include::serials/C-serials_workflow.adoc[]
412 include::serials/D-Receiving.adoc[]
414 include::serials/E-routing_lists.adoc[]
416 include::serials/F-Special_issue.adoc[]
418 include::serials/G-binding.adoc[]
420 include::serials/H-holdings_statements.adoc[]
422 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.adoc[]
430 Use this section for understanding the circulation procedures in the Evergreen
433 include::circulation/circulating_items_web_client.adoc[]
438 include::circulation/basic_holds.adoc[]
440 include::circulation/advanced_holds.adoc[]
442 include::circulation/booking.adoc[]
444 include::circulation/circulation_patron_records_web_client.adoc[]
446 include::admin/patron_self_registration.adoc[]
448 include::circulation/triggered_events.adoc[]
450 // Push titles down one level.
453 include::circulation/offline_circ_webclient.adoc[]
455 include::circulation/self_check.adoc[]
457 // Return to normal title levels.
466 Learn how to create and use reports in Evergreen.
468 include::reports/reporter_daemon.adoc[]
470 include::reports/reporter_folder.adoc[]
472 include::reports/reporter_create_templates.adoc[]
474 include::reports/reporter_generating_reports.adoc[]
476 include::reports/reporter_view_output.adoc[]
478 include::reports/reporter_cloning_shared_templates.adoc[]
480 include::reports/reporter_add_data_source.adoc[]
482 include::reports/reporter_running_recurring_reports.adoc[]
484 include::reports/reporter_template_terminology.adoc[]
486 include::reports/reporter_template_enhancements.adoc[]
488 include::reports/reporter_export_usingpgAdmin.adoc[]
490 Using the Public Access Catalog
491 ===============================
496 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.
498 include::opac/using_the_public_access_catalog.adoc[]
500 include::opac/my_lists.adoc[]
502 include::opac/kids_opac.adoc[]
504 include::opac/catalog_browse.adoc[]
506 include::opac/advanced_features.adoc[]
508 include::opac/tpac_meta_record_holds.adoc[]
510 include::opac/linked_libraries.adoc[]
512 include::opac/opensearch.adoc[]
514 // Push titles down one level.
517 include::opac/search_form.adoc[]
519 // Return to normal title levels.
529 Developers can use this part to learn more about the programming languages,
530 communication protocols and standards used in Evergreen.
532 include::development/support_scripts.adoc[]
534 // Push titles down one level.
537 include::development/pgtap.adoc[]
538 include::development/intro_opensrf.adoc[]
539 include::development/updating_translations_launchpad.adoc[]
541 // Return to normal title levels.
545 Getting Data from Evergreen
546 ===========================
551 You may be interested in re-using data from your Evergreen installation in
552 another application. This part describes several methods to get the data
555 // Push titles down one level.
558 include::development/data_supercat.adoc[]
560 include::development/data_unapi.adoc[]
562 include::development/data_opensearch.adoc[]
564 // Return to normal title levels.
567 include::shared/attributions.adoc[]
569 include::licensing.adoc[]
577 image::media/note.png[]
581 image::media/warning.png[]
585 image::media/caution.png[]
589 image::media/tip.png[]