Evergreen Documentation\r
=======================\r
-\r
+Documentation Interest Group\r
+:doctype: book\r
+:toc:\r
+:numbered:\r
\r
Introduction\r
============ \r
About This Documentation\r
------------------------\r
\r
-This guide was produced by the Evergreen Documentation Interest Group (DIG), consisting of numerous volunteers from many different organizations. The DIG has drawn together, edited, and supplemented pre-existing documentation contributed by libraries and consortia running Evergreen that were kind enough to release their documentation into the creative commons. For a full list of authors and contributing organizations, see Appendix B, About this Documentation. Just like the software it describes, this guide is a work in progress, continually revised to meet the needs of its users, so if you find errors or omissions, please let us know, by contacting the DIG facilitators at docs@evergreen-ils.org.\r
-\r
-This guide to Evergreen is intended to meet the needs of front-line library staff, catalogers, library administrators, system administrators, and software developers. It is organized into Parts, Chapters, and Sections addressing key aspects of the software, beginning with the topics of broadest interest to the largest groups of users and progressing to some of the more specialized and technical topics of interest to smaller numbers of users.\r
+This guide was produced by the Evergreen Documentation Interest Group (DIG),\r
+consisting of numerous volunteers from many different organizations. The DIG\r
+has drawn together, edited, and supplemented pre-existing documentation\r
+contributed by libraries and consortia running Evergreen that were kind enough\r
+to release their documentation into the creative commons. Please see the\r
+<<attributions,Attributions>> section for a full list of authors and\r
+contributing organizations. Just like the software it describes, this guide is\r
+a work in progress, continually revised to meet the needs of its users, so if\r
+you find errors or omissions, please let us know, by contacting the DIG\r
+facilitators at docs@evergreen-ils.org.\r
+\r
+This guide to Evergreen is intended to meet the needs of front-line library\r
+staff, catalogers, library administrators, system administrators, and software\r
+developers. It is organized into Parts, Chapters, and Sections addressing key\r
+aspects of the software, beginning with the topics of broadest interest to the\r
+largest groups of users and progressing to some of the more specialized and\r
+technical topics of interest to smaller numbers of users.\r
\r
Copies of this guide can be accessed in PDF and HTML formats from http://docs.evergreen-ils.org/.\r
\r
About Evergreen\r
---------------\r
\r
-Evergreen is an open source library automation software designed to meet the needs of the very smallest to the very largest libraries and consortia. Through its staff interface, it facilitates the management, cataloging, and circulation of library materials, and through its online public access interface it helps patrons find those materials.\r
+Evergreen is an open source library automation software designed to meet the\r
+needs of the very smallest to the very largest libraries and consortia. Through\r
+its staff interface, it facilitates the management, cataloging, and circulation\r
+of library materials, and through its online public access interface it helps\r
+patrons find those materials.\r
\r
-The Evergreen software is freely licensed under the GNU General Public License, meaning that it is free to download, use, view, modify, and share. It has an active development and user community, as well as several companies offering migration, support, hosting, and development services.\r
+The Evergreen software is freely licensed under the GNU General Public License,\r
+meaning that it is free to download, use, view, modify, and share. It has an\r
+active development and user community, as well as several companies offering\r
+migration, support, hosting, and development services.\r
\r
The community’s development requirements state that Evergreen must be:\r
\r
* Secure, to protect our patrons’ privacy and data.\r
* User-friendly, to facilitate patron and staff use of the system.\r
\r
-Evergreen, which first launched in 2006 now powers over 544 libraries of every type – public, academic, special, school, and even tribal and home libraries – in over a dozen countries worldwide.\r
+Evergreen, which first launched in 2006 now powers over 544 libraries of every\r
+type – public, academic, special, school, and even tribal and home libraries –\r
+in over a dozen countries worldwide.\r
+\r
+// Push titles down one level.\r
+:leveloffset: 1\r
\r
include::release_notes.txt[]\r
\r
+// Return to normal title levels.\r
+:leveloffset: 0\r
+\r
Software Installation\r
=====================\r
\r
Introduction\r
------------\r
\r
-This part will guide you through the installation steps installation or upgrading your Evergreen system. It is intended for system administrators. \r
+This part will guide you through the installation steps installation or\r
+upgrading your Evergreen system. It is intended for system administrators. \r
+\r
\r
+include::installation/system_requirements.txt[]\r
\r
-include::system_requirements.txt[]\r
+// Push titles down one level.\r
+:leveloffset: 1\r
\r
-include::server_installation.txt[]\r
+include::installation/server_installation.txt[]\r
\r
-include::server_upgrade.txt[]\r
+// Return to normal title levels.\r
+:leveloffset: 0\r
\r
-// include::system_troubleshooting.txt[]\r
+include::installation/server_upgrade.txt[]\r
+\r
+include::installation/edi_setup.txt[]\r
\r
// include::staff_client_installation.txt[] \r
// include::org_unit_structure_initialization.txt[]\r
Introduction\r
------------\r
\r
-The Evergreen system allows a free range of customizations to every aspect of the system. Use this part of the documentation to become familiar with the tools for configuring the system as well as customizing the OPAC and staff client. \r
-\r
+The Evergreen system allows a free range of customizations to every aspect of\r
+the system. Use this part of the documentation to become familiar with the tools\r
+for configuring the system as well as customizing the OPAC and staff client. \r
\r
// include::global_system_configuration.txt[]\r
// include::opac_customization.txt[]\r
-//include::staff_client_customization.txt[]\r
+\r
+include::admin/template_toolkit.txt[]\r
+\r
+include::admin/auto_suggest_search.txt[]\r
+\r
+include::admin/customize_staff_client.txt[]\r
+\r
// include::backing_up.txt[]\r
\r
\r
\r
+Using the Staff Client\r
+======================\r
+\r
+\r
+Introduction\r
+------------\r
+\r
+This part of the documentation deals with general Staff Client usage including\r
+logging in, navigation and shortcuts.\r
+\r
+\r
+include::admin/staff_client-tab_buttons.txt[]\r
+\r
+include::admin/staff_client-double_clicking.txt[]\r
+\r
+include::admin/staff_client-sorting_columns.txt[]\r
+\r
+include::admin/staff_client-recent_searches.txt[]\r
+\r
+include::admin/staff_client-return_to_results_from_marc.txt[]\r
+\r
System Administration From the Staff Client\r
===========================================\r
\r
Introduction\r
------------\r
\r
-This part deals with the options in the Server Administration menu found in the staff client. \r
+This part deals with the options in the Server Administration menu found in the\r
+staff client. \r
\r
// Follow structure from staff client system admin menu.\r
\r
+include::admin/acquisitions_admin.txt[]\r
+\r
+include::admin/authorities.txt[]\r
+\r
+include::admin/cn_prefixes_and_suffixes.txt[]\r
+\r
+include::admin/restrict_Z39.50_sources_by_perm_group.txt[]\r
+\r
+include::admin/booking-admin.txt[]\r
+\r
+include::admin/SMS_messaging.txt[]\r
+\r
+include::admin/user_activity_type.txt[]\r
+\r
\r
Local Administration\r
====================\r
Introduction\r
------------\r
\r
-This part covers the options in the Local Administration menu found in the staff client. \r
+This part covers the options in the Local Administration menu found in the staff\r
+client. \r
\r
// Follow structure from staff client local admin menu.\r
\r
+// Push titles down one level.\r
+:leveloffset: 1\r
+\r
+include::admin/hold_driven_recalls.txt[]\r
+\r
+// Return to normal title levels.\r
+:leveloffset: 0\r
+\r
+include::admin/recent_staff_searches.txt[]\r
+\r
+include::admin/lsa-library_settings_editor.txt[]\r
+\r
+include::admin/lsa-statcat.txt[]\r
+\r
\r
Acquisitions\r
===========\r
\r
-Introduction\r
-------------\r
+include::acquisitions/introduction.txt[]\r
+\r
+include::acquisitions/selection_lists_po.txt[]\r
+\r
+include::acquisitions/receive_items_from_invoice.txt[]\r
+\r
+include::acquisitions/vandelay_acquisitions_integration.txt[]\r
\r
-This part is intended for staff who are involved in managing and processing acquisitions. \r
\r
Cataloging\r
==========\r
Introduction\r
------------\r
\r
-Cataloguers should use this part for understanding the cataloguing procedures used in Evergreen.\r
+Cataloguers should use this part for understanding the cataloguing procedures\r
+used in Evergreen.\r
+\r
+include::cataloging/batch_importing_MARC.txt[]\r
+\r
+include::cataloging/overlay_record_3950_import.txt[]\r
+\r
+include::cataloging/monograph_parts.txt[]\r
+\r
+include::cataloging/conjoined_items.txt[]\r
+\r
\r
Serials\r
=======\r
\r
-Introduction\r
-------------\r
+include::serials/A-intro.txt[]\r
+\r
+include::serials/B-copy_template.txt[]\r
+\r
+include::serials/C-subscription-SCV.txt[]\r
+\r
+include::serials/D-subscription-ASCV.txt[]\r
+\r
+include::serials/E-edit_subscriptions.txt[]\r
+\r
+include::serials/F-Receiving.txt[]\r
+\r
+include::serials/G-Special_issue.txt[]\r
+\r
+include::serials/H-holdings_statements.txt[]\r
\r
-This part is intended for staff involved in Serials management and processing.\r
\r
Circulation\r
===========\r
Introduction\r
------------\r
\r
-Use this section for understanding the circulation procedures in the Evergreen system. \r
+Use this section for understanding the circulation procedures in the Evergreen\r
+system. \r
+\r
+include::circulation/circulating_items.txt[]\r
+\r
+include::circulation/booking.txt[]\r
\r
Reports\r
=======\r
\r
Use this part for information about searching the Evergreen public access catalog.\r
\r
+include::opac/my_lists.txt[]\r
+\r
Developer Resources\r
===================\r
\r
Introduction\r
------------\r
\r
-Developers can use this part to learn more about the programming languages, communication protocols and standards used in Evergreen. \r
+Developers can use this part to learn more about the programming languages,\r
+communication protocols and standards used in Evergreen. \r
+\r
+// Push titles down one level.\r
+:leveloffset: 1\r
+\r
+include::development/updating_translations_launchpad.txt[]\r
+\r
+// Return to normal title levels.\r
+:leveloffset: 0\r
\r
[appendix]\r
\r
+include::attributions.txt[]\r
+\r
+include::licensing.txt[]\r
+\r
+Admonitions\r
+===========\r
+\r
+Images used for Admonitions\r
+---------------------------\r
+\r
+* Note \r
+\r
+image::media/note.png[]\r
+\r
+* warning\r
+\r
+image::media/warning.png[]\r
+\r
+* caution\r
+\r
+image::media/caution.png[]\r
+\r
+* tip\r
+\r
+image::media/tip.png[]\r
+\r
\r
projects / Evergreen-DocBook.git / blobdiff