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_7.txt[]
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/template_toolkit.txt[]
126 // Push titles down one level.
129 include::opac/new_skin_customizations.txt[]
131 // Return to normal title levels.
134 include::admin/auto_suggest_search.txt[]
136 include::admin/authentication_proxy.txt[]
138 // Push titles down one level.
141 include::TechRef/KidsOPAC.txt[]
143 // Return to normal title levels.
146 include::admin/customize_staff_client.txt[]
148 // Push titles down one level.
151 include::admin/phonelist.txt[]
153 // Return to normal title levels.
156 include::admin/sip_server.txt[]
158 Using the Staff Client
159 ======================
165 This part of the documentation deals with general Staff Client usage including
166 logging in, navigation and shortcuts.
169 include::admin/staff_client-login.txt[]
171 include::admin/staff_client-button_bar_toolbar.txt[]
173 include::admin/staff_client-sticky_settings.txt[]
175 include::admin/staff_client-tab_buttons.txt[]
177 include::admin/staff_client-double_clicking.txt[]
179 include::admin/staff_client-patron_border.txt[]
181 include::admin/staff_client-sorting_columns.txt[]
183 include::admin/staff_client-column_picker.txt[]
185 include::admin/staff_client-recent_searches.txt[]
187 include::admin/staff_client-return_to_results_from_marc.txt[]
189 include::admin/workstation_admin.txt[]
191 System Administration From the Staff Client
192 ===========================================
197 This part deals with the options in the Server Administration menu found in the
200 // Follow structure from staff client system admin menu.
202 include::admin/acquisitions_admin.txt[]
204 include::admin/authorities.txt[]
206 include::admin/Best_Hold_Selection_Sort_Order.txt[]
208 include::admin/booking-admin.txt[]
210 include::admin/cn_prefixes_and_suffixes.txt[]
212 include::admin/circulation_limit_groups.txt[]
214 include::admin/copy_statuses.txt[]
216 // Push titles down one level.
219 include::admin/floating_groups.txt[]
221 // Return to normal title levels.
224 include::admin/MARC_Import_Remove_Fields.txt[]
226 include::admin/MARC_RAD_MVF_CRA.txt[]
228 include::admin/Org_Unit_Proximity_Adjustments.txt[]
230 include::admin/permissions.txt[]
232 include::admin/SMS_messaging.txt[]
234 include::admin/user_activity_type.txt[]
236 include::admin/restrict_Z39.50_sources_by_perm_group.txt[]
245 This part covers the options in the Local Administration menu found in the staff
248 // Follow structure from staff client local admin menu.
250 include::admin/lsa-address_alert.txt[]
252 // Push titles down one level.
255 include::admin/hold_driven_recalls.txt[]
257 // Return to normal title levels.
260 include::admin/actiontriggers.txt[]
262 include::admin/recent_staff_searches.txt[]
264 include::admin/lsa-library_settings_editor.txt[]
266 include::admin/lsa-standing_penalties.txt[]
268 include::admin/lsa-statcat.txt[]
270 include::admin/lsa-work_log.txt[]
275 include::acquisitions/introduction.txt[]
277 include::acquisitions/selection_lists_po.txt[]
279 include::acquisitions/invoices.txt[]
281 include::acquisitions/receive_items_from_invoice.txt[]
283 include::acquisitions/vandelay_acquisitions_integration.txt[]
292 Cataloguers should use this part for understanding the cataloguing procedures
295 include::cataloging/MARC_Fixed_Field.txt[]
297 include::cataloging/physical_char_wizard.txt[]
299 include::cataloging/batch_importing_MARC.txt[]
301 include::cataloging/overlay_record_3950_import.txt[]
303 include::cataloging/z39.50_search_enhancements.txt[]
305 include::cataloging/monograph_parts.txt[]
307 include::cataloging/conjoined_items.txt[]
309 include::cataloging/cataloging_electronic_resources.txt[]
311 include::cataloging/tpac_copy_edit_links.txt[]
313 include::cataloging/MARC_batch_edit.txt[]
315 include::cataloging/link_checker.txt[]
321 include::serials/A-intro.txt[]
323 include::serials/B-copy_template.txt[]
325 include::serials/C-subscription-SCV.txt[]
327 include::serials/D-subscription-ASCV.txt[]
329 include::serials/E-edit_subscriptions.txt[]
331 include::serials/F-Receiving.txt[]
333 include::serials/G-Special_issue.txt[]
335 include::serials/H-holdings_statements.txt[]
337 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.txt[]
345 Use this section for understanding the circulation procedures in the Evergreen
348 include::circulation/circulating_items.txt[]
350 include::circulation/holds.txt[]
352 include::circulation/booking.txt[]
354 include::circulation/circulation_patron_records.txt[]
356 include::circulation/triggered_events.txt[]
358 // Push titles down one level.
361 include::circulation/offline_mode.txt[]
363 include::circulation/self_check.txt[]
365 include::circulation/rfid_product_integration.txt[]
367 // Return to normal title levels.
376 Learn how to create and use reports in Evergreen.
378 include::reports/reporter_daemon.txt[]
380 include::reports/reporter_folder.txt[]
382 include::reports/reporter_create_templates.txt[]
384 include::reports/reporter_generating_reports.txt[]
386 include::reports/reporter_view_output.txt[]
388 include::reports/reporter_cloning_shared_templates.txt[]
390 include::reports/reporter_add_data_source.txt[]
392 include::reports/reporter_running_recurring_reports.txt[]
394 include::reports/reporter_template_terminology.txt[]
396 include::reports/reporter_template_enhancements.txt[]
398 include::reports/reporter_export_usingpgAdmin.txt[]
400 Using the Public Access Catalog
401 ===============================
406 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.
408 include::opac/using_the_public_access_catalog.txt[]
410 include::opac/my_lists.txt[]
412 include::opac/kids_opac.txt[]
414 include::opac/catalog_browse.txt[]
416 include::opac/advanced_features.txt[]
418 include::opac/tpac_meta_record_holds.txt[]
420 include::opac/linked_libraries.txt[]
422 include::opac/opensearch.txt[]
424 // Push titles down one level.
427 include::opac/search_form.txt[]
429 // Return to normal title levels.
439 Developers can use this part to learn more about the programming languages,
440 communication protocols and standards used in Evergreen.
442 include::development/support_scripts.txt[]
444 // Push titles down one level.
447 include::development/pgtap.txt[]
448 include::development/intro_opensrf.txt[]
449 include::development/updating_translations_launchpad.txt[]
451 // Return to normal title levels.
454 include::attributions.txt[]
456 include::licensing.txt[]
464 image::media/note.png[]
468 image::media/warning.png[]
472 image::media/caution.png[]
476 image::media/tip.png[]