Move part intros to root file.
authorrsoulliere <robert.soulliere@mohawkcollege.ca>
Mon, 12 Dec 2011 20:48:56 +0000 (15:48 -0500)
committerrsoulliere <robert.soulliere@mohawkcollege.ca>
Mon, 12 Dec 2011 20:48:56 +0000 (15:48 -0500)
admin/admin-intro.xml [deleted file]
reports/report-intro.xml [deleted file]
root.xml

diff --git a/admin/admin-intro.xml b/admin/admin-intro.xml
deleted file mode 100644 (file)
index 813ed6c..0000000
+++ /dev/null
@@ -1,15 +0,0 @@
-<partintro xmlns:xl="http://www.w3.org/1999/xlink" xml:id="admin_intro">\r
-       <para>This part of the documentation is intended for Evergreen administrators and requires root access to your <application>Evergreen</application> server(s) and administrator access to \r
-       the <application>Evergreen</application> \r
-       staff client. It deals with maintaining servers, installation, upgrading, and configuring both system wide and local library settings. \r
-       Some sections require understanding of <systemitem class="osname">Linux</systemitem> system administration while others require an understanding of your system hierarchy of locations \r
-       and users. Many procedures explained in the following \r
-       chapters are accomplished with <systemitem class="osname">Linux</systemitem> commands<indexterm><primary>Linux</primary><secondary>commands</secondary></indexterm> run from the \r
-       terminal without a Graphical User Interface (GUI).</para>\r
-       <para>In order to accomplish some of the tasks, prerequisite knowledge or experience will be required and you may need to consult system administration documentation for your \r
-       specific <systemitem class="osname">Linux</systemitem> distribution if you have limited <systemitem class="osname">Linux</systemitem> system experience. A vast ammount of free \r
-       resources can be found on the on the web for various experinece levels. You might also consider consulting <link xl:href="http://www.postgresql.org/docs/">\r
-       <application>PostgreSQL</application></link><indexterm><primary>databases</primary><secondary>PostgreSQL</secondary></indexterm> and \r
-       <link xl:href="http://httpd.apache.org/docs/"><application>Apache</application></link><indexterm><primary>Apache</primary></indexterm> documentation for a greater understanding \r
-       of the software stack on which <application>Evergreen</application> is built.</para>\r
-</partintro>\r
diff --git a/reports/report-intro.xml b/reports/report-intro.xml
deleted file mode 100644 (file)
index 476b11c..0000000
+++ /dev/null
@@ -1,5 +0,0 @@
-<partintro xmlns:xl="http://www.w3.org/1999/xlink" xml:id="report_intro">\r
-<para>Reports are a powerful tool in Evergreen and can be used for statistical comparisons or collection maintenance. The following part covers everything dealing with reports from starting the reporter daemon to viewing reports your library has created. The range of topics in this part is quite broad and different chapters will be useful to different roles in an Evergreen library system.</para>\r
-</partintro>\r
-\r
-\r
index d044908..9151e87 100755 (executable)
--- a/root.xml
+++ b/root.xml
        <part xml:id="intro">\r
                <info>\r
                        <title>Introduction</title>\r
-               </info>\r
-               <xi:include href="intro/intro_intro.xml"/>\r
+               </info> \r
+               <partintro xmlns:xl="http://www.w3.org/1999/xlink" xml:id="intro_intro">\r
+                       <para>The book you’re holding in your hands or viewing on a screen is The Book of Evergreen, the official guide to the 2.x version of the Evergreen open \r
+                       source library automation software.  This guide was produced by the Evergreen Documentation Interest Group (DIG), consisting of numerous volunteers from many \r
+                       different organizations.  The DIG has drawn together, edited, and supplemented pre-existing documentation contributed by libraries and consortia running \r
+                       Evergreen that were kind enough to release their documentation into the creative commons.  For a full list of authors and contributing organizations, \r
+                       see <xref linkend="about_this_documentation"></xref>.  Just like the software it describes, this guide is a work in progress, continually revised to meet \r
+                       the needs of its users, so if you find errors or omissions, please let us know, by contacting the DIG facilitators at \r
+                       <link mailto="docs@evergreen-ils.org">docs@evergreen-ils.org</link>.</para>\r
+                       <para>This guide to Evergreen is intended to meet the needs of front-line library staff, catalogers, library administrators, system administrators, and \r
+                       software developers.  It is organized into Parts, Chapters, and Sections addressing key aspects of the software, beginning with the topics of broadest \r
+                       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.</para>\r
+                       <para>Copies of this guide can be accessed in PDF and HTML formats from the Documentation section of \r
+                       <link href="http://evergreen-ils.org/">http://evergreen-ils.org/</link> and are included in DocBook XML format along with the Evergreen \r
+                       source code, available for download from the same Web site.</para>\r
+               </partintro>\r
                <xi:include href="intro/about_evergreen.xml"/>\r
                <xi:include href="intro/release_notes.xml"/>\r
        </part>\r
                <info>\r
                        <title>Public Access Catalog</title>\r
                </info>\r
-       <!--    <xi:include href="opac/opac_intro.xml"/>-->\r
+               <partintro xml:id="opac_intro">\r
+                       <para>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 \r
+                       describes the <quote>My Account</quote> tools users have to find information and manage their personal library accounts through the OPAC. This section \r
+                       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.</para>\r
+               </partintro>    \r
        </part>\r
        <part xml:id="core_tasks">\r
                <info>\r
                        <title>Core Staff Tasks</title>\r
                </info>\r
-       <!--    <xi:include href="stafftasks/stafftasks_intro.xml"/>\r
-               <xi:include href="stafftasks/booking.xml"/>\r
+               <partintro xml:id="stafftasks_intro">\r
+                       <para>This part of the documentation covers a broad range of the common tasks carried out by your library and includes tasks performed by circulation \r
+                       staff and catalogers among others. Some of these procedures should only be performed by Local System Administrators, but most of these sections will give \r
+                       all staff a better understanding of the Evergreen system and its features.</para>\r
+               </partintro>\r
+       \r
+       <!--    <xi:include href="stafftasks/booking.xml"/>\r
                <xi:include href="stafftasks/acquisitions.xml"/>\r
                <xi:include href="stafftasks/serials-gpls.xml"/>\r
                <xi:include href="stafftasks/alternate_serial_control.xml"/>\r
                <info>\r
                        <title>Administration</title>\r
                </info>\r
-               <xi:include href="admin/admin-intro.xml"/>      \r
+               <partintro xmlns:xl="http://www.w3.org/1999/xlink" xml:id="admin_intro">\r
+                       <para>This part of the documentation is intended for Evergreen administrators and requires root access to your <application>Evergreen</application> server(s) \r
+                       and administrator access to the <application>Evergreen</application> \r
+                       staff client. It deals with maintaining servers, installation, upgrading, and configuring both system wide and local library settings. \r
+                       Some sections require understanding of <systemitem class="osname">Linux</systemitem> system administration while others require an understanding of your \r
+                       system hierarchy of locations and users. Many procedures explained in the following chapters are accomplished with \r
+                       <systemitem class="osname">Linux</systemitem> commands<indexterm><primary>Linux</primary><secondary>commands</secondary></indexterm> run from the \r
+                       terminal without a Graphical User Interface (GUI).</para>\r
+                       <para>In order to accomplish some of the tasks, prerequisite knowledge or experience will be required and you may need to consult system administration \r
+                       documentation for your specific <systemitem class="osname">Linux</systemitem> distribution if you have limited \r
+                       <systemitem class="osname">Linux</systemitem> system experience. A vast ammount of free resources can be found on the on the web for various experinece \r
+                       levels. You might also consider consulting <link xl:href="http://www.postgresql.org/docs/">\r
+                       <application>PostgreSQL</application></link><indexterm><primary>databases</primary><secondary>PostgreSQL</secondary></indexterm> and \r
+                       <link xl:href="http://httpd.apache.org/docs/"><application>Apache</application></link><indexterm><primary>Apache</primary></indexterm> documentation \r
+                       for a greater understanding of the software stack on which <application>Evergreen</application> is built.</para>\r
+               </partintro>\r
                <xi:include href="admin/server_install.xml"/>\r
                <xi:include href="admin/upgrading.xml"/>\r
                <!--<xi:include href="admin/sip.xml"/>\r
                <info>\r
                        <title>Reports</title>\r
                </info>\r
-               <xi:include href="reports/report-intro.xml"/>\r
+               <partintro xmlns:xl="http://www.w3.org/1999/xlink" xml:id="report_intro">\r
+                       <para>Reports are a powerful tool in Evergreen and can be used for statistical comparisons or collection maintenance. The following part covers everything \r
+                       dealing with reports from starting the reporter daemon to viewing reports your library has created. The range of topics in this part is quite broad and \r
+                       different chapters will be useful to different roles in an Evergreen library system.</para>\r
+               </partintro>\r
                <xi:include href="reports/report-startingreporter.xml"/>\r
                <xi:include href="reports/report-folder.xml"/>\r
                <xi:include href="reports/report-create-template.xml"/>\r