Add sections on integragred search forms and customizing Slimpac.

diff --git a/1.6/development/customize_opac.xml b/1.6/development/customize_opac.xml
index 3daf236..1a6669b 100644 (file)
--- a/1.6/development/customize_opac.xml
+++ b/1.6/development/customize_opac.xml
@@ -6,7 +6,7 @@
        </info>\r
        <para>While Evergreen is ready to go out of the box, libraries will want to customize Evergreen with their own color scheme, logos and layout. This chapter will explain how to \r
        customize Evergreen to meet the needs of your users. For these task some knowledge of <systemitem>html</systemitem> and <systemitem>css</systemitem> is required. Many of these \r
-       instructions assume aninstallation of Evergreen using the default file locations.</para>\r
+       instructions assume an installation of Evergreen using the default file locations.</para>\r
        <note>\r
                <para>Be sure to save a backup copy of all files you edit in a location other than <filename class="directory">/openils/var/web/opac/</filename> as files here could be \r
                overwritten when you upgrade your copy of Evergreen.</para>\r
@@ -68,7 +68,7 @@ name='Default' csstype='color'/&gt;
 &lt;div id='copyright_text'&gt;\r
 &lt;span&gt;&amp;footer.copyright;&lt;/span&gt;\r
 </programlisting>\r
-               <para>The included <filename>opac.dtd</filename> file in the en-US locale direcotry has this setting for &amp;footer.copyright text:</para>  \r
+               <para>The included <filename>opac.dtd</filename> file in the en-US locale directory has this setting for &amp;footer.copyright text:</para>  \r
                <programlisting>&lt;!ENTITY footer.copyright "Copyright &#xA9; 2006-2010 Georgia Public Library Service, and others"&gt;</programlisting>\r
        </section>\r
        <section xml:id="Logo_Images">\r
@@ -82,11 +82,11 @@ name='Default' csstype='color'/&gt;
        <section xml:id="AddedContent">\r
                <title>Added Content</title>\r
                <para>By default Evergreen includes customizable <quote>Added Content</quote> features to enhance the OPAC experience for your user. These features include Amazon book covers \r
-               and Google books searching. These features can be turned off or custimized.</para>\r
+               and Google books searching. These features can be turned off or customized.</para>\r
                <simplesect xml:id="bookcovers">\r
                        <title>Book Covers</title>\r
                        <para>The default install of Evergreen includes Amazon book covers. The settings for this are controlled by the &lt;added_content&gt; section of \r
-                       <filename>/opneils/conf/opensrf.xml</filename>. Here are the key elements of this configuration:</para> \r
+                       <filename>/openils/conf/opensrf.xml</filename>. Here are the key elements of this configuration:</para> \r
                        <programlisting>&lt;module&gt;OpenILS::WWW::AddedContent::Amazon&lt;/module&gt;</programlisting>\r
                        <para>This calls the Amazon perl module. If you wish to link to a different book cover service other than Amazon, you must create a new perl module and refer to it here. \r
                        You will also need to change other settings accordingly. There are some available book cover perl modules available in  \r
@@ -118,8 +118,8 @@ name='Default' csstype='color'/&gt;
                experienced web developers.</para>\r
                <para>There are several critical files to edit if you wish to  customize the results page:</para>\r
                <itemizedlist>\r
-                       <listitem><filename>/openils/var/web/opac/skin/default/js/result_common.js</filename> - This file controls the javascript for the top level elements on the results \r
-                       page and should only be edited by experienced web developers except for the <link linkend='googlebookslink'>google books link setting</link> mentioned perviously.</listitem>\r
+                       <listitem><filename>/openils/var/web/opac/skin/default/js/result_common.js</filename> - This file controls the JavaScript for the top level elements on the results \r
+                       page and should only be edited by experienced web developers except for the <link linkend='googlebookslink'>Google books link setting</link> mentioned previously.</listitem>\r
                        <listitem><filename>/openils/var/web/opac/skin/default/js/rresult.js</filename> - Has some good controls of results page settings at the top of this file but \r
                        requires web development skills for editing this file.</listitem>\r
                        <listitem><filename>/openils/var/web/opac/skin/default/xml/result/rresult_table.xml</filename> - This controls the layout of the items table on results page.</listitem>\r
@@ -130,13 +130,13 @@ name='Default' csstype='color'/&gt;
                <para>There are many options when customizing the details page in Evergreen. The default settings are effective for most libraries, but it is important to understand the full potential \r
                of Evergreen when displaying the details of items.</para>               \r
                <para>Some quick features can be turned on and off by changing variable values in the file <filename>/openils/var/web/opac/skin/default/js/rdedail.js</filename>. \r
-               You will notice the section at the top of this file called <quote>Per-skin configuration settings</quote>. Changing setting in this section can control several features includuing \r
+               You will notice the section at the top of this file called <quote>Per-skin configuration settings</quote>. Changing setting in this section can control several features including \r
                limiting results to local only or showing copy location or displaying serial holdings. Form this section you can also enable refworks and set the Refworks host URL.</para>\r
                <para>Some copy level details settings can be turned on and off from <filename>/openils/var/web/opac/skin/default/js/copy_details.js</filename> including displaying certain fields \r
                such as due date in the OPAC.</para>\r
                <para>An important file is the <filename>/openils/var/web/opac/skin/default/xml/rdetail/rdetail_summary.xml</filename> file. This file allows you to control which field to display in \r
-               the details summary of the record. The new <link linkend='googlebookslink'>BibTemnplate</link> feature makes this file even more powerful by allowing you to display any marc fields \r
-               with a variey of formatting options.</para>\r
+               the details summary of the record. The new <link linkend='BibTemplate'>BibTemplate</link> feature makes this file even more powerful by allowing you to display any marc fields \r
+               with a variety of formatting options.</para>\r
                <para>The <filename>/openils/var/web/opac/skin/default/xml/rdetail/rdetail_copyinfo.xml</filename> file allows you to format the display of the copy information.</para>   \r
        </section>              \r
        <section xml:id="BibTemplate">\r
@@ -146,7 +146,7 @@ name='Default' csstype='color'/&gt;
                <indexterm><primary>unAPI</primary></indexterm> <indexterm><primary>MARCXML</primary></indexterm><indexterm><primary>MODS</primary></indexterm>\r
                <para>Managing the display of information from raw XML can be difficult, and the purpose of BibTemplate  is to make this simpler, as well as move the display closer to the \r
                client and away from the source data. This is good from a separation-of-responsibilities perspective, and also makes it easier to contain and control local customization.</para>\r
-               <para>BibTemplate supports the foloowing Evergreen metadata formats:</para>\r
+               <para>BibTemplate supports the following Evergreen meta data formats:</para>\r
                <itemizedlist>\r
                        <listitem>MARCXML - datatype='marcxml-full' (default)</listitem>                                        \r
                        <listitem>MODS 3.3: datatype='mods33'</listitem>\r
@@ -276,5 +276,36 @@ name='Default' csstype='color'/&gt;
 </programlisting>\r
                </simplesect>\r
        </section>\r
+       <section xml:id="customizingslimpac">\r
+               <title>Customizing the Slimpac</title>\r
+               <para>The Slimpac is the an alternative OPAC display for browsers or devices without JavaScript or which may have screen size limitations. There is both a simple and advanced search \r
+               option for the Slimpac.</para> \r
+               <para>The html files for customizing the Slimpac search display are located in the folder <filename class="directory">/openils/var/web/opac/extras/slimpac</filename>.</para>\r
+               <para><filename>start.html</filename> is the basic search display and <filename>advanced.html</filename> is the display for the advanced search option in the Slimpac.</para>  \r
+               <para>By default, the Slimpac files include the same locale dtd as the regular OPAC (<filename>opac.dtd</filename>). However the slimpac files do not use the same CSS files as the \r
+               regular OPAC which means that if you change the OPAC color scheme for the OPAC, you must also change the Slimpac colors.</para>\r
+       </section>\r
+       <section xml:id="integratingsearchforms">\r
+               <title>Integrating a Evergreen Search Form on a Web Page</title>\r
+               <para>It is possible to embed a simple search form into an html page which will allow users to search for materials in your Evergreen catalog. Here is code which can be embedded \r
+               anywhere in the body of your web page:</para> \r
+<programlisting language="html"><![CDATA[\r
+<form action="http://[domain name]/opac/[locale]/skin/default/xml/rresult.xml" method="get">\r
+<div>\r
+        Quick Catalog Search:<br />\r
+        <input type="text" alt="Input Box for Catalog Search" maxlength="250" size="20" id="t" name="t" value=""  />\r
+        <input type="hidden" id="rt" name="rt" value="keyword" />\r
+        <input type="hidden" id="tp" name="tp" value="keyword" />\r
+        <input type="hidden" id="l" name="l" value="2" />\r
+        <input type="hidden" id="d" name="d" value="" />\r
+        <input type="hidden" id="f" name="f" value="" />\r
+        <input type="submit" value="Search" class="form-submit"  />\r
+    </div>\r
+</form>\r
+]]>\r
+</programlisting>\r
+               <para> Replace <emphasis>[domain name]</emphasis> with the domain name of your Evergreen server and replace <emphasis>[locale]</emphasis> with the desired locale of \r
+               your Evergreen instance (e.g. en-US). This does a basic keyword search. Different types of searches and more advanced search forms can be developed. For further information on the url parameters used by Evergreen, see <xref linkend="search_url" /> for more details.</para> \r
+       </section>\r
 </chapter>\r
 \r