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_5.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/customize_staff_client.txt[]
138 include::admin/phonelist.txt
141 Using the Staff Client
142 ======================
148 This part of the documentation deals with general Staff Client usage including
149 logging in, navigation and shortcuts.
152 include::admin/staff_client-login.txt[]
154 include::admin/staff_client-tab_buttons.txt[]
156 include::admin/staff_client-double_clicking.txt[]
158 include::admin/staff_client-patron_border.txt[]
160 include::admin/staff_client-sorting_columns.txt[]
162 include::admin/staff_client-recent_searches.txt[]
164 include::admin/staff_client-return_to_results_from_marc.txt[]
166 include::admin/workstation_admin.txt[]
168 System Administration From the Staff Client
169 ===========================================
174 This part deals with the options in the Server Administration menu found in the
177 // Follow structure from staff client system admin menu.
179 include::admin/acquisitions_admin.txt[]
181 include::admin/authorities.txt[]
183 include::admin/Best_Hold_Selection_Sort_Order.txt[]
185 include::admin/cn_prefixes_and_suffixes.txt[]
187 include::admin/circulation_limit_groups.txt[]
189 include::admin/booking-admin.txt[]
191 // Push titles down one level.
194 include::admin/floating_groups.txt[]
196 // Return to normal title levels.
199 include::admin/MARC_Import_Remove_Fields.txt[]
201 include::admin/Org_Unit_Proximity_Adjustments.txt[]
203 include::admin/permissions.txt[]
205 include::admin/SMS_messaging.txt[]
207 include::admin/user_activity_type.txt[]
209 include::admin/restrict_Z39.50_sources_by_perm_group.txt[]
218 This part covers the options in the Local Administration menu found in the staff
221 // Follow structure from staff client local admin menu.
223 // Push titles down one level.
226 include::admin/hold_driven_recalls.txt[]
228 // Return to normal title levels.
231 include::admin/actiontriggers.txt[]
233 include::admin/recent_staff_searches.txt[]
235 include::admin/lsa-library_settings_editor.txt[]
237 include::admin/lsa-standing_penalties.txt[]
239 include::admin/lsa-statcat.txt[]
241 include::admin/lsa-work_log.txt[]
246 include::acquisitions/introduction.txt[]
248 include::acquisitions/selection_lists_po.txt[]
250 include::acquisitions/invoices.txt[]
252 include::acquisitions/receive_items_from_invoice.txt[]
254 include::acquisitions/vandelay_acquisitions_integration.txt[]
263 Cataloguers should use this part for understanding the cataloguing procedures
266 include::cataloging/batch_importing_MARC.txt[]
268 include::cataloging/overlay_record_3950_import.txt[]
270 include::cataloging/z39.50_search_enhancements.txt[]
272 include::cataloging/monograph_parts.txt[]
274 include::cataloging/conjoined_items.txt[]
276 include::cataloging/link_checker.txt[]
282 include::serials/A-intro.txt[]
284 include::serials/B-copy_template.txt[]
286 include::serials/C-subscription-SCV.txt[]
288 include::serials/D-subscription-ASCV.txt[]
290 include::serials/E-edit_subscriptions.txt[]
292 include::serials/F-Receiving.txt[]
294 include::serials/G-Special_issue.txt[]
296 include::serials/H-holdings_statements.txt[]
298 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.txt[]
306 Use this section for understanding the circulation procedures in the Evergreen
309 include::circulation/circulating_items.txt[]
311 include::circulation/holds.txt[]
313 include::circulation/booking.txt[]
315 include::circulation/circulation_patron_records.txt[]
317 include::circulation/triggered_events.txt[]
319 // Push titles down one level.
322 include::circulation/offline_mode.txt[]
324 include::circulation/self_check.txt[]
326 include::rfid_product_integration.txt[]
328 // Return to normal title levels.
337 Learn how to create and use reports in Evergreen.
339 include::reports/reporter_daemon.txt[]
341 include::reports/reporter_folder.txt[]
343 include::reports/reporter_create_templates.txt[]
345 include::reports/reporter_generating_reports.txt[]
347 include::reports/reporter_view_output.txt[]
349 include::reports/reporter_cloning_shared_templates.txt[]
351 include::reports/reporter_add_data_source.txt[]
353 include::reports/reporter_running_recurring_reports.txt[]
355 include::reports/reporter_template_terminology.txt[]
357 include::reports/reporter_export_usingpgAdmin.txt[]
359 Using the Public Access Catalog
360 ===============================
365 Use this part for information about searching the Evergreen public access catalog.
367 include::opac/my_lists.txt[]
369 include::opac/kids_opac.txt[]
371 include::opac/catalog_browse.txt[]
373 include::opac/advanced_features.txt[]
375 // Push titles down one level.
378 include::opac/search_form.txt[]
380 // Return to normal title levels.
390 Developers can use this part to learn more about the programming languages,
391 communication protocols and standards used in Evergreen.
393 // Push titles down one level.
396 include::development/pgtap.txt[]
397 include::development/intro_opensrf.txt[]
398 include::development/updating_translations_launchpad.txt[]
400 // Return to normal title levels.
403 include::attributions.txt[]
405 include::licensing.txt[]
413 image::media/note.png[]
417 image::media/warning.png[]
421 image::media/caution.png[]
425 image::media/tip.png[]