Add supercat editing info.

diff --git a/1.6/development/customize_opac.xml b/1.6/development/customize_opac.xml
index 42771de..2498f12 100644 (file)
--- a/1.6/development/customize_opac.xml
+++ b/1.6/development/customize_opac.xml
@@ -288,10 +288,15 @@ name='Default' csstype='color'/>
                        <title>Customizing the Slimpac Results Display</title>\r
                        <para>Two files control the display results for the slimpac. Edit the XSL stylesheet (<filename>/openils/var/xsl/ATOM2XHTML.xsl</filename>) to edit the elements of the \r
                        record as pulled from the XML output. \r
-                       You may also change the style of the page by editing the CSS stylesheet for the results display (<filename>/openils/var/web/opac/extras/os.css</filename>). To edit the \r
-                       holdings display which contains the details of the specific record linked from the results display, edit the CSS stylesheet for the holdings/details page \r
-                       (<filename>/openils/var/web/opac/extras/htmlcard.css</filename>). You may also control the holdings content by editing <filename>MARC21slim2HTMLCard.xsl</filename>. \r
+                       You may also change the style of the page by editing the CSS stylesheet for the results display (<filename>/openils/var/web/opac/extras/os.css</filename>).</para> \r
+               </simplesect>\r
+               <simplesect>\r
+                       <title>Customizing the Slimpac Details/Holdings Display</title> \r
+                       <para>It is also possible to customize the details page when viewing specific items from the results list. To edit the holdings display which contains the details of the specific \r
+                       record linked from the results display, edit the CSS stylesheet for the holdings/details page \r
+                       (<filename>/openils/var/web/opac/extras/htmlcard.css</filename>). You may also control the content of the record by editing <filename>MARC21slim2HTMLCard.xsl</filename>. \r
                        Holdings data may also be controlled by editing <filename>MARC21slim2HTMLCard-holdings.xsl</filename>.</para>     \r
+               </simplesect>\r
        </section>\r
        <section xml:id="integratingsearchforms">\r
                <title>Integrating a Evergreen Search Form on a Web Page</title>\r

diff --git a/1.6/development/supercat.xml b/1.6/development/supercat.xml
index b3edff0..8018a7b 100644 (file)
--- a/1.6/development/supercat.xml
+++ b/1.6/development/supercat.xml
@@ -4,17 +4,20 @@
        <info>\r
                <title>SuperCat</title>\r
        </info>\r
-       <para>SuperCat allows Evergreen record and information retrieval from a web browser using a based on a number of open web standards and formats. The following record types are supported:</para>\r
-       <itemizedlist>\r
-               <listitem>isbn</listitem>\r
-               <listitem>metarecord</listitem>\r
-               <listitem>record</listitem>\r
-       </itemizedlist>\r
-       <simplesect>\r
-               <title>Return a list of ISBNs for related records</title>\r
-               <para>Similar to the OCLC xISBN service, Evergreen can return a list of related records based on its oISBN algorithm:</para>\r
-               <para><uri>http://&lt;hostname&gt;/opac/extras/osibn/&lt;ISBN&gt;</uri></para>\r
-               <para>For example, <uri>http://dev.gapines.org/opac/extras/oisbn/0439136350</uri> returns:</para>\r
+       <section xml:id="usingsupercat">>\r
+               <title>Using SuperCat</title> \r
+               <para>SuperCat allows Evergreen record and information retrieval from a web browser using a based on a number of open web standards and formats. The following record types are \r
+               supported:</para>\r
+               <itemizedlist>\r
+                       <listitem>isbn</listitem>\r
+                       <listitem>metarecord</listitem>\r
+                       <listitem>record</listitem>\r
+               </itemizedlist>\r
+               <simplesect>\r
+                       <title>Return a list of ISBNs for related records</title>\r
+                       <para>Similar to the OCLC xISBN service, Evergreen can return a list of related records based on its oISBN algorithm:</para>\r
+                       <para><uri>http://&lt;hostname&gt;/opac/extras/osibn/&lt;ISBN&gt;</uri></para>\r
+                       <para>For example, <uri>http://dev.gapines.org/opac/extras/oisbn/0439136350</uri> returns:</para>\r
 <screen>\r
 &lt;idlist metarecord="302670"&gt;\r
 &lt;isbn record="250060"&gt;0790783525&lt;/isbn&gt;\r
@@ -31,12 +34,12 @@
 &lt;isbn record="1231"&gt;0738301477&lt;/isbn&gt;\r
 &lt;/idlist&gt;\r
 </screen>\r
-        </simplesect>\r
-        <simplesect>\r
-               <title>Return records</title>\r
-               <para>SuperCat can return records and metarecords in many different formats (see <xref linkend='supportedsupercatformats' /></para>\r
-               <para><uri>http://&lt;hostname&gt;/opac/extras/supercat/retrieve/&lt;format&gt;/&lt;record-type&gt;/&lt;bib-ID&gt;</uri></para>\r
-               <para>For example, <uri>http://dev.gapines.org/opac/extras/supercat/retrieve/mods/record/555</uri> returns:</para>\r
+                </simplesect>\r
+                <simplesect>\r
+                       <title>Return records</title>\r
+                       <para>SuperCat can return records and metarecords in many different formats (see <xref linkend='supportedsupercatformats' /></para>\r
+                       <para><uri>http://&lt;hostname&gt;/opac/extras/supercat/retrieve/&lt;format&gt;/&lt;record-type&gt;/&lt;bib-ID&gt;</uri></para>\r
+                       <para>For example, <uri>http://dev.gapines.org/opac/extras/supercat/retrieve/mods/record/555</uri> returns:</para>\r
 <screen>\r
 &lt;mods:modsCollection version="3.0"&gt;\r
        &lt;mods:mods xsi:schemaLocation="http://www.loc.gov/mods/ http://www.loc.gov/standards/mods/mods.xsd"&gt;\r
@@ -76,21 +79,21 @@
        &lt;/mods:mods&gt;\r
 &lt;/mods:modsCollection&gt;\r
 </screen>\r
-        </simplesect>\r
-        <simplesect>\r
-               <title>Return a feed of recently edited or created records</title>\r
-               <para>SuperCat can return feeds of recently edited or created authority and bibliographic records:</para>\r
-               <para><uri>http://&lt;hostname&gt;/opac/extras/feed/freshmeat/&lt;feed-type&gt;/[authority|biblio]/[import|edit]/&lt;limit&gt;/&lt;date&gt;</uri></para>\r
-               <para>The limit records imported or edited following the supplied date will be returned. If you do not supply a date, then the most recent limit records will be returned.</para>\r
-               <para>If you do not supply a limit, then up to 10 records will be returned.</para>      \r
-               <para>Feed-type can be one of atom, html, htmlholdings, marcxml, mods, mods3, or rss2.</para>           \r
-               <para><uri>For example, http://dev.gapines.org/opac/extras/feed/freshmeat/atom/biblio/import/10/2008-01-01</uri></para>\r
-       </simplesect>\r
-        <simplesect>\r
-               <title>Browse records</title>\r
-               <para>SuperCat can browse records in HTML and XML formats:</para>\r
-               <para><uri>http://&lt;hostname&gt;/opac/extras/supercat/browse/&lt;format&gt;/call_number/&lt;org_unit&gt;/&lt;call_number&gt;</uri></para>\r
-               <para>For example, <uri>http://dev.gapines.org/opac/extras/browse/xml/call_number/-/GV</uri> returns:</para>\r
+                </simplesect>\r
+                <simplesect>\r
+                       <title>Return a feed of recently edited or created records</title>\r
+                       <para>SuperCat can return feeds of recently edited or created authority and bibliographic records:</para>\r
+                       <para><uri>http://&lt;hostname&gt;/opac/extras/feed/freshmeat/&lt;feed-type&gt;/[authority|biblio]/[import|edit]/&lt;limit&gt;/&lt;date&gt;</uri></para>\r
+                       <para>The limit records imported or edited following the supplied date will be returned. If you do not supply a date, then the most recent limit records will be returned.</para>\r
+                       <para>If you do not supply a limit, then up to 10 records will be returned.</para>      \r
+                       <para>Feed-type can be one of atom, html, htmlholdings, marcxml, mods, mods3, or rss2.</para>           \r
+                       <para><uri>For example, http://dev.gapines.org/opac/extras/feed/freshmeat/atom/biblio/import/10/2008-01-01</uri></para>\r
+               </simplesect>\r
+                <simplesect>\r
+                       <title>Browse records</title>\r
+                       <para>SuperCat can browse records in HTML and XML formats:</para>\r
+                       <para><uri>http://&lt;hostname&gt;/opac/extras/supercat/browse/&lt;format&gt;/call_number/&lt;org_unit&gt;/&lt;call_number&gt;</uri></para>\r
+                       <para>For example, <uri>http://dev.gapines.org/opac/extras/browse/xml/call_number/-/GV</uri> returns:</para>\r
 <screen>\r
 &lt;hold:volumes xmlns:hold='http://open-ils.org/spec/holdings/v1'&gt;\r
        &lt;hold:volume id="tag:open-ils.org,2008:asset-call_number/130607" lib="FRRLS-FA" label="GUTCHEON BETH"&gt;\r
@@ -113,12 +116,12 @@
        &lt;/hold:volume&gt;\r
 &lt;/hold:volumes&gt;  \r
 </screen>\r
-       </simplesect>\r
-        <simplesect xml:id="supportedsupercatformats">\r
-               <title>Supported formats</title>\r
-               <para>SuperCat maintains a list of supported formats for records and metarecords:</para>\r
-               <para><uri>http://&lt;hostname&gt;/opac/extras/supercat/formats/&lt;record-type&gt;</uri></para>\r
-               <para>For example, <uri>http://dev.gapines.org/opac/extras/supercat/formats/record</uri> returns:</para>\r
+               </simplesect>\r
+                <simplesect xml:id="supportedsupercatformats">\r
+                       <title>Supported formats</title>\r
+                       <para>SuperCat maintains a list of supported formats for records and metarecords:</para>\r
+                       <para><uri>http://&lt;hostname&gt;/opac/extras/supercat/formats/&lt;record-type&gt;</uri></para>\r
+                       <para>For example, <uri>http://dev.gapines.org/opac/extras/supercat/formats/record</uri> returns:</para>\r
 <screen>\r
 &lt;formats&gt;\r
 \r
@@ -258,15 +261,24 @@
   &lt;/format&gt;\r
 &lt;/formats&gt;\r
 </screen>\r
-       </simplesect>\r
-       <simplesect>\r
-               <title>Adding new SuperCat formats</title>      \r
+               </simplesect>\r
+       </section>\r
+       <section xml:id="addingsupercatformats">\r
+               <title>Adding new SuperCat Formats</title>\r
+               <para>Adding SuperCat formats requires experience editing XSL files and familiarity with XML and Perl.</systemitem>.</para>     \r
                <para>SuperCat web services are based on the OpenSRF service, <systemitem class="service">>open-ils.supercat</systemitem>.</para> \r
                <para>Developers are able to add new formats by adding the <emphasis>xsl</emphasis> \r
-               stylesheet for the format in the directory<filename class="directory">/openils/var/web/opac/extras/xsl/</filename>, and by adding the feed references to the perl modules \r
-               <filename>openils/lib/perl5/OpenILS/WWW/SuperCat/feed.pm</filename> and <filename>openils/lib/perl5/OpenILS/WWW/SuperCat.pm</filename>. An Evergreen restart is \r
-               required for the new format to be activated.</para>\r
-               <tip><para>Use an existing xsl stylesheet and perm module entry as a guide for your new format.</para></tip>\r
-       </simplesect>\r
+               stylesheet for the format. By default, the location of the stylesheets is <filename class="directory">/openils/var/xsl/</filename>. You must also add the feed  to the perl \r
+               modules <filename>openils/lib/perl5/OpenILS/WWW/SuperCat/feed.pm</filename> and <filename>openils/lib/perl5/OpenILS/WWW/SuperCat.pm</filename>. An Evergreen restart is \r
+               required for the feed to be activated.</para>\r
+               <tip><para>Use an existing xsl stylesheet and Perl module entry as a template for your new format.</para></tip>\r
+       </section>\r
+       <section xml:id="editingsupercatformats">\r
+               <title>Customizing SuperCat Formats</title>     \r
+               <para>Editing SuperCat formats requires experience editing XSL files and familiarity with XML.</systemitem>.</para>     \r
+               <para>It is possible to customize existing supercat formats using XSL stylesheets. You arwe able to change the content to be displayed and the design of the pages.</para> \r
+               <para>In order to change the display of a specific format, edit the corresponding XSL file(s) for the particular format. The default location for the XSL stylesheets is \r
+               <filename class="directory">/openils/var/xsl/</filename>. </para>\r
+       </section>\r
 </chapter>\r
 \r