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 <section xml:id="usingsupercat">>
\r
8 <title>Using SuperCat</title>
\r
9 <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
12 <listitem>isbn</listitem>
\r
13 <listitem>metarecord</listitem>
\r
14 <listitem>record</listitem>
\r
17 <title>Return a list of ISBNs for related records</title>
\r
18 <para>Similar to the OCLC xISBN service, Evergreen can return a list of related records based on its oISBN algorithm:</para>
\r
19 <para><uri>http://<hostname>/opac/extras/osibn/<ISBN></uri></para>
\r
20 <para>For example, <uri>http://dev.gapines.org/opac/extras/oisbn/0439136350</uri> returns:</para>
\r
22 <idlist metarecord="302670">
\r
23 <isbn record="250060">0790783525</isbn>
\r
24 <isbn record="20717">0736691316</isbn>
\r
25 <isbn record="250045">0790783517</isbn>
\r
26 <isbn record="199060">9500421151</isbn>
\r
27 <isbn record="250061">0790783495</isbn>
\r
28 <isbn record="154477">0807286028</isbn>
\r
29 <isbn record="227297">1594130027</isbn>
\r
30 <isbn record="26682">0786222743</isbn>
\r
31 <isbn record="17179">0807282316</isbn>
\r
32 <isbn record="34885">0807282316</isbn>
\r
33 <isbn record="118019">8478885196</isbn>
\r
34 <isbn record="1231">0738301477</isbn>
\r
39 <title>Return records</title>
\r
40 <para>SuperCat can return records and metarecords in many different formats (see <xref linkend='supportedsupercatformats' /></para>
\r
41 <para><uri>http://<hostname>/opac/extras/supercat/retrieve/<format>/<record-type>/<bib-ID></uri></para>
\r
42 <para>For example, <uri>http://dev.gapines.org/opac/extras/supercat/retrieve/mods/record/555</uri> returns:</para>
\r
44 <mods:modsCollection version="3.0">
\r
45 <mods:mods xsi:schemaLocation="http://www.loc.gov/mods/ http://www.loc.gov/standards/mods/mods.xsd">
\r
47 <title>More Brer Rabbit stories /</title>
\r
49 <typeOfResource>text</typeOfResource>
\r
52 <code authority="marc">xx</c0de>
\r
54 <publisher>Award Publications</publisher>
\r
55 <dateIssued>c1982, 1983</dateIssued>
\r
56 <dateIssued encoding="marc" point="start">1983</dateIssued>
\r
57 <dateIssued encoding="marc" point="end">1982</dateIssued>
\r
58 <issuance>monographic</issuance>
\r
60 <language authority="iso639-2b">eng</language>
\r
61 <physicalDescription>
\r
62 <form authority="marcform">print</form>
\r
63 <extent>unp. : col. ill.</extent>
\r
64 </physicalDescription>
\r
65 <note type="statement of responsibility">ill. by Rene Cloke.</note>
\r
66 <subject authority="lcsh">
\r
67 <topic>Animals</topic>
\r
68 <topic>Fiction</topic>
\r
70 <subject authority="lcsh">
\r
71 <topic>Fables</topic>
\r
74 <recordContentSource>(BRO)</recordContentSource>
\r
75 <recordCreationDate encoding="marc">930903</recordCreationDate>
\r
76 <recordChangeDate encoding="iso8601">19990703024637.0</recordChangeDate>
\r
77 <recordIdentifier>PIN60000007 </recordIdentifier>
\r
80 </mods:modsCollection>
\r
84 <title>Return a feed of recently edited or created records</title>
\r
85 <para>SuperCat can return feeds of recently edited or created authority and bibliographic records:</para>
\r
86 <para><uri>http://<hostname>/opac/extras/feed/freshmeat/<feed-type>/[authority|biblio]/[import|edit]/<limit>/<date></uri></para>
\r
87 <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
88 <para>If you do not supply a limit, then up to 10 records will be returned.</para>
\r
89 <para>Feed-type can be one of atom, html, htmlholdings, marcxml, mods, mods3, or rss2.</para>
\r
90 <para><uri>For example, http://dev.gapines.org/opac/extras/feed/freshmeat/atom/biblio/import/10/2008-01-01</uri></para>
\r
93 <title>Browse records</title>
\r
94 <para>SuperCat can browse records in HTML and XML formats:</para>
\r
95 <para><uri>http://<hostname>/opac/extras/supercat/browse/<format>/call_number/<org_unit>/<call_number></uri></para>
\r
96 <para>For example, <uri>http://dev.gapines.org/opac/extras/browse/xml/call_number/-/GV</uri> returns:</para>
\r
98 <hold:volumes xmlns:hold='http://open-ils.org/spec/holdings/v1'>
\r
99 <hold:volume id="tag:open-ils.org,2008:asset-call_number/130607" lib="FRRLS-FA" label="GUTCHEON BETH">
\r
100 <act:owning_lib id="tag:open-ils.org,2008:actor-org_unit/111" name="Fayette County Public Library"/>
\r
101 <record xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/
\r
102 standards/marcxml/schema/MARC21slim.xsd"
\r
103 id="tag:open-ils.org,2008:biblio-record_entry/21669/FRRLS-FA">
\r
104 <leader>09319pam a2200961 a 4500</leader>
\r
105 <controlfield tag="001"/>
\r
106 <controlfield tag="005">20000302124754.0</controlfield>
\r
107 <controlfield tag="008">990817s2000 nyu 000 1 eng </controlfield>
\r
108 <datafield tag="010" ind1=" " ind2=" ">
\r
109 <subfield code="a"> 99045936</subfield>
\r
116 </hold:volume>
\r
117 </hold:volumes>
\r
120 <simplesect xml:id="supportedsupercatformats">
\r
121 <title>Supported formats</title>
\r
122 <para>SuperCat maintains a list of supported formats for records and metarecords:</para>
\r
123 <para><uri>http://<hostname>/opac/extras/supercat/formats/<record-type></uri></para>
\r
124 <para>For example, <uri>http://dev.gapines.org/opac/extras/supercat/formats/record</uri> returns:</para>
\r
129 <name>opac</name>
\r
130 <type>text/html</type>
\r
134 <name>htmlholdings</name>
\r
135 <type>text/html</type>
\r
139 <name>html</name>
\r
140 <type>text/html</type>
\r
144 <name>htmlholdings-full</name>
\r
145 <type>text/html</type>
\r
149 <name>html-full</name>
\r
150 <type>text/html</type>
\r
154 <name>marcxml</name>
\r
155 <type>application/xml</type>
\r
156 <namespace_uri>http://www.loc.gov/MARC21/slim</namespace_uri>
\r
157 <docs>http://www.loc.gov/marcxml/</docs>
\r
159 <schema_location>
\r
160 http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd
\r
161 </schema_location>
\r
165 <name>marcxml-full</name>
\r
166 <type>application/xml</type>
\r
167 <namespace_uri>http://www.loc.gov/MARC21/slim</namespace_uri>
\r
168 <docs>http://www.loc.gov/marcxml/</docs>
\r
170 <schema_location>
\r
171 http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd
\r
172 </schema_location>
\r
176 <name>rss2</name>
\r
177 <type>application/xml</type>
\r
181 <name>rss2-full</name>
\r
182 <type>application/xml</type>
\r
186 <name>rdf_dc</name>
\r
187 <type>application/xml</type>
\r
188 <namespace_uri>http://purl.org/dc/elements/1.1/</namespace_uri>
\r
189 <schema_location>http://purl.org/dc/elements/1.1/</schema_location>
\r
193 <name>oai_dc</name>
\r
194 <type>application/xml</type>
\r
195 <namespace_uri>http://www.openarchives.org/OAI/2.0/oai_dc/</namespace_uri>
\r
196 <schema_location>http://www.openarchives.org/OAI/2.0/oai_dc.xsd</schema_location>
\r
200 <name>srw_dc</name>
\r
201 <type>application/xml</type>
\r
202 <namespace_uri>info:srw/schema/1/dc-schema</namespace_uri>
\r
204 <schema_location>
\r
205 http://www.loc.gov/z3950/agency/zing/srw/dc-schema.xsd
\r
206 </schema_location>
\r
210 <name>mods32</name>
\r
211 <type>application/xml</type>
\r
212 <namespace_uri>http://www.loc.gov/mods/v3</namespace_uri>
\r
213 <docs>http://www.loc.gov/mods/</docs>
\r
214 <schema_location>http://www.loc.gov/standards/mods/v3/mods-3-2.xsd</schema_location>
\r
218 <name>mods3</name>
\r
219 <type>application/xml</type>
\r
220 <namespace_uri>http://www.loc.gov/mods/v3</namespace_uri>
\r
221 <docs>http://www.loc.gov/mods/</docs>
\r
222 <schema_location>http://www.loc.gov/standards/mods/v3/mods-3-1.xsd</schema_location>
\r
226 <name>mods3-full</name>
\r
227 <type>application/xml</type>
\r
228 <namespace_uri>http://www.loc.gov/mods/v3</namespace_uri>
\r
229 <docs>http://www.loc.gov/mods/</docs>
\r
230 <schema_location>http://www.loc.gov/standards/mods/v3/mods-3-1.xsd</schema_location>
\r
234 <name>mods</name>
\r
235 <type>application/xml</type>
\r
236 <namespace_uri>http://www.loc.gov/mods/</namespace_uri>
\r
237 <docs>http://www.loc.gov/mods/</docs>
\r
238 <schema_location>http://www.loc.gov/standards/mods/mods.xsd</schema_location>
\r
242 <name>mods-full</name>
\r
243 <type>application/xml</type>
\r
244 <namespace_uri>http://www.loc.gov/mods/</namespace_uri>
\r
245 <docs>http://www.loc.gov/mods/</docs>
\r
246 <schema_location>http://www.loc.gov/standards/mods/mods.xsd</schema_location>
\r
250 <name>atom</name>
\r
251 <type>application/xml</type>
\r
252 <namespace_uri>http://www.w3.org/2005/Atom</namespace_uri>
\r
253 <docs>http://www.ietf.org/rfc/rfc4287.txt</docs>
\r
257 <name>atom-full</name>
\r
258 <type>application/xml</type>
\r
259 <namespace_uri>http://www.w3.org/2005/Atom</namespace_uri>
\r
260 <docs>http://www.ietf.org/rfc/rfc4287.txt</docs>
\r
266 <section xml:id="addingsupercatformats">
\r
267 <title>Adding new SuperCat Formats</title>
\r
268 <para>Adding SuperCat formats requires experience editing XSL files and familiarity with XML and Perl.</para>
\r
269 <para>SuperCat web services are based on the OpenSRF service, <systemitem class="service">>open-ils.supercat</systemitem>.</para>
\r
270 <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
271 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
272 required for the feed to be activated.</para>
\r
273 <tip><para>Use an existing xsl stylesheet and Perl module entry as a template for your new format.</para></tip>
\r
275 <section xml:id="editingsupercatformats">
\r
276 <title>Customizing SuperCat Formats</title>
\r
277 <para>Editing SuperCat formats requires experience editing XSL files and familiarity with XML..</para>
\r
278 <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
279 <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
280 <filename class="directory">/openils/var/xsl/</filename>. </para>
\r