Add documentation files for supercat and stafftasks intro. Edit search_URL.xml

diff --git a/1.6/development/supercat.xml b/1.6/development/supercat.xml
new file mode 100644 (file)
index 0000000..18ed504
--- /dev/null
+++ b/1.6/development/supercat.xml
@@ -0,0 +1,272 @@
+<?xml version="1.0" encoding="utf-8"?>\r
+<chapter xml:id="supercat" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="EN"\r
+    xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">\r
+       <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
+               <screen>http://&lt;hostname&gt;/opac/extras/osibn/&lt;ISBN&gt;</screen>\r
+               <para>For example, http://dev.gapines.org/opac/extras/oisbn/0439136350 returns:</para>\r
+               <programlisting>\r
+               &lt;idlist metarecord="302670"&gt;\r
+               &lt;isbn record="250060"&gt;0790783525&lt;/isbn&gt;\r
+               &lt;isbn record="20717"&gt;0736691316&lt;/isbn&gt;\r
+               &lt;isbn record="250045"&gt;0790783517&lt;/isbn&gt;\r
+               &lt;isbn record="199060"&gt;9500421151&lt;/isbn&gt;\r
+               &lt;isbn record="250061"&gt;0790783495&lt;/isbn&gt;\r
+               &lt;isbn record="154477"&gt;0807286028&lt;/isbn&gt;\r
+               &lt;isbn record="227297"&gt;1594130027&lt;/isbn&gt;\r
+               &lt;isbn record="26682"&gt;0786222743&lt;/isbn&gt;\r
+               &lt;isbn record="17179"&gt;0807282316&lt;/isbn&gt;\r
+               &lt;isbn record="34885"&gt;0807282316&lt;/isbn&gt;\r
+               &lt;isbn record="118019"&gt;8478885196&lt;/isbn&gt;\r
+               &lt;isbn record="1231"&gt;0738301477&lt;/isbn&gt;\r
+               &lt;/idlist&gt;\r
+               </programlisting>\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
+               <screen>http://&lt;hostname&gt;/opac/extras/supercat/retrieve/&lt;format&gt;/&lt;record-type&gt;/&lt;bib-ID&gt;</screen>\r
+               <para>For example, http://dev.gapines.org/opac/extras/supercat/retrieve/mods/record/555 returns:</para>\r
+               <programlisting>\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
+                               &lt;titleInfo&gt;\r
+                                       &lt;title&gt;More Brer Rabbit stories /&lt;/title&gt;\r
+                               &lt;/titleInfo&gt;\r
+                               &lt;typeOfResource&gt;text&lt;/typeOfResource&gt;\r
+                               &lt;originInfo&gt;\r
+                                       &lt;place&gt;\r
+                                               &lt;code authority="marc"&gt;xx&lt;/c0de&gt;\r
+                                       &lt;/place&gt;\r
+                                       &lt;publisher&gt;Award Publications&lt;/publisher&gt;\r
+                                       &lt;dateIssued&gt;c1982, 1983&lt;/dateIssued&gt;\r
+                                       &lt;dateIssued encoding="marc" point="start"&gt;1983&lt;/dateIssued&gt;\r
+                                       &lt;dateIssued encoding="marc" point="end"&gt;1982&lt;/dateIssued&gt;\r
+                                       &lt;issuance&gt;monographic&lt;/issuance&gt;\r
+                                       &lt;/originInfo&gt;\r
+                               &lt;language authority="iso639-2b"&gt;eng&lt;/language&gt;\r
+                               &lt;physicalDescription&gt;\r
+                                       &lt;form authority="marcform"&gt;print&lt;/form&gt;\r
+                                       &lt;extent&gt;unp. : col. ill.&lt;/extent&gt;\r
+                               &lt;/physicalDescription&gt;\r
+                               &lt;note type="statement of responsibility"&gt;ill. by Rene Cloke.&lt;/note&gt;\r
+                               &lt;subject authority="lcsh"&gt;\r
+                                       &lt;topic&gt;Animals&lt;/topic&gt;\r
+                                       &lt;topic&gt;Fiction&lt;/topic&gt;\r
+                               &lt;/subject&gt;\r
+                               &lt;subject authority="lcsh"&gt;\r
+                                       &lt;topic&gt;Fables&lt;/topic&gt;\r
+                               &lt;/subject&gt;\r
+                               &lt;recordInfo&gt;\r
+                                       &lt;recordContentSource&gt;(BRO)&lt;/recordContentSource&gt;\r
+                                       &lt;recordCreationDate encoding="marc"&gt;930903&lt;/recordCreationDate&gt;\r
+                                       &lt;recordChangeDate encoding="iso8601"&gt;19990703024637.0&lt;/recordChangeDate&gt;\r
+                                       &lt;recordIdentifier&gt;PIN60000007 &lt;/recordIdentifier&gt;\r
+                               &lt;/recordInfo&gt;\r
+                       &lt;/mods:mods&gt;\r
+               &lt;/mods:modsCollection&gt;\r
+               </programlisting>\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
+               <screen>http://&lt;hostname&gt;/opac/extras/feed/freshmeat/&lt;feed-type&gt;/[authority|biblio]/[import|edit]/&lt;limit&gt;/&lt;date&gt;</screen>\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>For example, http://dev.gapines.org/opac/extras/feed/freshmeat/atom/biblio/import/10/2008-01-01</para>\r
+       </simplesect>\r
+        <simplesect>\r
+               <title>Browse records</title>\r
+               <para>SuperCat can browse records in HTML and XML formats:</para>\r
+               <screen>http://&lt;hostname&gt;/opac/extras/supercat/browse/&lt;format&gt;/call_number/&lt;org_unit&gt;/&lt;call_number&gt;</screen>\r
+               <para>For example, http://dev.gapines.org/opac/extras/browse/xml/call_number/-/GV returns:</para>\r
+               <programlisting>\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
+                               &lt;act:owning_lib id="tag:open-ils.org,2008:actor-org_unit/111" name="Fayette County Public Library"/&gt;\r
+                               &lt;record xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/ \r
+                                       standards/marcxml/schema/MARC21slim.xsd"\r
+                                       id="tag:open-ils.org,2008:biblio-record_entry/21669/FRRLS-FA"&gt;\r
+                                       &lt;leader&gt;09319pam a2200961 a 4500&lt;/leader&gt;\r
+                                       &lt;controlfield tag="001"/&gt;\r
+                                       &lt;controlfield tag="005"&gt;20000302124754.0&lt;/controlfield&gt;\r
+                                       &lt;controlfield tag="008"&gt;990817s2000    nyu           000 1 eng  &lt;/controlfield&gt;\r
+                                       &lt;datafield tag="010" ind1=" " ind2=" "&gt;\r
+                                               &lt;subfield code="a"&gt;   99045936&lt;/subfield&gt;\r
+                                       &lt;/datafield&gt;\r
+                                       ..\r
+                               &lt;/record&gt;\r
+                               &lt;record&gt;\r
+                                       ..\r
+                               &lt;/record&gt;\r
+                       &lt;/hold:volume&gt;\r
+               &lt;/hold:volumes&gt;   \r
+               </programlisting>\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
+               <screen>http://&lt;hostname&gt;/opac/extras/supercat/formats/&lt;record-type&gt;</screen>\r
+               <para>For example, http://dev.gapines.org/opac/extras/supercat/formats/record returns:</para>\r
+               <programlisting>\r
+               &lt;formats&gt;\r
+\r
+                 &lt;format&gt;\r
+                   &lt;name&gt;opac&lt;/name&gt;\r
+                   &lt;type&gt;text/html&lt;/type&gt;\r
+                 &lt;/format&gt;\r
+\r
+                 &lt;format&gt;\r
+                   &lt;name&gt;htmlholdings&lt;/name&gt;\r
+                   &lt;type&gt;text/html&lt;/type&gt;\r
+                 &lt;/format&gt;\r
+                \r
+                 &lt;format&gt;\r
+                   &lt;name&gt;html&lt;/name&gt;\r
+                   &lt;type&gt;text/html&lt;/type&gt;\r
+                 &lt;/format&gt;\r
+                \r
+                 &lt;format&gt;\r
+                   &lt;name&gt;htmlholdings-full&lt;/name&gt;\r
+                   &lt;type&gt;text/html&lt;/type&gt;\r
+                 &lt;/format&gt;\r
+                \r
+                 &lt;format&gt;\r
+                   &lt;name&gt;html-full&lt;/name&gt;\r
+                   &lt;type&gt;text/html&lt;/type&gt;\r
+                 &lt;/format&gt;\r
+                \r
+                 &lt;format&gt;\r
+                   &lt;name&gt;marcxml&lt;/name&gt;\r
+                   &lt;type&gt;application/xml&lt;/type&gt;\r
+                   &lt;namespace_uri&gt;http://www.loc.gov/MARC21/slim&lt;/namespace_uri&gt;\r
+                   &lt;docs&gt;http://www.loc.gov/marcxml/&lt;/docs&gt;\r
+                \r
+                   &lt;schema_location&gt;\r
+                   http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd\r
+                   &lt;/schema_location&gt;\r
+                 &lt;/format&gt;\r
+                \r
+                 &lt;format&gt;\r
+                   &lt;name&gt;marcxml-full&lt;/name&gt;\r
+                   &lt;type&gt;application/xml&lt;/type&gt;\r
+                   &lt;namespace_uri&gt;http://www.loc.gov/MARC21/slim&lt;/namespace_uri&gt;\r
+                   &lt;docs&gt;http://www.loc.gov/marcxml/&lt;/docs&gt;\r
+                \r
+                   &lt;schema_location&gt;\r
+                   http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd\r
+                   &lt;/schema_location&gt;\r
+                 &lt;/format&gt;\r
+                \r
+                 &lt;format&gt;\r
+                   &lt;name&gt;rss2&lt;/name&gt;\r
+                   &lt;type&gt;application/xml&lt;/type&gt;\r
+                 &lt;/format&gt;\r
+                \r
+                 &lt;format&gt;\r
+                   &lt;name&gt;rss2-full&lt;/name&gt;\r
+                   &lt;type&gt;application/xml&lt;/type&gt;\r
+                 &lt;/format&gt;\r
+                \r
+                 &lt;format&gt;\r
+                   &lt;name&gt;rdf_dc&lt;/name&gt;\r
+                   &lt;type&gt;application/xml&lt;/type&gt;\r
+                   &lt;namespace_uri&gt;http://purl.org/dc/elements/1.1/&lt;/namespace_uri&gt;\r
+                   &lt;schema_location&gt;http://purl.org/dc/elements/1.1/&lt;/schema_location&gt;\r
+                 &lt;/format&gt;\r
+                \r
+                 &lt;format&gt;\r
+                   &lt;name&gt;oai_dc&lt;/name&gt;\r
+                   &lt;type&gt;application/xml&lt;/type&gt;\r
+                   &lt;namespace_uri&gt;http://www.openarchives.org/OAI/2.0/oai_dc/&lt;/namespace_uri&gt;\r
+                   &lt;schema_location&gt;http://www.openarchives.org/OAI/2.0/oai_dc.xsd&lt;/schema_location&gt;\r
+                 &lt;/format&gt;\r
+                \r
+                 &lt;format&gt;\r
+                   &lt;name&gt;srw_dc&lt;/name&gt;\r
+                   &lt;type&gt;application/xml&lt;/type&gt;\r
+                   &lt;namespace_uri&gt;info:srw/schema/1/dc-schema&lt;/namespace_uri&gt;\r
+                \r
+                   &lt;schema_location&gt;\r
+                   http://www.loc.gov/z3950/agency/zing/srw/dc-schema.xsd\r
+                   &lt;/schema_location&gt;\r
+                 &lt;/format&gt;\r
+                \r
+                 &lt;format&gt;\r
+                   &lt;name&gt;mods32&lt;/name&gt;\r
+                   &lt;type&gt;application/xml&lt;/type&gt;\r
+                   &lt;namespace_uri&gt;http://www.loc.gov/mods/v3&lt;/namespace_uri&gt;\r
+                   &lt;docs&gt;http://www.loc.gov/mods/&lt;/docs&gt;\r
+                   &lt;schema_location&gt;http://www.loc.gov/standards/mods/v3/mods-3-2.xsd&lt;/schema_location&gt;\r
+                 &lt;/format&gt;\r
+                \r
+                 &lt;format&gt;\r
+                   &lt;name&gt;mods3&lt;/name&gt;\r
+                   &lt;type&gt;application/xml&lt;/type&gt;\r
+                   &lt;namespace_uri&gt;http://www.loc.gov/mods/v3&lt;/namespace_uri&gt;\r
+                   &lt;docs&gt;http://www.loc.gov/mods/&lt;/docs&gt;\r
+                   &lt;schema_location&gt;http://www.loc.gov/standards/mods/v3/mods-3-1.xsd&lt;/schema_location&gt;\r
+                 &lt;/format&gt;\r
+                \r
+                 &lt;format&gt;\r
+                   &lt;name&gt;mods3-full&lt;/name&gt;\r
+                   &lt;type&gt;application/xml&lt;/type&gt;\r
+                   &lt;namespace_uri&gt;http://www.loc.gov/mods/v3&lt;/namespace_uri&gt;\r
+                   &lt;docs&gt;http://www.loc.gov/mods/&lt;/docs&gt;\r
+                   &lt;schema_location&gt;http://www.loc.gov/standards/mods/v3/mods-3-1.xsd&lt;/schema_location&gt;\r
+                 &lt;/format&gt;\r
+                \r
+                 &lt;format&gt;\r
+                   &lt;name&gt;mods&lt;/name&gt;\r
+                   &lt;type&gt;application/xml&lt;/type&gt;\r
+                   &lt;namespace_uri&gt;http://www.loc.gov/mods/&lt;/namespace_uri&gt;\r
+                   &lt;docs&gt;http://www.loc.gov/mods/&lt;/docs&gt;\r
+                   &lt;schema_location&gt;http://www.loc.gov/standards/mods/mods.xsd&lt;/schema_location&gt;\r
+                 &lt;/format&gt;\r
+                \r
+                 &lt;format&gt;\r
+                   &lt;name&gt;mods-full&lt;/name&gt;\r
+                   &lt;type&gt;application/xml&lt;/type&gt;\r
+                   &lt;namespace_uri&gt;http://www.loc.gov/mods/&lt;/namespace_uri&gt;\r
+                   &lt;docs&gt;http://www.loc.gov/mods/&lt;/docs&gt;\r
+                   &lt;schema_location&gt;http://www.loc.gov/standards/mods/mods.xsd&lt;/schema_location&gt;\r
+                 &lt;/format&gt;\r
+                \r
+                 &lt;format&gt;\r
+                   &lt;name&gt;atom&lt;/name&gt;\r
+                   &lt;type&gt;application/xml&lt;/type&gt;\r
+                   &lt;namespace_uri&gt;http://www.w3.org/2005/Atom&lt;/namespace_uri&gt;\r
+                   &lt;docs&gt;http://www.ietf.org/rfc/rfc4287.txt&lt;/docs&gt;\r
+                 &lt;/format&gt;\r
+                \r
+                 &lt;format&gt;\r
+                   &lt;name&gt;atom-full&lt;/name&gt;\r
+                   &lt;type&gt;application/xml&lt;/type&gt;\r
+                   &lt;namespace_uri&gt;http://www.w3.org/2005/Atom&lt;/namespace_uri&gt;\r
+                   &lt;docs&gt;http://www.ietf.org/rfc/rfc4287.txt&lt;/docs&gt;\r
+                 &lt;/format&gt;\r
+               &lt;/formats&gt;\r
+               </programlisting>\r
+       </simplesect>\r
+       <simplesect>\r
+               <title>Adding new SuperCat formats</title>      \r
+               <para>SuperCat web services are based on the OpenSRF application, <emphasis>open-ils.supercat</emphasis>.</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
+</chapter>\r
+\r

diff --git a/1.6/opac/search_URL.xml b/1.6/opac/search_URL.xml
index 220042e..3b7b48d 100644 (file)
--- a/1.6/opac/search_URL.xml
+++ b/1.6/opac/search_URL.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>\r
-<chapter xml:id="notices" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="EN"\r
+<chapter xml:id="search_url" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="EN"\r
     xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">\r
        <info>\r
                <title>Search URL</title>\r

diff --git a/1.6/root.xml b/1.6/root.xml
index 8dde994..4565741 100755 (executable)
--- a/1.6/root.xml
+++ b/1.6/root.xml
@@ -57,6 +57,7 @@
                <info>\r
                        <title>Core Staff Tasks</title>\r
                </info>\r
+               <xi:include href="stafftasks/stafftasks_intro.xml"/>\r
                <xi:include href="stafftasks/staffclient.xml"/>\r
                <xi:include href="stafftasks/circulation.xml"/>\r
                <xi:include href="stafftasks/cataloging.xml"/>\r
@@ -106,6 +107,7 @@
                <xi:include href="development/OpenSRF_intro.xml"/>\r
                <xi:include href="development/datamodelsandaccess.xml"/>\r
                <xi:include href="development/introduction_to_sql.xml"/>\r
+               <xi:include href="development/supercat.xml"/>\r
        </part>\r
        <part xml:id="Appendices">\r
                <info>\r

diff --git a/1.6/stafftasks/stafftasks_intro.xml b/1.6/stafftasks/stafftasks_intro.xml
new file mode 100644 (file)
index 0000000..4f6e262
--- /dev/null
+++ b/1.6/stafftasks/stafftasks_intro.xml
@@ -0,0 +1,3 @@
+<partintro xmlns:xl="http://www.w3.org/1999/xlink" xml:id="stafftasks_intro">\r
+       <para>This part of the documentation covers a broad range of the common tasks carried out by your library and includes tasks performed by circulation staff and catalogers among others. Some of these procedures should only be performed by Local System Administrators, but most of these sections will give all staff a better understanding of the Evergreen system and its features.</para>\r
+</partintro>\r