These now validate with XML schema:

   xmllint --schema docbook-5.0/xsd/docbook.xsd --xinclude --noout index.xml
A slash at the end of the XLink namespace declaration is no good; whoops.
And the placeholder chapters wanted more content. Fine, throw in some index terms.

git-svn-id: svn://svn.open-ils.org/ILS/trunk@12519 dcc99617-32d9-48b4-a31d-7c20da2025e4

diff --git a/docs/index.xml b/docs/index.xml
index c1da3b2..deb48ea 100644 (file)
--- a/docs/index.xml
+++ b/docs/index.xml
@@ -8,20 +8,20 @@
   </info>
 
   <part><title>Preface</title>
-    <chapter><title>Why read this book?</title></chapter>
-    <chapter><title>Conventions</title></chapter>
-    <chapter><title>Getting Evergreen</title></chapter>
-    <chapter><title>Requests for comments</title></chapter>
+    <chapter><title>Why read this book?</title><indexterm><primary>book rationale</primary></indexterm></chapter>
+    <chapter><title>Conventions</title><indexterm><primary>book conventions</primary></indexterm></chapter>
+    <chapter><title>Getting Evergreen</title><indexterm><primary>acquiring Evergreen</primary></indexterm></chapter>
+    <chapter><title>Requests for comments</title><indexterm><primary>comments</primary><secondary>requests for</secondary></indexterm></chapter>
   </part>
 
   <part><title>Introduction</title>
-    <chapter><title>What is Evergreen?</title></chapter>
-    <chapter><title>A brief history of Evergreen</title></chapter>
-    <chapter><title>Is Evergreen right for your library?</title></chapter>
-    <chapter><title>Evergreen architecture</title></chapter>
+    <chapter><title>What is Evergreen?</title><indexterm><primary>about Evergreen</primary></indexterm></chapter>
+    <chapter><title>A brief history of Evergreen</title><indexterm><primary>history</primary></indexterm></chapter>
+    <chapter><title>Is Evergreen right for your library?</title><indexterm><primary>assessing Evergreen</primary></indexterm></chapter>
+    <chapter><title>Evergreen architecture</title><indexterm><primary>architecture</primary></indexterm></chapter>
     <chapter><title>Evergreen concepts</title>
-      <section><title>Organizational units: consortiums, libraries, and locations</title></section>
-      <section><title>Items: bibliographic records, volumes, and copies</title></section>
+      <section><title>Organizational units: consortiums, libraries, and locations</title><indexterm><primary>org_units</primary></indexterm></section>
+      <section><title>Items: bibliographic records, volumes, and copies</title><indexterm><primary>items</primary></indexterm></section>
     </chapter>
     <chapter><title>Scenarios: a tale of two Evergreen systems</title>
       <section>
@@ -57,40 +57,40 @@
   </part>
 
   <part><title>Setting up an Evergreen system</title>
-    <chapter><title>Setting up the router</title></chapter>
-    <chapter><title>Setting up PostgreSQL database</title></chapter>
-    <chapter><title>Setting up the memcached servers</title></chapter>
+    <chapter><title>Setting up the router</title><indexterm><primary>router</primary><secondary>setting up</secondary></indexterm></chapter>
+    <chapter><title>Setting up PostgreSQL database</title><indexterm><primary>database</primary><secondary>setting up</secondary></indexterm></chapter>
+    <chapter><title>Setting up the memcached servers</title><indexterm><primary>memcached</primary><secondary>setting up</secondary></indexterm></chapter>
     <chapter><title>Configuring Evergreen</title>
-      <section><title>Defining basic connection information (opensrf_core.xml)</title></section>
-      <section><title>Defining Z39.50 sources (opensrf.xml)</title></section>
-      <section><title>Defining an added content service (opensrf.xml)</title></section>
-      <section><title>Setting default login timeouts (opensrf.xml)</title></section>
-      <section><title>Setting circulation policies (opensrf.xml / circ_groups.js)</title></section>
-      <section><title>Defining field mappings (fm_IDL.xml)</title></section>
+      <section><title>Defining basic connection information (opensrf_core.xml)</title><indexterm><primary>router connections</primary></indexterm></section>
+      <section><title>Defining Z39.50 sources (opensrf.xml)</title><indexterm><primary>Z39.50 sources</primary></indexterm></section>
+      <section><title>Defining an added content service (opensrf.xml)</title><indexterm><primary>added content</primary></indexterm></section>
+      <section><title>Setting default login timeouts (opensrf.xml)</title><indexterm><primary>OPAC inactivity timeouts</primary></indexterm></section>
+      <section><title>Setting circulation policies (opensrf.xml / circ_groups.js)</title><indexterm><primary>circulation rules</primary></indexterm></section>
+      <section><title>Defining field mappings (fm_IDL.xml)</title><indexterm><primary>interface definition language</primary></indexterm></section>
     </chapter>
     <chapter><title>Setting up Apache Web server</title>
-      <section><title>Basic configuration (apache2.conf / httpd.conf)</title></section>
-      <section><title>Defining your virtual host</title></section>
+      <section><title>Basic configuration (apache2.conf / httpd.conf)</title><indexterm><primary>Web server</primary><secondary>configuring</secondary></indexterm></section>
+      <section><title>Defining your virtual host</title><indexterm><primary>virtual host</primary></indexterm></section>
     </chapter>
-    <chapter><title>Installing the Evergreen staff client</title></chapter>
-    <chapter><title>Troubleshooting</title></chapter>
+    <chapter><title>Installing the Evergreen staff client</title><indexterm><primary>staff client</primary><secondary>installing</secondary></indexterm></chapter>
+    <chapter><title>Troubleshooting</title><indexterm><primary>troubleshooting</primary></indexterm></chapter>
   </part>
 
   <part><title>Administering Evergreen</title>
     <xi:include href="starting_stopping.xml" /> 
-    <chapter><title>Setting up organizational units</title></chapter>
-    <chapter><title>Generating reports</title></chapter>
-    <chapter><title>Preventing disaster</title></chapter>
+    <chapter><title>Setting up organizational units</title><indexterm><primary>organizational units</primary><secondary>setting up</secondary></indexterm></chapter>
+    <chapter><title>Generating reports</title><indexterm><primary>reporting</primary></indexterm></chapter>
+    <chapter><title>Preventing disaster</title><indexterm><primary>backups</primary></indexterm></chapter>
   </part>
 
   <part><title>Core tasks</title>
-    <chapter><title>Cataloging</title></chapter>
+    <chapter><title>Cataloging</title><indexterm><primary>cataloging</primary></indexterm></chapter>
     <chapter><title>Circulation</title>
-      <section><title>Offline circulation</title></section>
+      <section><title>Offline circulation</title><indexterm><primary>circulation</primary><secondary>offline</secondary></indexterm></section>
     </chapter>
-    <chapter><title>Course reserves</title></chapter>
-    <chapter><title>Acquisitions</title></chapter>
-    <chapter><title>Serials</title></chapter>
+    <chapter><title>Course reserves</title><indexterm><primary>reserves</primary><secondary>academic</secondary></indexterm></chapter>
+    <chapter><title>Acquisitions</title><indexterm><primary>acquisitions</primary></indexterm></chapter>
+    <chapter><title>Serials</title><indexterm><primary>serials</primary></indexterm></chapter>
   </part>
 
   <part><title>Customizing Evergreen</title>
@@ -104,15 +104,15 @@
       </para>
     </partintro>
     <chapter><title>Customizing the staff client</title>
-      <section><title>Changing the theme</title></section>
-      <section><title>Changing labels and messages</title></section>
-      <section><title>Changing key mappings</title></section>
+      <section><title>Changing the theme</title><indexterm><primary>staff client</primary><secondary>customizing</secondary><tertiary>theme</tertiary></indexterm></section>
+      <section><title>Changing labels and messages</title><indexterm><primary>staff client</primary><secondary>customizing</secondary><tertiary>labels and messages</tertiary></indexterm></section>
+      <section><title>Changing key mappings</title><indexterm><primary>staff client</primary><secondary>customizing</secondary><tertiary>key mappings</tertiary></indexterm></section>
     </chapter>
     <chapter><title>Customizing the catalog</title>
-      <section><title>Changing the theme</title></section>
-      <section><title>Changing labels and messages</title></section>
-      <section><title>Changing the hit list details</title></section>
-      <section><title>Changing the detailed view details</title></section>
+      <section><title>Changing the theme</title><indexterm><primary>catalog</primary><secondary>customizing</secondary><tertiary>theme</tertiary></indexterm></section>
+      <section><title>Changing labels and messages</title><indexterm><primary>catalog</primary><secondary>customizing</secondary><tertiary>labels and messages</tertiary></indexterm></section>
+      <section><title>Changing the hit list details</title><indexterm><primary>search results</primary><secondary>customizing</secondary></indexterm></section>
+      <section><title>Changing the detailed view details</title><indexterm><primary>record details</primary><secondary>customizing</secondary></indexterm></section>
     </chapter>
   </part>
 
@@ -127,11 +127,11 @@
       </para>
     </partintro>
     <chapter><title>Application Programming Interfaces</title>
-      <section><title>OpenSRF</title></section>
-      <section><title>Web services</title></section>
+      <section><title>OpenSRF</title><indexterm><primary>OpenSRF</primary></indexterm></section>
+      <section><title>Web services</title><indexterm><primary>Web services</primary></indexterm></section>
     </chapter>
-    <chapter><title>Database schemas</title></chapter>
-    <chapter><title>Communication protocols (XMPP + JSON)</title></chapter>
-    <chapter><title>Configuration files</title></chapter>
+    <chapter><title>Database schemas</title><indexterm><primary>database schema</primary></indexterm></chapter>
+    <chapter><title>Communication protocols (XMPP + JSON)</title><indexterm><primary>protocols</primary></indexterm></chapter>
+    <chapter><title>Configuration files</title><indexterm><primary>configuration files</primary></indexterm></chapter>
   </part>
 </book>

diff --git a/docs/starting_stopping.xml b/docs/starting_stopping.xml
index 0f4795b..79f9dc4 100644 (file)
--- a/docs/starting_stopping.xml
+++ b/docs/starting_stopping.xml
@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="utf-8"?>
 <chapter version="5.0" xmlns="http://docbook.org/ns/docbook"
   xmlns:xi="http://www.w3.org/2001/XInclude"
-  xmlns:xlink="http://www.w3.org/1999/xlink/">
+  xmlns:xlink="http://www.w3.org/1999/xlink">
   <title>Starting and stopping the Evergreen services</title>
     <para>
       This chapter tells you how to start and stop the Evergreen services.
     </para> 
-  <section id="starting_stopping_intro">
+  <section xml:id="starting_stopping_intro">
     <title>Introduction</title>
     <para>
       We may talk a bit about how Evergreen is built on OpenSRF and uses
@@ -15,14 +15,14 @@
       <link xlink:href="http://blah.com">further documentation</link>.
     </para>
   </section>
-  <section id="starting_stopping_start">
+  <section xml:id="starting_stopping_start">
     <title>Starting the Evergreen services</title>
     <para>
       To start all of the Evergreen services on a given server, issue
       the following command as the opensrf user:
-    </para>
-    <userinput><![CDATA[
+      <userinput><![CDATA[
 osrf_ctl.sh -a start_all
 ]]></userinput>
+    </para>
   </section>
 </chapter>