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_0.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/borrowing_items.adoc[]
119 // Return to normal title levels.
122 include::admin_initial_setup/hard_due_dates.adoc[]
126 include::admin/template_toolkit.adoc[]
128 // Push titles down one level.
131 include::opac/new_skin_customizations.adoc[]
133 // Return to normal title levels.
136 include::admin/auto_suggest_search.adoc[]
138 include::admin/authentication_proxy.adoc[]
140 // Push titles down one level.
143 include::TechRef/KidsOPAC.adoc[]
145 // Return to normal title levels.
148 include::admin/customize_staff_client.adoc[]
150 include::admin/patron_address_by_zip_code.adoc[]
152 // Push titles down one level.
155 include::admin/phonelist.adoc[]
157 // Return to normal title levels.
160 include::admin/sip_server.adoc[]
162 include::admin/apache_rewrite_tricks.adoc[]
164 include::admin/apache_access_handler.adoc[]
166 include::admin/ebook_api_service.adoc[]
168 include::admin/hold_targeter_service.adoc[]
170 // Push titles down one level.
173 include::admin/backups.adoc[]
175 // Return to normal title levels.
180 Using the Browser Staff Client
181 ==============================
187 This part of the documentation deals with general Browser Client usage including
188 logging in, navigation and shortcuts.
190 For information about the XUL client, consult the http://docs.evergreen-ils.org/2.11/[Evergreen 2.11 documentation].
192 include::admin/web_client-login.adoc[]
194 include::admin/web-client-browser-best-practices.adoc[]
196 include::admin/staff_client-column_picker.adoc[]
198 include::admin/staff_client-recent_searches.adoc[]
200 include::admin/workstation_admin.adoc[]
202 // Push titles down one level.
205 include::admin/workstation_admin_receipt_template_editor.adoc[]
207 // Return to normal title levels.
210 System Administration From the Staff Client
211 ===========================================
216 This part deals with the options in the Server Administration menu found in the
219 // Follow structure from staff client system admin menu.
221 include::admin/acquisitions_admin.adoc[]
223 include::admin/age_hold_protection.adoc[]
225 include::admin/authorities.adoc[]
227 include::admin/Best_Hold_Selection_Sort_Order.adoc[]
229 include::admin/booking-admin.adoc[]
231 include::admin/cn_prefixes_and_suffixes.adoc[]
233 include::admin/desk_payments.adoc[]
235 include::admin/circulation_limit_groups.adoc[]
237 include::admin/copy_statuses.adoc[]
239 // Push titles down one level.
242 include::admin/floating_groups.adoc[]
244 // Return to normal title levels.
247 include::admin/MARC_Import_Remove_Fields.adoc[]
249 include::admin/MARC_RAD_MVF_CRA.adoc[]
251 include::admin/Org_Unit_Proximity_Adjustments.adoc[]
253 include::admin/permissions.adoc[]
255 include::admin/SMS_messaging.adoc[]
257 include::admin/user_activity_type.adoc[]
259 include::admin/restrict_Z39.50_sources_by_perm_group.adoc[]
268 This part covers the options in the Local Administration menu found in the staff
271 // Follow structure from staff client local admin menu.
273 include::admin/librarysettings.adoc[]
275 // Address Alert Feature
276 include::admin/lsa-address_alert.adoc[]
278 // Barcode Completion Feature
279 include::admin/lsa-barcode_completion.adoc[]
281 // Push titles down one level.
284 include::admin/hold_driven_recalls.adoc[]
286 // Return to normal title levels.
289 include::admin/actiontriggers.adoc[]
291 include::admin/actiontriggers_process.adoc[]
293 include::admin/recent_staff_searches.adoc[]
295 include::admin/lsa-standing_penalties.adoc[]
297 include::admin/lsa-statcat.adoc[]
299 include::admin/popularity_badges_web_client.adoc[]
301 include::admin/lsa-work_log.adoc[]
306 include::acquisitions/introduction.adoc[]
308 include::acquisitions/selection_lists_po.adoc[]
310 include::acquisitions/invoices.adoc[]
312 include::acquisitions/receive_items_from_invoice.adoc[]
314 include::acquisitions/vandelay_acquisitions_integration.adoc[]
316 include::acquisitions/purchase_requests_patron_view.adoc[]
318 include::acquisitions/purchase_requests_management.adoc[]
320 include::acquisitions/blanket.adoc[]
329 This part describes cataloging in Evergreen.
331 include::cataloging/marc_tag_table.adoc[]
333 include::cataloging/copy-buckets_web_client.adoc[]
336 include::cataloging/MARC_Editor.adoc[]
340 include::cataloging/record_buckets.adoc[]
342 // Push titles down one level.
345 include::cataloging/physical_char_wizard.adoc[]
347 // Return titles to correct level.
350 include::cataloging/batch_importing_MARC.adoc[]
352 include::cataloging/overlay_record_3950_import.adoc[]
354 include::cataloging/z39.50_search_enhancements.adoc[]
357 include::cataloging/monograph_parts.adoc[]
360 include::cataloging/conjoined_items.adoc[]
362 include::cataloging/cataloging_electronic_resources.adoc[]
364 include::cataloging/tpac_copy_edit_links.adoc[]
366 include::cataloging/MARC_batch_edit.adoc[]
368 include::cataloging/authorities.adoc[]
370 include::cataloging/link_checker.adoc[]
376 include::serials/A-intro.adoc[]
378 include::serials/B-copy_template.adoc[]
380 include::serials/C-subscription-SCV.adoc[]
382 include::serials/D-subscription-ASCV.adoc[]
384 include::serials/E-edit_subscriptions.adoc[]
386 include::serials/F-Receiving.adoc[]
388 include::serials/G-Special_issue.adoc[]
390 include::serials/H-holdings_statements.adoc[]
392 include::serials/Group_Serials_Issues_in_the_OPAC_2.2.adoc[]
400 Use this section for understanding the circulation procedures in the Evergreen
403 include::circulation/circulating_items_web_client.adoc[]
408 include::circulation/basic_holds.adoc[]
410 include::circulation/advanced_holds.adoc[]
412 include::circulation/booking.adoc[]
414 include::circulation/circulation_patron_records_web_client.adoc[]
416 include::circulation/triggered_events.adoc[]
418 // Push titles down one level.
421 include::circulation/offline_circ_webclient.adoc[]
423 include::circulation/self_check.adoc[]
425 include::circulation/rfid_product_integration.adoc[]
427 // Return to normal title levels.
436 Learn how to create and use reports in Evergreen.
438 include::reports/reporter_daemon.adoc[]
440 include::reports/reporter_folder.adoc[]
442 include::reports/reporter_create_templates.adoc[]
444 include::reports/reporter_generating_reports.adoc[]
446 include::reports/reporter_view_output.adoc[]
448 include::reports/reporter_cloning_shared_templates.adoc[]
450 include::reports/reporter_add_data_source.adoc[]
452 include::reports/reporter_running_recurring_reports.adoc[]
454 include::reports/reporter_template_terminology.adoc[]
456 include::reports/reporter_template_enhancements.adoc[]
458 include::reports/reporter_export_usingpgAdmin.adoc[]
460 Using the Public Access Catalog
461 ===============================
466 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.
468 include::opac/using_the_public_access_catalog.adoc[]
470 include::opac/my_lists.adoc[]
472 include::opac/kids_opac.adoc[]
474 include::opac/catalog_browse.adoc[]
476 include::opac/advanced_features.adoc[]
478 include::opac/tpac_meta_record_holds.adoc[]
480 include::opac/linked_libraries.adoc[]
482 include::opac/opensearch.adoc[]
484 // Push titles down one level.
487 include::opac/search_form.adoc[]
489 // Return to normal title levels.
499 Developers can use this part to learn more about the programming languages,
500 communication protocols and standards used in Evergreen.
502 include::development/support_scripts.adoc[]
504 // Push titles down one level.
507 include::development/pgtap.adoc[]
508 include::development/intro_opensrf.adoc[]
509 include::development/updating_translations_launchpad.adoc[]
511 // Return to normal title levels.
515 Getting Data from Evergreen
516 ===========================
521 You may be interested in re-using data from your Evergreen installation in
522 another application. This part describes several methods to get the data
525 // Push titles down one level.
528 include::development/data_supercat.adoc[]
530 include::development/data_unapi.adoc[]
532 // Return to normal title levels.
535 include::shared/attributions.adoc[]
537 include::licensing.adoc[]
545 image::media/note.png[]
549 image::media/warning.png[]
553 image::media/caution.png[]
557 image::media/tip.png[]