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_6.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 include::admin/customize_staff_client.txt[]
140 // Push titles down one level.
143 include::admin/phonelist.txt[]
145 // Return to normal title levels.
148 include::admin/sip_server.txt[]
151 Using the Staff Client
152 ======================
158 This part of the documentation deals with general Staff Client usage including
159 logging in, navigation and shortcuts.
162 include::admin/staff_client-login.txt[]
164 include::admin/staff_client-button_bar_toolbar.txt[]
166 include::admin/staff_client-sticky_settings.txt[]
168 include::admin/staff_client-tab_buttons.txt[]
170 include::admin/staff_client-double_clicking.txt[]
172 include::admin/staff_client-patron_border.txt[]
174 include::admin/staff_client-sorting_columns.txt[]
176 include::admin/staff_client-column_picker.txt[]
178 include::admin/staff_client-recent_searches.txt[]
180 include::admin/staff_client-return_to_results_from_marc.txt[]
182 include::admin/workstation_admin.txt[]
184 System Administration From the Staff Client
185 ===========================================
190 This part deals with the options in the Server Administration menu found in the
193 // Follow structure from staff client system admin menu.
195 include::admin/acquisitions_admin.txt[]
197 include::admin/authorities.txt[]
199 include::admin/Best_Hold_Selection_Sort_Order.txt[]
201 include::admin/cn_prefixes_and_suffixes.txt[]
203 include::admin/circulation_limit_groups.txt[]
205 include::admin/booking-admin.txt[]
207 // Push titles down one level.
210 include::admin/floating_groups.txt[]
212 // Return to normal title levels.
215 include::admin/MARC_Import_Remove_Fields.txt[]
217 include::admin/MARC_RAD_MVF_CRA.txt[]
219 include::admin/Org_Unit_Proximity_Adjustments.txt[]
221 include::admin/permissions.txt[]
223 include::admin/SMS_messaging.txt[]
225 include::admin/user_activity_type.txt[]
227 include::admin/restrict_Z39.50_sources_by_perm_group.txt[]
236 This part covers the options in the Local Administration menu found in the staff
239 // Follow structure from staff client local admin menu.
241 // Push titles down one level.
244 include::admin/hold_driven_recalls.txt[]
246 // Return to normal title levels.
249 include::admin/actiontriggers.txt[]
251 include::admin/recent_staff_searches.txt[]
253 include::admin/lsa-library_settings_editor.txt[]
255 include::admin/lsa-standing_penalties.txt[]
257 include::admin/lsa-statcat.txt[]
259 include::admin/lsa-work_log.txt[]
264 include::acquisitions/introduction.txt[]
266 include::acquisitions/selection_lists_po.txt[]
268 include::acquisitions/invoices.txt[]
270 include::acquisitions/receive_items_from_invoice.txt[]
272 include::acquisitions/vandelay_acquisitions_integration.txt[]
281 Cataloguers should use this part for understanding the cataloguing procedures
284 include::cataloging/MARC_Fixed_Field.txt[]
286 include::cataloging/physical_char_wizard.txt[]
288 include::cataloging/batch_importing_MARC.txt[]
290 include::cataloging/overlay_record_3950_import.txt[]
292 include::cataloging/z39.50_search_enhancements.txt[]
294 include::cataloging/monograph_parts.txt[]
296 include::cataloging/conjoined_items.txt[]
298 include::cataloging/cataloging_electronic_resources.txt[]
300 include::cataloging/link_checker.txt[]
306 include::serials/A-intro.txt[]
308 include::serials/B-copy_template.txt[]
310 include::serials/C-subscription-SCV.txt[]
312 include::serials/D-subscription-ASCV.txt[]
314 include::serials/E-edit_subscriptions.txt[]
316 include::serials/F-Receiving.txt[]
318 include::serials/G-Special_issue.txt[]
320 include::serials/H-holdings_statements.txt[]
322 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.txt[]
330 Use this section for understanding the circulation procedures in the Evergreen
333 include::circulation/circulating_items.txt[]
335 include::circulation/holds.txt[]
337 include::circulation/booking.txt[]
339 include::circulation/circulation_patron_records.txt[]
341 include::circulation/triggered_events.txt[]
343 // Push titles down one level.
346 include::circulation/offline_mode.txt[]
348 include::circulation/self_check.txt[]
350 include::circulation/rfid_product_integration.txt[]
352 // Return to normal title levels.
361 Learn how to create and use reports in Evergreen.
363 include::reports/reporter_daemon.txt[]
365 include::reports/reporter_folder.txt[]
367 include::reports/reporter_create_templates.txt[]
369 include::reports/reporter_generating_reports.txt[]
371 include::reports/reporter_view_output.txt[]
373 include::reports/reporter_cloning_shared_templates.txt[]
375 include::reports/reporter_add_data_source.txt[]
377 include::reports/reporter_running_recurring_reports.txt[]
379 include::reports/reporter_template_terminology.txt[]
381 include::reports/reporter_export_usingpgAdmin.txt[]
383 Using the Public Access Catalog
384 ===============================
389 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.
391 include::opac/using_the_public_access_catalog.txt[]
393 include::opac/my_lists.txt[]
395 include::opac/kids_opac.txt[]
397 include::opac/catalog_browse.txt[]
399 include::opac/advanced_features.txt[]
401 include::opac/tpac_meta_record_holds.txt[]
403 include::opac/linked_libraries.txt[]
405 include::opac/opensearch.txt[]
407 // Push titles down one level.
410 include::opac/search_form.txt[]
412 // Return to normal title levels.
422 Developers can use this part to learn more about the programming languages,
423 communication protocols and standards used in Evergreen.
425 include::development/support_scripts.txt[]
427 // Push titles down one level.
430 include::development/pgtap.txt[]
431 include::development/intro_opensrf.txt[]
432 include::development/updating_translations_launchpad.txt[]
434 // Return to normal title levels.
437 include::attributions.txt[]
439 include::licensing.txt[]
447 image::media/note.png[]
451 image::media/warning.png[]
455 image::media/caution.png[]
459 image::media/tip.png[]