Merge branch 'master' of github.com:rsoulliere/Evergreen-DocBook
authorSteve Sheppard <ssheps@gmail.com>
Thu, 16 Sep 2010 14:03:17 +0000 (10:03 -0400)
committerSteve Sheppard <ssheps@gmail.com>
Thu, 16 Sep 2010 14:03:17 +0000 (10:03 -0400)
1.6/admin/AdminMisc.xml
1.6/admin/Upgrading-Evergreen_1.6.xml
1.6/admin/admin-lsa.xml
1.6/admin/serveradministration.xml
1.6/admin/sip.xml
1.6/admin/troubleshooting.xml
1.6/development/OpenSRF_intro.xml
1.6/stafftasks/staffclient.xml

index 33f6f6e..cb66410 100644 (file)
@@ -51,7 +51,7 @@
                <indexterm><primary>web server</primary><secondary>Apache</secondary></indexterm> for the OPAC to work correctly.</para>  \r
                <para>To stop <application>Evergreen</application>, run:</para>\r
                <screen><userinput>osrf_ctl.sh -l -a stop_all</userinput></screen>\r
-               <para>As with starting, you can choose to stop one service</para>\r
+               <para>As with starting, you can choose to stop services individually.</para>\r
                <para>To restart <application>Evergreen</application>, run:</para>\r
                <screen><userinput>osrf_ctl.sh -l -a restart_all</userinput></screen>\r
        </section>\r
@@ -67,8 +67,7 @@
                        <secondary>PostgreSQL</secondary></indexterm>  database. You can therefore use normal \r
                        <application>PostgreSQL</application> backup procedures to backup this data. For example, the simplest method of backing up the Evergreen\r
                        database is to use the <command>pg_dump</command> command to create a live backup of the database without having to \r
-                       interrupt any Evergreen services:</para>\r
-                       <screen><userinput># pg_dump -U [username] -h [hostname] -f [output-file] [database-name]</userinput></screen> \r
+                       interrupt any Evergreen services. Here is an example pg_dump command which will dump a local Evergreen database into a the file <filename>evergreen_db.backup</filename>:</para>\r
                        <screen><userinput>pg_dump -U evergreen -h localhost -f evergreen_db.backup evergreen</userinput></screen>\r
                        <para>To restore the backed up database into a new database, create a new database using the \r
                        template0 database template and the UTF8 encoding, and run the <command>psql</command> command, specifying the new \r
index 1ef3795..a194b37 100644 (file)
                                <screen><userinput>/openils/bin/srfsh</userinput></screen>\r
                                <screen><userinput>srfsh#  request opensrf.math add 2 2</userinput></screen>\r
                                <para>You should see output like:</para>\r
-                               <screen>\r
-                               Received Data: 4\r
-                               \r
-                               ------------------------------------\r
-                               Request Completed Successfully\r
-                               Request Time in seconds: 0.007519\r
-                               ------------------------------------\r
-                               \r
-                               srfsh#\r
-                               </screen>       \r
+<screen>\r
+Received Data: 4\r
+\r
+------------------------------------\r
+Request Completed Successfully\r
+Request Time in seconds: 0.007519\r
+------------------------------------\r
+\r
+srfsh#\r
+</screen>      \r
                                <para>If test completed successfully move onto next section. \r
                                Otherwise, refer to the <link linkend="troubleshooting">troubleshooting</link> chapter \r
                                of this documentation.</para> \r
                                <para>As the <systemitem class="username">root</systemitem> user, build <filename>live-db-setup.pl</filename> for the cgi-bin \r
                                bootstrapping scripts and <filename>offline-config.pl</filename> for the offline staff client data uploader:</para>\r
                                <screen><userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.8</userinput></screen>                          \r
-                               <screen>\r
-                               <userinput>\r
-                               perl Open-ILS/src/support-scripts/eg_db_config.pl --create-bootstrap --create-offline --user evergreen \\r
-                               --password evergreen --hostname localhost --port 5432 --database evergreen\r
-                               </userinput>\r
-                               </screen>\r
+<screen>\r
+<userinput>\r
+perl Open-ILS/src/support-scripts/eg_db_config.pl --create-bootstrap --create-offline --user evergreen \\r
+--password evergreen --hostname localhost --port 5432 --database evergreen\r
+</userinput>\r
+</screen>\r
                        </step>\r
                        <step>\r
                                <para>As the <systemitem class="username">opensrf</systemitem> user, update server symlink in <filename class="directory">/openils/var/web/xul/</filename>:</para>\r
@@ -249,11 +249,11 @@ psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.7-1.6.0.8-upgrade-db
                        </step>\r
                        <step>\r
                                <para>Update <filename>opensrf.xml</filename> with the database connection info:</para>\r
-                               <screen>\r
-                               <userinput>\r
-                               perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config --service all --user evergreen \\r
-                               --password evergreen --hostname localhost --port 5432 --database evergreen\r
-                               </userinput>\r
+<screen>\r
+<userinput>\r
+perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config --service all --user evergreen \\r
+--password evergreen --hostname localhost --port 5432 --database evergreen\r
+</userinput>\r
                                </screen>\r
                        </step>\r
                        <step>\r
index 6e8ee6f..824bb4c 100644 (file)
@@ -39,7 +39,7 @@
       <para>Items on this menu are visible to anyone logged into the staff client but usually\r
          require special permissions to edit. The following table describes each of the menu options. </para>\r
       <informaltable>\r
-         <tgroup cols="3" align="left" colsep="1" rowsep="1">\r
+         <tgroup cols="2" align="left" colsep="1" rowsep="1">\r
 \r
             <thead>\r
                <row>\r
                </row>\r
                <row>\r
                   <entry>\r
-                     <link linkend="report-introduction">Reports</link>\r
+                     Reports\r
                   </entry>\r
                   <entry>Generate reports on any field in the Evergreen database</entry>                  \r
                </row>\r
                </row>\r
                <row>\r
                   <entry>\r
-                     <link linkend="transit">Transit List</link>\r
+                       Transit List\r
                   </entry>\r
                   <entry>View items in transit to or from your library during selected date\r
                      range</entry>              \r
          <para>There are also options in the <guilabel>Copy Editor</guilabel> for a copy to be\r
                <guilabel>OPAC Visible</guilabel>-yes or no, <guilabel>Holdable</guilabel>-yes or no,\r
             or <guilabel>Circulate</guilabel>-yes or no. ┬áIf either the copy record or the shelving\r
-            location is set to Circulate-no, then the item will not be able to circulate. See <xref\r
-               linkend="add"/> for more about the <guilabel>Copy Editor.</guilabel></para>\r
+            location is set to Circulate-no, then the item will not be able to circulate.</para>\r
       </tip>\r
       <informalfigure>\r
          <para>This is where you see the shelving locations in the <guilabel>Copy\r
                      <entry>Sets language used in staff client</entry>\r
                      <entry><link linkend="lsa-data-types">Text</link> (dollars)</entry>\r
                      \r
-                     <entry>Can be set for each workstation at <link linkend="intro-login"\r
-                           >login</link></entry>\r
+                     <entry>Can be set for each workstation at login</entry>\r
                   </row>\r
 \r
                   <row xml:id="lsa-do-not-automatically-delete">\r
index c58e323..ca8b657 100644 (file)
@@ -171,8 +171,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
              <procedure>\r
 \r
                 <step>\r
-                   <para>Open the <guilabel>Organizational Units</guilabel> interface as described in the steps\r
-                         <link linkend="server-main">above</link>.</para>\r
+                   <para>Open the <guilabel>Organizational Units</guilabel> interface.</para>\r
                 </step>\r
                 <step>\r
                    <informalfigure>\r
@@ -1716,54 +1715,54 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
                                Create a marc template in  the directory <filename class="directory">/openils/var/templates/marc/</filename>. It should be in xml format.\r
                                Here is an example file <filename>k_book.xml</filename>: \r
                                </para>\r
-                       <programlisting language="xml">\r
-                       <![CDATA[\r
-                       <record>\r
-                         <leader>00620cam a2200205Ka 4500</leader>\r
-                         <controlfield tag="008">070101s                            eng d</controlfield>\r
-                         <datafield tag="010" ind1="" ind2="">\r
-                           <subfield code="a"></subfield>\r
-                         </datafield>\r
-                         <datafield tag="020" ind1="" ind2="">\r
-                           <subfield code="a"></subfield>\r
-                         </datafield>\r
-                         <datafield tag="082" ind1="0" ind2="4">\r
-                           <subfield code="a"></subfield>\r
-                         </datafield>\r
-                         <datafield tag="092" ind1="" ind2="">\r
-                           <subfield code="a"></subfield>\r
-                         </datafield>\r
-                         <datafield tag="100" ind1="" ind2="">\r
-                           <subfield code="a"></subfield>\r
-                         </datafield>\r
-                         <datafield tag="245" ind1="" ind2="">\r
-                           <subfield code="a"></subfield>\r
-                           <subfield code="b"></subfield>\r
-                           <subfield code="c"></subfield>\r
-                         </datafield>\r
-                         <datafield tag="260" ind1="" ind2="">\r
-                           <subfield code="a"></subfield>\r
-                           <subfield code="b"></subfield>\r
-                           <subfield code="c"></subfield>\r
-                         </datafield>\r
-                         <datafield tag="300" ind1="" ind2="">\r
-                           <subfield code="a"></subfield>\r
-                           <subfield code="b"></subfield>\r
-                           <subfield code="c"></subfield>\r
-                         </datafield>\r
-                         <datafield tag="500" ind1="" ind2="">\r
-                           <subfield code="a"></subfield>\r
-                         </datafield>\r
-                         <datafield tag="650" ind1="" ind2="">\r
-                           <subfield code="a"></subfield>\r
-                           <subfield code="v"></subfield>\r
-                         </datafield>\r
-                         <datafield tag="650" ind1="" ind2="">\r
-                           <subfield code="a"></subfield>\r
-                         </datafield>\r
-                       </record>\r
-                       ]]>\r
-                       </programlisting>\r
+<programlisting language="xml">\r
+<![CDATA[\r
+<record>\r
+  <leader>00620cam a2200205Ka 4500</leader>\r
+  <controlfield tag="008">070101s                            eng d</controlfield>\r
+  <datafield tag="010" ind1="" ind2="">\r
+    <subfield code="a"></subfield>\r
+  </datafield>\r
+  <datafield tag="020" ind1="" ind2="">\r
+    <subfield code="a"></subfield>\r
+  </datafield>\r
+  <datafield tag="082" ind1="0" ind2="4">\r
+    <subfield code="a"></subfield>\r
+  </datafield>\r
+  <datafield tag="092" ind1="" ind2="">\r
+    <subfield code="a"></subfield>\r
+  </datafield>\r
+  <datafield tag="100" ind1="" ind2="">\r
+    <subfield code="a"></subfield>\r
+  </datafield>\r
+  <datafield tag="245" ind1="" ind2="">\r
+    <subfield code="a"></subfield>\r
+    <subfield code="b"></subfield>\r
+    <subfield code="c"></subfield>\r
+  </datafield>\r
+  <datafield tag="260" ind1="" ind2="">\r
+    <subfield code="a"></subfield>\r
+    <subfield code="b"></subfield>\r
+    <subfield code="c"></subfield>\r
+  </datafield>\r
+  <datafield tag="300" ind1="" ind2="">\r
+    <subfield code="a"></subfield>\r
+    <subfield code="b"></subfield>\r
+    <subfield code="c"></subfield>\r
+  </datafield>\r
+  <datafield tag="500" ind1="" ind2="">\r
+    <subfield code="a"></subfield>\r
+  </datafield>\r
+  <datafield tag="650" ind1="" ind2="">\r
+    <subfield code="a"></subfield>\r
+    <subfield code="v"></subfield>\r
+  </datafield>\r
+  <datafield tag="650" ind1="" ind2="">\r
+    <subfield code="a"></subfield>\r
+  </datafield>\r
+</record>\r
+]]>\r
+</programlisting>\r
        \r
                        </step>\r
                        <step>\r
@@ -1772,7 +1771,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
                        </step>\r
                        <step>\r
                                <para>Restart <systemitem class="service">Perl</systemitem><indexterm><primary>Perl</primary></indexterm> services for changes to take effect.</para>\r
-                               <screen><userimput>/openils/bin/osrf_ctl.sh -l -a restart_perl</userimput></screen>\r
+                               <screen><userinput>/openils/bin/osrf_ctl.sh -l -a restart_perl</userinput></screen>\r
                        </step>\r
                </procedure>\r
        </section>\r
@@ -1792,9 +1791,9 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
                <simplesect>\r
                        <title>Indexed-field Weighting<indexterm><primary>relevancy</primary><secondary>indexed-field weighting</secondary></indexterm> </title>\r
                        <para>Indexed-field weighting is configured in the Evergreen database in the weight column\r
-                       of the <link linkend="config.metabib_field">config.metabib_field</link> table, which follows the other four columns in this table:\r
+                       of the <link linkend="config.table.metabib-field">config.metabib_field</link> table, which follows the other four columns in this table:\r
                        field_class, name, xpath, and format.</para>\r
-                       <para>The following is one representative line from the <link linkend="config.metabib_field">config.metabib_field</link> table:</para>\r
+                       <para>The following is one representative line from the <link linkend="config.table.metabib-field">config.metabib_field</link> table:</para>\r
                        <screen> author | conference | //mods32:mods/mods32:name[@type='conference']/mods32:namePart[../mods32:role/mods32:roleTerm[text()='creator']] | mods32 | 1 ) </screen>\r
                        <para>The default value for index-field weights in config.metabib_field is 1. Adjust the\r
                        weighting of indexed fields to boost or lower the relevance score for matches on that\r
@@ -2001,7 +2000,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
                        <para> Searching the out of the box <emphasis>keyword</emphasis> does not boost the ranking for terms appearing in, the title or subject fields since  there is just one \r
                        keyword index which does not distinguish terms that appear in the title field from those in the notes field for example. In comparison, the title index is actually composed of \r
                        a number of separate indexes: title|proper, title|uniform, title|alternative, title|translated, etc, that collectively form the title index. You can see this in the \r
-                       <link linkend="config.metabib_field">config.metabib_field</link> table. The following procedure will add a keyword|title index so that terms found in the title field of an \r
+                       <link linkend="config.table.metabib-field">config.metabib_field</link> table. The following procedure will add a keyword|title index so that terms found in the title field of an \r
                        item are given more weight than terms in other fields. </para>\r
                        <procedure>\r
                                <step>\r
@@ -2011,47 +2010,47 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
                                <step>\r
                                        <para>Clone the title|proper index to create a keyword|title index</para>\r
                                        <para>6 = the title|proper index</para>\r
-                                       <programlisting>\r
-                                       INSERT INTO config.metabib_field \r
-                                               (field_class, name, xpath, weight, format, search_field, facet_field)\r
-                                               SELECT 'keyword', 'title', xpath, weight, format, search_field, facet_field\r
-                                               FROM config.metabib_field\r
-                                               WHERE id = 6;\r
-                                       </programlisting>\r
+<programlisting>\r
+INSERT INTO config.metabib_field \r
+       (field_class, name, xpath, weight, format, search_field, facet_field)\r
+       SELECT 'keyword', 'title', xpath, weight, format, search_field, facet_field\r
+       FROM config.metabib_field\r
+       WHERE id = 6;\r
+</programlisting>\r
                                </step>\r
                                <step>\r
                                        <para>Populate the keyword|title index with a set of index entries cloned from the metabib.title_field_entry table;</para>\r
                                        <para>6 = the title|proper index</para>\r
-                                       <programlisting>\r
-                                       INSERT INTO metabib.keyword_field_entry \r
-                                               (source, field, value)\r
-                                               SELECT source, 17, value (the field value, 17, field be different in your database so you may need to check the \r
-                                               <link linkend="config.metabib_field">config.metabib_field</link> for the id of your new index).\r
-                                               FROM metabib.title_field_entry\r
-                                               WHERE field = 6;\r
-                                       </programlisting>\r
+<programlisting>\r
+INSERT INTO metabib.keyword_field_entry \r
+       (source, field, value)\r
+       SELECT source, 17, value (the field value, 17, field be different in your database so you may need to check the \r
+       <link linkend="config.table.metabib-field">config.metabib_field</link> for the id of your new index).\r
+       FROM metabib.title_field_entry\r
+       WHERE field = 6;\r
+</programlisting>\r
                                </step>\r
                                <step> \r
                                        <para>Bump the relevance when the first search term appears first in the title in a keyword search.</para>\r
                                        <para>17 = our new keyword|title index (This may be different in your database so you may need to check the \r
-                                       <link linkend="config.metabib_field">config.metabib_field</link> for the id \r
+                                       <link linkend="config.table.metabib-field">config.metabib_field</link> for the id \r
                                        of your new index).</para>\r
-                                       <programlisting>\r
-                                       INSERT INTO search.relevance_adjustment \r
-                                               (active, field, bump_type, multiplier)\r
-                                       VALUES (true, 17, 'first_word', 5); \r
-                                       </programlisting>\r
+<programlisting>\r
+INSERT INTO search.relevance_adjustment \r
+       (active, field, bump_type, multiplier)\r
+VALUES (true, 17, 'first_word', 5); \r
+</programlisting>\r
                                </step>\r
                                <step>\r
                                        <para>Boost the relevance for search terms appearing in the title in general</para>\r
                                        <para>17 = our new keyword|title index (This may be different in your database so you may need to check the \r
-                                       <link linkend="config.metabib_field">config.metabib_field</link> for the id \r
+                                       <link linkend="config.table.metabib-field">config.metabib_field</link> for the id \r
                                        of your new index).</para>\r
-                                       <programlisting>\r
-                                       UPDATE config.metabib_field\r
-                                       SET weight = 10\r
-                                       WHERE id = 17;\r
-                                       </programlisting>\r
+<programlisting>\r
+UPDATE config.metabib_field\r
+SET weight = 10\r
+WHERE id = 17;\r
+</programlisting>\r
                                </step>\r
                        </procedure>  \r
                </simplesect> \r
index 1fde5ab..69f21ba 100644 (file)
@@ -369,7 +369,7 @@ Escape character is '^]'.
                                </tbody>\r
                        </tgroup>\r
                </informaltable>\r
-               <simplesect xml:id="SIP_block_patron">\r
+               <simplesect xml:id="SIP_Block_Patron">\r
                        <title>01 Block Patron</title>\r
                        <para>A selfcheck will issue a <command>Block Patron</command> command if a patron leaves their card in a selfcheck machine or if the selfcheck detects tampering (such as attempts \r
                        to disable multiple items during a single item checkout, multiple failed pin entries, etc).</para><indexterm><primary>SelfCheck</primary></indexterm>\r
@@ -493,7 +493,7 @@ Escape character is '^]'.
                        <title>25/26 Patron Enable</title>\r
                        <para>Not yet supported.</para>\r
                </simplesect>\r
-               <simplesect xml:id="sip_Renew">\r
+               <simplesect xml:id="SIP_Renew">\r
                        <title>29/30 Renew</title>\r
                        <para>Evergreen ACS status message indicates <emphasis>renew</emphasis> is supported.</para>\r
                </simplesect>\r
index 99b46c6..b354d99 100644 (file)
@@ -184,10 +184,10 @@ srfsh#</screen>
                        <para>or</para>\r
                        <screen>apache2ctl start</screen>\r
                        <para>You should see output:</para>\r
-                       <screen>\r
-                       * Starting web server apache2\r
-                       ...done.\r
-                       </screen>\r
+<screen>\r
+* Starting web server apache2\r
+...done.\r
+</screen>\r
                        <para>the Apache OpenSRF modules write to the \r
                        <filename>/openils/var/log/gateway.log</filename></para><indexterm><primary>logs</primary><secondary>gateway.log</secondary></indexterm>\r
                        <para>However, you should check all of the log files for errors:</para>\r
index 0048152..17c54e2 100644 (file)
@@ -352,9 +352,6 @@ __PACKAGE__-&gt;register_method(
                        </calloutlist>\r
                        <simpara>Once you have defined the new service, you must restart the OpenSRF Router\r
                        to retrieve the new configuration and start or restart the service itself.</simpara>\r
-                       <simpara>Complete working examples of the <link linkend="opensrf-core-xml">opensrf_core.xml</link> and\r
-                       <link linkend="opensrf-xml">opensrf.xml</link> configuration files are included with this article\r
-                       for your reference.</simpara>\r
                </simplesect>\r
                <simplesect id="_calling_an_opensrf_method">\r
                        <title>Calling an OpenSRF method</title>\r
index 6e10a9a..c99c137 100644 (file)
 \r
          <informalfigure>\r
             <para><guilabel>Fast Item Add</guilabel> is another "sticky" check box that makes it\r
-               possible to add volume and item records from the MARC editor (see <link\r
-                  linkend="import-fast-item-add">here</link> for details).</para>\r
+               possible to add volume and item records from the MARC editor.</para>\r
 \r
 \r
            <para> <mediaobject>\r