add sections to the introductory chapter
authorNicole C. Engard <nengard@gmail.com>
Thu, 24 Jul 2014 12:48:40 +0000 (07:48 -0500)
committerNicole C. Engard <nengard@gmail.com>
Thu, 24 Jul 2014 12:48:40 +0000 (07:48 -0500)
en/images/intro/getthere.png [new file with mode: 0644]
en/manual.xml

diff --git a/en/images/intro/getthere.png b/en/images/intro/getthere.png
new file mode 100644 (file)
index 0000000..91f88a9
Binary files /dev/null and b/en/images/intro/getthere.png differ
index dcf31e9..b1531c0 100644 (file)
@@ -33,7 +33,7 @@
   <chapter id="introchapter">
     <title>Introduction</title>
     <section>
-      <title id="introbasics">Basics</title>
+      <title id="introbasics">Koha Basics</title>
       <para>Koha is the first free and open source software library automation package (ILS).
         Development is sponsored by libraries of varying types and sizes, volunteers, and support
         companies from around the world.</para>
@@ -41,7 +41,7 @@
           url="http://koha-community.org">http://koha-community.org</ulink></para>
     </section>
     <section id="introrecommend">
-      <title>Recommendations</title>
+      <title>Koha Recommendations</title>
       <para>Full system recommendations can be found on the official Koha wiki along with the
         developer documentation: <ulink url="http://wiki.koha-community.org">
           http://wiki.koha-community.org</ulink></para>
         Firefox browser.  Koha's staff client is not supported in Internet Explorer and has not yet
         been fully optimized for Google Chrome.</para>
     </section>
+    <section id="usingmanual">
+      <title>Using this Manual</title>
+      <para>This manual is always changing and suggestions for edits can be sent to the
+        Documentation Manager via the <ulink
+          url="https://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-docs">DOCS mailing
+          list</ulink>.  The manual is organized by Koha module. At the start of most sections (and
+        throughout) you will find 'Get there' tips. These lines tell you how to get to the section
+        in Koha.  </para>
+      <para>For example: <emphasis>Get there:</emphasis> More &gt; Administration &gt; Global System
+        Preferences</para>
+      <para>
+        <screenshot>
+          <screeninfo>Get there: More > Administration > Global System Preferences</screeninfo>
+          <mediaobject>
+            <imageobject>
+              <imagedata fileref="images/intro/getthere.png"/>
+            </imageobject>
+          </mediaobject>
+        </screenshot>
+      </para>
+      <para>The instruction tells you where to find the necessary menu option at the top of the Koha
+        staff client.</para>
+      <para>Links will be found throughout the manual to other sections in the manual and images
+        will depict what should be seen on the screen.  </para>
+      <para>The manual can be searched using the custom Google search on the <ulink
+          url="http://koha-community.org/documentation/">Koha Documentation</ulink> page.</para>
+    </section>
+    <section id="contributing">
+      <title>Contributing to the Manual</title>
+      <para>This manual is an ever-changing document and edits to the manual are welcome at any
+        time.  </para>
+      <para>The <ulink url="http://manual.koha-community.org/">Koha Manual</ulink> is managed by the
+        Documentation Manager, but that doesn't mean we can't all participate in making the best
+        manual possible. </para>
+      <para>The manual is stored in git at: <ulink
+          url="http://git.koha-community.org/gitweb/?p=kohadocs.git;a=summary"
+          >http://git.koha-community.org/gitweb/?p=kohadocs.git;a=summary</ulink></para>
+      <para>To edit the manual we recommend <ulink url="http://www.oxygenxml.com">oXygen</ulink> or
+        other XML/DocBook editor. We ask that every chapter and section have an ID tag associated
+        with it to enable permanent linking and searching. </para>
+      <para>Patches to the manual should be emailed to the <ulink
+          url="https://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-docs">DOCS mailing
+          list</ulink> and will be reviewed by the Documentation Manager before inclusion. </para>
+    </section>
   </chapter>
 
   <chapter id="administration">