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_12.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 Browser Staff Client
170 ==============================
176 This part of the documentation deals with general Browser Client usage including
177 logging in, navigation and shortcuts.
179 For information about the XUL client, consult the http://docs.evergreen-ils.org/2.11/[Evergreen 2.11 documentation].
181 include::admin/web_client-login.adoc[]
183 include::admin/web_client-browser-tab-shortcuts.adoc[]
185 include::admin/staff_client-column_picker.adoc[]
187 include::admin/staff_client-recent_searches.adoc[]
189 include::admin/staff_client-return_to_results_from_marc.adoc[]
191 include::admin/workstation_admin.adoc[]
193 // Push titles down one level.
196 include::admin/workstation_admin_receipt_template_editor.adoc[]
198 // Return to normal title levels.
201 System Administration From the Staff Client
202 ===========================================
207 This part deals with the options in the Server Administration menu found in the
210 // Follow structure from staff client system admin menu.
212 include::admin/acquisitions_admin.adoc[]
214 include::admin/age_hold_protection.adoc[]
216 include::admin/authorities.adoc[]
218 include::admin/Best_Hold_Selection_Sort_Order.adoc[]
220 include::admin/booking-admin.adoc[]
222 include::admin/cn_prefixes_and_suffixes.adoc[]
224 include::admin/desk_payments.adoc[]
226 include::admin/circulation_limit_groups.adoc[]
228 include::admin/copy_statuses.adoc[]
230 // Push titles down one level.
233 include::admin/floating_groups.adoc[]
235 // Return to normal title levels.
238 include::admin/MARC_Import_Remove_Fields.adoc[]
240 include::admin/MARC_RAD_MVF_CRA.adoc[]
242 include::admin/Org_Unit_Proximity_Adjustments.adoc[]
244 include::admin/permissions.adoc[]
246 include::admin/SMS_messaging.adoc[]
248 include::admin/user_activity_type.adoc[]
250 include::admin/restrict_Z39.50_sources_by_perm_group.adoc[]
259 This part covers the options in the Local Administration menu found in the staff
262 // Follow structure from staff client local admin menu.
264 include::admin/librarysettings.adoc[]
266 // Address Alert Feature
267 include::admin/lsa-address_alert.adoc[]
269 // Barcode Completion Feature
270 include::admin/lsa-barcode_completion.adoc[]
272 // Push titles down one level.
275 include::admin/hold_driven_recalls.adoc[]
277 // Return to normal title levels.
280 include::admin/actiontriggers.adoc[]
282 include::admin/recent_staff_searches.adoc[]
284 include::admin/lsa-standing_penalties.adoc[]
286 include::admin/lsa-statcat.adoc[]
288 include::admin/popularity_badges_web_client.adoc[]
290 include::admin/lsa-work_log.adoc[]
295 include::acquisitions/introduction.adoc[]
297 include::acquisitions/selection_lists_po.adoc[]
299 include::acquisitions/invoices.adoc[]
301 include::acquisitions/receive_items_from_invoice.adoc[]
303 include::acquisitions/vandelay_acquisitions_integration.adoc[]
305 include::acquisitions/purchase_requests_patron_view.adoc[]
307 include::acquisitions/purchase_requests_management.adoc[]
309 include::acquisitions/blanket.adoc[]
315 include::cataloging/cataloging_web_client.adoc[]
317 include::cataloging/copy-buckets_web_client.adoc[]
320 include::cataloging/MARC_Editor.adoc[]
322 // Push titles down one level.
325 include::cataloging/physical_char_wizard.adoc[]
327 // Return titles to correct level.
330 include::cataloging/batch_importing_MARC.adoc[]
332 include::cataloging/overlay_record_3950_import.adoc[]
334 include::cataloging/z39.50_search_enhancements.adoc[]
336 include::cataloging/monograph_parts.adoc[]
338 include::cataloging/conjoined_items.adoc[]
340 include::cataloging/cataloging_electronic_resources.adoc[]
342 include::cataloging/tpac_copy_edit_links.adoc[]
344 include::cataloging/MARC_batch_edit.adoc[]
346 include::cataloging/authorities.adoc[]
348 include::cataloging/link_checker.adoc[]
354 include::serials/A-intro.adoc[]
356 include::serials/B-copy_template.adoc[]
358 include::serials/C-subscription-SCV.adoc[]
360 include::serials/D-subscription-ASCV.adoc[]
362 include::serials/E-edit_subscriptions.adoc[]
364 include::serials/F-Receiving.adoc[]
366 include::serials/G-Special_issue.adoc[]
368 include::serials/H-holdings_statements.adoc[]
370 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.adoc[]
378 Use this section for understanding the circulation procedures in the Evergreen
381 include::circulation/circulating_items_web_client.adoc[]
386 include::circulation/basic_holds.adoc[]
388 include::circulation/advanced_holds.adoc[]
390 include::circulation/booking.adoc[]
392 include::circulation/circulation_patron_records_web_client.adoc[]
394 include::circulation/triggered_events.adoc[]
396 // Push titles down one level.
399 include::circulation/offline_circ_webclient.adoc[]
401 include::circulation/self_check.adoc[]
403 include::circulation/rfid_product_integration.adoc[]
405 // Return to normal title levels.
414 Learn how to create and use reports in Evergreen.
416 include::reports/reporter_daemon.adoc[]
418 include::reports/reporter_folder.adoc[]
420 include::reports/reporter_create_templates.adoc[]
422 include::reports/reporter_generating_reports.adoc[]
424 include::reports/reporter_view_output.adoc[]
426 include::reports/reporter_cloning_shared_templates.adoc[]
428 include::reports/reporter_add_data_source.adoc[]
430 include::reports/reporter_running_recurring_reports.adoc[]
432 include::reports/reporter_template_terminology.adoc[]
434 include::reports/reporter_template_enhancements.adoc[]
436 include::reports/reporter_export_usingpgAdmin.adoc[]
438 Using the Public Access Catalog
439 ===============================
444 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.
446 include::opac/using_the_public_access_catalog.adoc[]
448 include::opac/my_lists.adoc[]
450 include::opac/kids_opac.adoc[]
452 include::opac/catalog_browse.adoc[]
454 include::opac/advanced_features.adoc[]
456 include::opac/tpac_meta_record_holds.adoc[]
458 include::opac/linked_libraries.adoc[]
460 include::opac/opensearch.adoc[]
462 // Push titles down one level.
465 include::opac/search_form.adoc[]
467 // Return to normal title levels.
477 Developers can use this part to learn more about the programming languages,
478 communication protocols and standards used in Evergreen.
480 include::development/support_scripts.adoc[]
482 // Push titles down one level.
485 include::development/pgtap.adoc[]
486 include::development/intro_opensrf.adoc[]
487 include::development/updating_translations_launchpad.adoc[]
489 // Return to normal title levels.
493 Getting Data from Evergreen
494 ===========================
499 You may be interested in re-using data from your Evergreen installation in
500 another application. This part describes several methods to get the data
503 // Push titles down one level.
506 include::development/data_supercat.adoc[]
508 include::development/data_unapi.adoc[]
510 // Return to normal title levels.
513 include::shared/attributions.adoc[]
515 include::licensing.adoc[]
523 image::media/note.png[]
527 image::media/warning.png[]
531 image::media/caution.png[]
535 image::media/tip.png[]