+++ /dev/null
-<?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
- <section xml:id="usingsupercat">>\r
- <title>Using SuperCat</title> \r
- <indexterm><primary>SuperCat</primary></indexterm>\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
- <indexterm><primary>SuperCat</primary><secondary>ISBNs</secondary></indexterm>\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://<hostname>/opac/extras/osibn/<ISBN></uri></para>\r
- <para>For example, <uri>http://dev.gapines.org/opac/extras/oisbn/0439136350</uri> returns:</para>\r
-<screen>\r
-<idlist metarecord="302670">\r
-<isbn record="250060">0790783525</isbn>\r
-<isbn record="20717">0736691316</isbn>\r
-<isbn record="250045">0790783517</isbn>\r
-<isbn record="199060">9500421151</isbn>\r
-<isbn record="250061">0790783495</isbn>\r
-<isbn record="154477">0807286028</isbn>\r
-<isbn record="227297">1594130027</isbn>\r
-<isbn record="26682">0786222743</isbn>\r
-<isbn record="17179">0807282316</isbn>\r
-<isbn record="34885">0807282316</isbn>\r
-<isbn record="118019">8478885196</isbn>\r
-<isbn record="1231">0738301477</isbn>\r
-</idlist>\r
-</screen>\r
- </simplesect>\r
- <simplesect>\r
- <title>Return records</title>\r
- <indexterm><primary>SuperCat</primary><secondary>records</secondary></indexterm>\r
- <para>SuperCat can return records and metarecords in many different formats (see <xref linkend='supportedsupercatformats' /></para>\r
- <para><uri>http://<hostname>/opac/extras/supercat/retrieve/<format>/<record-type>/<bib-ID></uri></para>\r
- <para>For example, <uri>http://dev.gapines.org/opac/extras/supercat/retrieve/mods/record/555</uri> returns:</para>\r
-<screen>\r
-<mods:modsCollection version="3.0">\r
- <mods:mods xsi:schemaLocation="http://www.loc.gov/mods/ http://www.loc.gov/standards/mods/mods.xsd">\r
- <titleInfo>\r
- <title>More Brer Rabbit stories /</title>\r
- </titleInfo>\r
- <typeOfResource>text</typeOfResource>\r
- <originInfo>\r
- <place>\r
- <code authority="marc">xx</c0de>\r
- </place>\r
- <publisher>Award Publications</publisher>\r
- <dateIssued>c1982, 1983</dateIssued>\r
- <dateIssued encoding="marc" point="start">1983</dateIssued>\r
- <dateIssued encoding="marc" point="end">1982</dateIssued>\r
- <issuance>monographic</issuance>\r
- </originInfo>\r
- <language authority="iso639-2b">eng</language>\r
- <physicalDescription>\r
- <form authority="marcform">print</form>\r
- <extent>unp. : col. ill.</extent>\r
- </physicalDescription>\r
- <note type="statement of responsibility">ill. by Rene Cloke.</note>\r
- <subject authority="lcsh">\r
- <topic>Animals</topic>\r
- <topic>Fiction</topic>\r
- </subject>\r
- <subject authority="lcsh">\r
- <topic>Fables</topic>\r
- </subject>\r
- <recordInfo>\r
- <recordContentSource>(BRO)</recordContentSource>\r
- <recordCreationDate encoding="marc">930903</recordCreationDate>\r
- <recordChangeDate encoding="iso8601">19990703024637.0</recordChangeDate>\r
- <recordIdentifier>PIN60000007 </recordIdentifier>\r
- </recordInfo>\r
- </mods:mods>\r
-</mods:modsCollection>\r
-</screen>\r
- </simplesect>\r
- <simplesect>\r
- <title>Return a feed of recently edited or created records</title>\r
- <indexterm><primary>SuperCat</primary><secondary>recent records</secondary></indexterm>\r
- <para>SuperCat can return feeds of recently edited or created authority and bibliographic records:</para>\r
- <para><uri>http://<hostname>/opac/extras/feed/freshmeat/<feed-type>/[authority|biblio]/[import|edit]/<limit>/<date></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://<hostname>/opac/extras/supercat/browse/<format>/call_number/<org_unit>/<call_number></uri></para>\r
- <para>For example, <uri>http://dev.gapines.org/opac/extras/browse/xml/call_number/-/GV</uri> returns:</para>\r
-<screen>\r
-<hold:volumes xmlns:hold='http://open-ils.org/spec/holdings/v1'>\r
- <hold:volume id="tag:open-ils.org,2008:asset-call_number/130607" lib="FRRLS-FA" label="GUTCHEON BETH">\r
- <act:owning_lib id="tag:open-ils.org,2008:actor-org_unit/111" name="Fayette County Public Library"/>\r
- <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">\r
- <leader>09319pam a2200961 a 4500</leader>\r
- <controlfield tag="001"/>\r
- <controlfield tag="005">20000302124754.0</controlfield>\r
- <controlfield tag="008">990817s2000 nyu 000 1 eng </controlfield>\r
- <datafield tag="010" ind1=" " ind2=" ">\r
- <subfield code="a"> 99045936</subfield>\r
- </datafield>\r
- ..\r
- </record>\r
- <record>\r
- ..\r
- </record>\r
- </hold:volume>\r
-</hold:volumes> \r
-</screen>\r
- </simplesect>\r
- <simplesect xml:id="supportedsupercatformats">\r
- <title>Supported formats</title>\r
- <indexterm><primary>SuperCat</primary><secondary>formats</secondary></indexterm>\r
- <para>SuperCat maintains a list of supported formats for records and metarecords:</para>\r
- <para><uri>http://<hostname>/opac/extras/supercat/formats/<record-type></uri></para>\r
- <para>For example, <uri>http://dev.gapines.org/opac/extras/supercat/formats/record</uri> returns:</para>\r
-<screen>\r
-<formats>\r
- <format>\r
- <name>opac</name>\r
- <type>text/html</type>\r
- </format>\r
- <format>\r
- <name>htmlholdings</name>\r
- <type>text/html</type>\r
- </format>\r
-...\r
-</screen>\r
- </simplesect>\r
- </section>\r
- <section xml:id="addingsupercatformats">\r
- <title>Adding new SuperCat Formats</title>\r
- <indexterm><primary>SuperCat</primary><secondary>formats</secondary><tertiary>adding</tertiary></indexterm>\r
- <para>Adding SuperCat formats requires experience editing XSL files and familiarity with XML and Perl.</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> 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
- <indexterm><primary>SuperCat</primary><secondary>formats</secondary><tertiary>customizing</tertiary></indexterm> \r
- <para>Editing SuperCat formats requires experience editing XSL files and familiarity with XML..</para> \r
- <para>It is possible to customize existing supercat formats using XSL stylesheets. You are 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
projects / Evergreen-DocBook.git / blobdiff