Fix encoding issues.
[working/Evergreen.git] / root.txt
index 77ad534..de97d36 100644 (file)
--- a/root.txt
+++ b/root.txt
@@ -1,10 +1,13 @@
 Evergreen Documentation\r
 =======================\r
-Robert Soulliere <robert.soulliere@mohawkcollege.ca>\r
-v2.2, January 2011\r
+Documentation Interest Group\r
+:doctype: book\r
 \r
 Introduction\r
------------- \r
+============ \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
@@ -13,7 +16,8 @@ This guide to Evergreen is intended to meet the needs of front-line library staf
 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
+\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
 \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
@@ -30,85 +34,167 @@ Evergreen, which first launched in 2006 now powers over 544 libraries of every t
 \r
 include::release_notes.txt[]\r
 \r
-\r
-\r
 Software Installation\r
----------------------\r
+=====================\r
+\r
 \r
 Introduction\r
-~~~~~~~~~~~~\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
+\r
+\r
+include::installation/system_requirements.txt[]\r
+\r
+include::installation/server_installation.txt[]\r
+\r
+include::installation/server_upgrade.txt[]\r
+\r
+include::edi_setup.txt[]\r
+\r
+// include::staff_client_installation.txt[] \r
+// include::org_unit_structure_initialization.txt[]\r
+// include::loading_data.txt[]\r
 \r
 \r
 System Configuration and Customization\r
---------------------------------------\r
+======================================\r
 \r
 Introduction\r
-~~~~~~~~~~~~\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
+\r
+// include::global_system_configuration.txt[]\r
+// include::opac_customization.txt[]\r
+\r
+\r
+include::admin/template_toolkit.txt[]\r
+\r
+\r
+//include::staff_client_customization.txt[]\r
+// include::backing_up.txt[]\r
\r
 \r
 \r
 System Administration From the Staff Client\r
--------------------------------------------\r
+===========================================\r
 \r
 Introduction\r
-~~~~~~~~~~~~\r
+------------\r
+\r
+This part deals with the options in the Server Administration menu found in the staff client. \r
+\r
+// Follow structure from staff client system admin menu.\r
+\r
+include::admin/authority_control_sets.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
 \r
 Local Administration\r
---------------------\r
+====================\r
 \r
 Introduction\r
-~~~~~~~~~~~~\r
+------------\r
+\r
+This part covers the options in the Local Administration menu found in the staff client. \r
+\r
+// Follow structure from staff client local admin menu.\r
 \r
 \r
-Acqiostions\r
------------\r
+include::admin/recent_staff_searches.txt[]\r
+\r
+Acquisitions\r
+===========\r
 \r
 Introduction\r
-~~~~~~~~~~~~\r
+------------\r
+\r
+This part is intended for staff who are involved in managing and processing acquisitions. \r
 \r
+include::acquisitions/receive_items_from_invoice.txt[]\r
 \r
 Cataloging\r
-----------\r
+==========\r
+\r
+Introduction\r
+------------\r
 \r
-Intrododuction\r
-~~~~~~~~~~~~~~\r
+Cataloguers should use this part for understanding the cataloguing procedures used in Evergreen.\r
 \r
-\Serials\r
--------\r
+include::cataloging/batch_importing_MARC.txt[]\r
 \r
-Introduction\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
+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_subscription.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
 \r
 Circulation\r
------------\r
+===========\r
 \r
 Introduction\r
-~~~~~~~~~~~~\r
+------------\r
+\r
+Use this section for understanding the circulation procedures in the Evergreen system.  \r
 \r
+include::circulation/circulating_items.txt[]\r
+\r
+include::circulation/booking.txt[]\r
 \r
 Reports\r
--------\r
+=======\r
 \r
 Introduction\r
-~~~~~~~~~~~~\r
+------------\r
 \r
+Learn how to create and use reports in Evergreen. \r
 \r
 Using the Public Access Catalog\r
--------------------------------\r
+===============================\r
 \r
 Introduction\r
-~~~~~~~~~~~~\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
 \r
 Introduction\r
-~~~~~~~~~~~~\r
+------------\r
 \r
+Developers can use this part to learn more about the programming languages, communication protocols and standards used in Evergreen.  \r
 \r
-Appendices\r
-----------\r
+[appendix]\r
 \r
+include::attributions.txt[]\r