More semantic clean up and indexing.
authorRobert Soulliere <rsoulliere@libdog.mohawkcollege.ca>
Mon, 13 Sep 2010 19:50:14 +0000 (15:50 -0400)
committerRobert Soulliere <rsoulliere@libdog.mohawkcollege.ca>
Mon, 13 Sep 2010 19:50:14 +0000 (15:50 -0400)
1.6/admin/serveradministration.xml

index 454d1b2..a6908aa 100644 (file)
@@ -4,9 +4,9 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
        <info>\r
                <title>Server Administration</title>\r
                <abstract>\r
-                       <para>Administration of Evergreen involves configuration done from both the Staff Client as well a \r
+                       <para>Administration of <application>Evergreen</application> involves configuration done from both the Staff Client as well a \r
                        the command line. The goal of this chapter is to provide you with the procedures to help \r
-                       you optimize your Evergreen system.</para>\r
+                       you optimize your <application>Evergreen</application> system.</para>\r
                </abstract>\r
        </info>\r
        <section xml:id="orgunitsandtypes">\r
@@ -58,7 +58,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
                        </procedure>\r
                        <procedure>\r
                                <title>Deleting Organization Types<indexterm><primary>organization types</primary><secondary>deleting</secondary></indexterm></title>\r
-                               <step><para>Select the <emphasis>organization type</emphasis> from the <emphasis>Organization Type</emphasis\r
+                               <step><para>Select the <guilabel>organization type</guilabel> from the <guilabel>Organization Type</guilabel\r
                                tree.</para></step>\r
                                <step><para>Click <guibutton>Delete</guibutton>.</para></step>\r
                                <step><para>Click <guibutton>OK</guibutton> on the warning alert box.</para></step>\r
@@ -71,7 +71,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
                        </procedure>\r
                        <procedure>\r
                                <title>Editing Organization Types<indexterm><primary>organization types</primary><secondary>editing</secondary></indexterm></title>\r
-                               <step><para>Select the <emphasis>organization type</emphasis> you wish to edit from the \r
+                               <step><para>Select the <guilabel>organization type</guilabel> you wish to edit from the \r
                                organization type tree.</para></step>\r
                                <step><para>Make the changes in the right pane.</para></step>\r
                                <step><para>Click <guibutton>Save</guibutton> to save your changes.</para></step>\r
@@ -95,7 +95,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
                </para>\r
                <procedure>\r
                        <title>Adding Organizational Units<indexterm><primary>organization units</primary><secondary>adding</secondary></indexterm></title>\r
-                       <step><para>Select an <emphasis>Organizational Unit</emphasis> from the organizational unit tree on the left and click \r
+                       <step><para>Select an <guilabel>Organizational Unit</guilabel> from the organizational unit tree on the left and click \r
                        <guibutton>New Child</guibutton>.</para></step>\r
                        <step><para>Make sure your new unit is selected and edit the <guilabel>Organizational Unit \r
                        Name</guilabel>, <guilabel>Organizational Unit Policy Code</guilabel>, \r
@@ -1607,7 +1607,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
                                <step><para>Click <guibutton>Add</guibutton>.</para></step>\r
                                <step><para>Locate you new status and check the <emphasis>Holdable</emphasis> check box \r
                                if you wish to all users to place holds on items in this status. Check \r
-                               <emphasis>OPAC Visible</emphasis> if you wish for this status to appear in the public \r
+                               <guilabel>OPAC Visible</guilabel> if you wish for this status to appear in the public \r
                                OPAC.</para></step>\r
                                <step><para>Click <guibutton>Save Changes</guibutton> at the bottom of the screen to \r
                                save changes to the new status.</para></step>\r
@@ -1626,7 +1626,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
                                <title>Editing Copy Statuses</title>\r
                                <step><para>Double click on a status name to change its name and enter the new \r
                                name.</para> <para>To change whether a status is visible in the OPAC, check or uncheck \r
-                               the <emphasis>OPAC Visible</emphasis> check box.</para><para>To allow patrons the ability to \r
+                               the <guilabel>OPAC Visible</guilabel> check box.</para><para>To allow patrons the ability to \r
                                hold items in that status, check the <emphasis>Holdable</emphasis> check box. To prevent \r
                                users from holding items in that status, uncheck the <emphasis>Holdable</emphasis> \r
                                check box. </para></step>\r
@@ -1644,8 +1644,8 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
                                <title>Adding Billing Types</title>\r
                                <step><para>Click <guibutton>New Billing Type</guibutton>.</para></step>\r
                                <step><para>Enter the name of the billing type.</para></step>\r
-                               <step><para>Select the <emphasis>Org Unit</emphasis> to use this billing type.</para></step>\r
-                               <step><para>Enter the <emphasis>Default Price</emphasis>. This is only the default since \r
+                               <step><para>Select the <guilabel>Org Unit</guilabel> to use this billing type.</para></step>\r
+                               <step><para>Enter the <guilabel>Default Price</guilabel>. This is only the default since \r
                                the actual price of a specific billing can be adjusted when staff create \r
                                a billing</para></step>\r
                                <step><para>Click <guibutton>Save</guibutton> to save the new billing type.</para></step>\r
@@ -1661,8 +1661,8 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
                        <procedure>\r
                                <title>Editing Billing Types</title>\r
                                <step><para>Double click on a billing types to open the editing window.</para></step> \r
-                               <step><para>Make desired changes to the <emphasis>name</emphasis>, \r
-                               <emphasis>Org Unit</emphasis> and <emphasis>Default Price</emphasis>.</para></step>\r
+                               <step><para>Make desired changes to the <guilabel>name</guilabel>, \r
+                               <guilabel>Org Unit</guilabel> and <guilabel>Default Price</guilabel>.</para></step>\r
                                <step><para>Once you have finished editing, click \r
                                <guibutton>Save</guibutton>.</para></step>      \r
                        </procedure>\r
@@ -1680,9 +1680,9 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
                        <procedure>\r
                                <title>Adding Circulation Modifiers</title>\r
                                <step><para>Click <guibutton>New Circ Modifier</guibutton>.</para></step>\r
-                               <step><para>Enter a <emphasis>Code</emphasis>, <emphasis>Name</emphasis> and  \r
-                               <emphasis>Description</emphasis>.</para></step>\r
-                               <step><para>Select the <emphasis>SIP 2 Media Type</emphasis>.</para></step>\r
+                               <step><para>Enter a <guilabel>Code</guilabel>, <guilabel>Name</guilabel> and  \r
+                               <guilabel>Description</guilabel>.</para></step>\r
+                               <step><para>Select the <guilabel>SIP 2 Media Type</guilabel>.</para></step>\r
                                <step><para>Check the <guibutton>Magnetic Media</guibutton> check box if the item is magnetic media such as a cassette \r
                                tape.</para></step>\r
                                <step><para>Click <guibutton>Save</guibutton> to save the new circulation \r
@@ -1714,24 +1714,65 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
                        <step>\r
                                <para>                          \r
                                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_video.xml</filename>: \r
+                               Here is an example file <filename>k_book.xml</filename>: \r
                                </para>\r
-                        <para>\r
-                               <mediaobject xml:id="cattemplate">\r
-                                       <alt>Catalog Template Example</alt>\r
-                                       <imageobject>\r
-                                               <imagedata scalefit="0" fileref="../media/k_book_record.png"/>\r
-                                       </imageobject>\r
-                               </mediaobject>\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
        \r
                        </step>\r
                        <step>\r
-                       <para>Add the template to the to the <emphasis>marctemplates</emphasis> list in the open-ils.cat section of the evergreen configuration file <filename>opensrf.xml</filename> </para>\r
+                       <para>Add the template to the to the <emphasis>marctemplates</emphasis> list in the open-ils.cat section of the Evergreen configuration file \r
+                       <filename>opensrf.xml</filename><indexterm><primary>configuration files</primary><secondary>opensrf.xml</secondary></indexterm></para>\r
                        </step>\r
                        <step>\r
-                               <para>Restart perl services for changes to take effect.</para>\r
-                               <screen>/openils/bin/osrf_ctl.sh -l -a restart_perl</screen>\r
+                               <para>Restart <systemitem class="service">Perl</systemitem></application><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
                        </step>\r
                </procedure>\r
        </section>\r
@@ -1751,10 +1792,10 @@ 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 config.metabib_field table, which follows the other four columns in this table:\r
+                       of the <link linkend="config.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 config.metabib_field table:</para>\r
-                       <para> author | conference | //mods32:mods/mods32:name[@type='conference']/mods32:namePart[../mods32:role/mods32:roleTerm[text()='creator']] | mods32 | 1 ) </para>\r
+                       <para>The following is one representative line from the <link linkend="config.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
                        indexed field. The weight value may be increased or decreased by whole integers. </para>\r
@@ -1769,7 +1810,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
                        and is configured through floating-point multipliers in the multiplier column of the\r
                        search.relevance_adjustment table.</para>\r
                        <para> Weighting can be adjusted for one, more, or all multiplier fields in\r
-                       search.relevance_adjustment.</para>\r
+                       <link linkend="search.relevance_adjustment">search.relevance_adjustment</link>.</para>\r
                        <para>You can adjust the following three matchpoints:</para> \r
                        <itemizedlist>\r
                        <listitem>\r
@@ -1960,12 +2001,12 @@ 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
-                       config.metabib_field table. The following procedure will add a keyword|title index so that terms found in the title field of an item are given more weight than terms i\r
-                       other fields. </para>\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 a\r
+                       item are given more weight than terms in other fields. </para>\r
                        <procedure>\r
                                <step>\r
                                        <para>From the command line, access the PostgreSQL command line interface</para>\r
-                                       <screen>psql -U evergreen</screen>\r
+                                       <screen><userinput>psql -U evergreen</userinput></screen>\r
                                </step> \r
                                <step>\r
                                        <para>Clone the title|proper index to create a keyword|title index</para>\r
@@ -1985,14 +2026,15 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
                                        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
-                                               <emphasis>config.metabib_field</emphasis> for the id of your new index).\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
                                </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 <emphasis>config.metabib_field</emphasis> for the id \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
                                        of your new index).</para>\r
                                        <programlisting>\r
                                        INSERT INTO search.relevance_adjustment \r
@@ -2002,7 +2044,8 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
                                </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 <emphasis>config.metabib_field</emphasis> for the id \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
                                        of your new index).</para>\r
                                        <programlisting>\r
                                        UPDATE config.metabib_field\r