1 <?xml version="1.0" encoding="utf-8"?>
\r
2 <chapter xml:id="supercat" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="EN"
\r
3 xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">
\r
5 <title>SuperCat</title>
\r
7 <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
9 <listitem>isbn</listitem>
\r
10 <listitem>metarecord</listitem>
\r
11 <listitem>record</listitem>
\r
14 <title>Return a list of ISBNs for related records</title>
\r
15 <para>Similar to the OCLC xISBN service, Evergreen can return a list of related records based on its oISBN algorithm:</para>
\r
16 <screen>http://<hostname>/opac/extras/osibn/<ISBN></screen>
\r
17 <para>For example, http://dev.gapines.org/opac/extras/oisbn/0439136350 returns:</para>
\r
19 <idlist metarecord="302670">
\r
20 <isbn record="250060">0790783525</isbn>
\r
21 <isbn record="20717">0736691316</isbn>
\r
22 <isbn record="250045">0790783517</isbn>
\r
23 <isbn record="199060">9500421151</isbn>
\r
24 <isbn record="250061">0790783495</isbn>
\r
25 <isbn record="154477">0807286028</isbn>
\r
26 <isbn record="227297">1594130027</isbn>
\r
27 <isbn record="26682">0786222743</isbn>
\r
28 <isbn record="17179">0807282316</isbn>
\r
29 <isbn record="34885">0807282316</isbn>
\r
30 <isbn record="118019">8478885196</isbn>
\r
31 <isbn record="1231">0738301477</isbn>
\r
36 <title>Return records</title>
\r
37 <para>SuperCat can return records and metarecords in many different formats (see <xref linkend='supportedsupercatformats' /></para>
\r
38 <screen>http://<hostname>/opac/extras/supercat/retrieve/<format>/<record-type>/<bib-ID></screen>
\r
39 <para>For example, http://dev.gapines.org/opac/extras/supercat/retrieve/mods/record/555 returns:</para>
\r
41 <mods:modsCollection version="3.0">
\r
42 <mods:mods xsi:schemaLocation="http://www.loc.gov/mods/ http://www.loc.gov/standards/mods/mods.xsd">
\r
44 <title>More Brer Rabbit stories /</title>
\r
46 <typeOfResource>text</typeOfResource>
\r
49 <code authority="marc">xx</c0de>
\r
51 <publisher>Award Publications</publisher>
\r
52 <dateIssued>c1982, 1983</dateIssued>
\r
53 <dateIssued encoding="marc" point="start">1983</dateIssued>
\r
54 <dateIssued encoding="marc" point="end">1982</dateIssued>
\r
55 <issuance>monographic</issuance>
\r
57 <language authority="iso639-2b">eng</language>
\r
58 <physicalDescription>
\r
59 <form authority="marcform">print</form>
\r
60 <extent>unp. : col. ill.</extent>
\r
61 </physicalDescription>
\r
62 <note type="statement of responsibility">ill. by Rene Cloke.</note>
\r
63 <subject authority="lcsh">
\r
64 <topic>Animals</topic>
\r
65 <topic>Fiction</topic>
\r
67 <subject authority="lcsh">
\r
68 <topic>Fables</topic>
\r
71 <recordContentSource>(BRO)</recordContentSource>
\r
72 <recordCreationDate encoding="marc">930903</recordCreationDate>
\r
73 <recordChangeDate encoding="iso8601">19990703024637.0</recordChangeDate>
\r
74 <recordIdentifier>PIN60000007 </recordIdentifier>
\r
77 </mods:modsCollection>
\r
81 <title>Return a feed of recently edited or created records</title>
\r
82 <para>SuperCat can return feeds of recently edited or created authority and bibliographic records:</para>
\r
83 <screen>http://<hostname>/opac/extras/feed/freshmeat/<feed-type>/[authority|biblio]/[import|edit]/<limit>/<date></screen>
\r
84 <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
85 <para>If you do not supply a limit, then up to 10 records will be returned.</para>
\r
86 <para>Feed-type can be one of atom, html, htmlholdings, marcxml, mods, mods3, or rss2.</para>
\r
87 <para>For example, http://dev.gapines.org/opac/extras/feed/freshmeat/atom/biblio/import/10/2008-01-01</para>
\r
90 <title>Browse records</title>
\r
91 <para>SuperCat can browse records in HTML and XML formats:</para>
\r
92 <screen>http://<hostname>/opac/extras/supercat/browse/<format>/call_number/<org_unit>/<call_number></screen>
\r
93 <para>For example, http://dev.gapines.org/opac/extras/browse/xml/call_number/-/GV returns:</para>
\r
95 <hold:volumes xmlns:hold='http://open-ils.org/spec/holdings/v1'>
\r
96 <hold:volume id="tag:open-ils.org,2008:asset-call_number/130607" lib="FRRLS-FA" label="GUTCHEON BETH">
\r
97 <act:owning_lib id="tag:open-ils.org,2008:actor-org_unit/111" name="Fayette County Public Library"/>
\r
98 <record xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/
\r
99 standards/marcxml/schema/MARC21slim.xsd"
\r
100 id="tag:open-ils.org,2008:biblio-record_entry/21669/FRRLS-FA">
\r
101 <leader>09319pam a2200961 a 4500</leader>
\r
102 <controlfield tag="001"/>
\r
103 <controlfield tag="005">20000302124754.0</controlfield>
\r
104 <controlfield tag="008">990817s2000 nyu 000 1 eng </controlfield>
\r
105 <datafield tag="010" ind1=" " ind2=" ">
\r
106 <subfield code="a"> 99045936</subfield>
\r
113 </hold:volume>
\r
114 </hold:volumes>
\r
117 <simplesect xml:id="supportedsupercatformats">
\r
118 <title>Supported formats</title>
\r
119 <para>SuperCat maintains a list of supported formats for records and metarecords:</para>
\r
120 <screen>http://<hostname>/opac/extras/supercat/formats/<record-type></screen>
\r
121 <para>For example, http://dev.gapines.org/opac/extras/supercat/formats/record returns:</para>
\r
126 <name>opac</name>
\r
127 <type>text/html</type>
\r
131 <name>htmlholdings</name>
\r
132 <type>text/html</type>
\r
136 <name>html</name>
\r
137 <type>text/html</type>
\r
141 <name>htmlholdings-full</name>
\r
142 <type>text/html</type>
\r
146 <name>html-full</name>
\r
147 <type>text/html</type>
\r
151 <name>marcxml</name>
\r
152 <type>application/xml</type>
\r
153 <namespace_uri>http://www.loc.gov/MARC21/slim</namespace_uri>
\r
154 <docs>http://www.loc.gov/marcxml/</docs>
\r
156 <schema_location>
\r
157 http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd
\r
158 </schema_location>
\r
162 <name>marcxml-full</name>
\r
163 <type>application/xml</type>
\r
164 <namespace_uri>http://www.loc.gov/MARC21/slim</namespace_uri>
\r
165 <docs>http://www.loc.gov/marcxml/</docs>
\r
167 <schema_location>
\r
168 http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd
\r
169 </schema_location>
\r
173 <name>rss2</name>
\r
174 <type>application/xml</type>
\r
178 <name>rss2-full</name>
\r
179 <type>application/xml</type>
\r
183 <name>rdf_dc</name>
\r
184 <type>application/xml</type>
\r
185 <namespace_uri>http://purl.org/dc/elements/1.1/</namespace_uri>
\r
186 <schema_location>http://purl.org/dc/elements/1.1/</schema_location>
\r
190 <name>oai_dc</name>
\r
191 <type>application/xml</type>
\r
192 <namespace_uri>http://www.openarchives.org/OAI/2.0/oai_dc/</namespace_uri>
\r
193 <schema_location>http://www.openarchives.org/OAI/2.0/oai_dc.xsd</schema_location>
\r
197 <name>srw_dc</name>
\r
198 <type>application/xml</type>
\r
199 <namespace_uri>info:srw/schema/1/dc-schema</namespace_uri>
\r
201 <schema_location>
\r
202 http://www.loc.gov/z3950/agency/zing/srw/dc-schema.xsd
\r
203 </schema_location>
\r
207 <name>mods32</name>
\r
208 <type>application/xml</type>
\r
209 <namespace_uri>http://www.loc.gov/mods/v3</namespace_uri>
\r
210 <docs>http://www.loc.gov/mods/</docs>
\r
211 <schema_location>http://www.loc.gov/standards/mods/v3/mods-3-2.xsd</schema_location>
\r
215 <name>mods3</name>
\r
216 <type>application/xml</type>
\r
217 <namespace_uri>http://www.loc.gov/mods/v3</namespace_uri>
\r
218 <docs>http://www.loc.gov/mods/</docs>
\r
219 <schema_location>http://www.loc.gov/standards/mods/v3/mods-3-1.xsd</schema_location>
\r
223 <name>mods3-full</name>
\r
224 <type>application/xml</type>
\r
225 <namespace_uri>http://www.loc.gov/mods/v3</namespace_uri>
\r
226 <docs>http://www.loc.gov/mods/</docs>
\r
227 <schema_location>http://www.loc.gov/standards/mods/v3/mods-3-1.xsd</schema_location>
\r
231 <name>mods</name>
\r
232 <type>application/xml</type>
\r
233 <namespace_uri>http://www.loc.gov/mods/</namespace_uri>
\r
234 <docs>http://www.loc.gov/mods/</docs>
\r
235 <schema_location>http://www.loc.gov/standards/mods/mods.xsd</schema_location>
\r
239 <name>mods-full</name>
\r
240 <type>application/xml</type>
\r
241 <namespace_uri>http://www.loc.gov/mods/</namespace_uri>
\r
242 <docs>http://www.loc.gov/mods/</docs>
\r
243 <schema_location>http://www.loc.gov/standards/mods/mods.xsd</schema_location>
\r
247 <name>atom</name>
\r
248 <type>application/xml</type>
\r
249 <namespace_uri>http://www.w3.org/2005/Atom</namespace_uri>
\r
250 <docs>http://www.ietf.org/rfc/rfc4287.txt</docs>
\r
254 <name>atom-full</name>
\r
255 <type>application/xml</type>
\r
256 <namespace_uri>http://www.w3.org/2005/Atom</namespace_uri>
\r
257 <docs>http://www.ietf.org/rfc/rfc4287.txt</docs>
\r
263 <title>Adding new SuperCat formats</title>
\r
264 <para>SuperCat web services are based on the OpenSRF application, <emphasis>open-ils.supercat</emphasis>.</para>
\r
265 <para>Developers are able to add new formats by adding the <emphasis>xsl</emphasis>
\r
266 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
267 <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
268 required for the new format to be activated.</para>
\r
269 <tip><para>Use an existing xsl stylesheet and perm module entry as a guide for your new format.</para></tip>
\r