Add "Updating translations with Launchpad" dev docs
[Evergreen-DocBook.git] / root.txt
index 3a7833b..f7cc349 100644 (file)
--- a/root.txt
+++ b/root.txt
@@ -2,6 +2,8 @@ Evergreen Documentation
 =======================\r
 Documentation Interest Group\r
 :doctype: book\r
+:toc:\r
+:numbered:\r
 \r
 Introduction\r
 ============ \r
@@ -9,7 +11,16 @@ Introduction
 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
+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 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
 \r
@@ -32,8 +43,14 @@ The community’s development requirements state that Evergreen must be:
 \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
 \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
@@ -46,11 +63,17 @@ This part will guide you through the installation steps installation or upgradin
 \r
 include::installation/system_requirements.txt[]\r
 \r
+// Push titles down one level.\r
+:leveloffset: 1\r
+\r
 include::installation/server_installation.txt[]\r
 \r
+// Return to normal title levels.\r
+:leveloffset: 0\r
+\r
 include::installation/server_upgrade.txt[]\r
 \r
-// include::system_troubleshooting.txt[]\r
+include::installation/edi_setup.txt[]\r
 \r
 // include::staff_client_installation.txt[] \r
 // include::org_unit_structure_initialization.txt[]\r
@@ -88,6 +111,8 @@ This part deals with the options in the Server Administration menu found in the
 \r
 // Follow structure from staff client system admin menu.\r
 \r
+include::admin/acquisitions_admin.txt[]\r
+\r
 include::admin/authority_control_sets.txt[]\r
 \r
 include::admin/cn_prefixes_and_suffixes.txt[]\r
@@ -110,16 +135,19 @@ This part covers the options in the Local Administration menu found in the staff
 \r
 include::admin/recent_staff_searches.txt[]\r
 \r
+include::admin/lsa-statcat.txt[]\r
+\r
+\r
 Acquisitions\r
 ===========\r
 \r
-Introduction\r
-------------\r
+include::acquisitions/introduction.txt[]\r
 \r
-This part is intended for staff who are involved in managing and processing acquisitions. \r
+include::acquisitions/selection_lists_po.txt[]\r
 \r
 include::acquisitions/receive_items_from_invoice.txt[]\r
 \r
+\r
 Cataloging\r
 ==========\r
 \r
@@ -129,18 +157,33 @@ Introduction
 Cataloguers should use this part for understanding the cataloguing procedures 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
@@ -180,6 +223,38 @@ Introduction
 \r
 Developers can use this part to learn more about the programming languages, 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
+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