From 75860582874e2afd641edaf2ae6c0ba6147b2734 Mon Sep 17 00:00:00 2001 From: Robert Soulliere Date: Wed, 25 Aug 2010 11:43:32 -0400 Subject: [PATCH] Add documentation files for supercat and stafftasks intro. Edit search_URL.xml --- 1.6/development/supercat.xml | 272 ++++++++++++++++++++++++++++++++++++ 1.6/opac/search_URL.xml | 2 +- 1.6/root.xml | 2 + 1.6/stafftasks/stafftasks_intro.xml | 3 + 4 files changed, 278 insertions(+), 1 deletion(-) create mode 100644 1.6/development/supercat.xml create mode 100644 1.6/stafftasks/stafftasks_intro.xml diff --git a/1.6/development/supercat.xml b/1.6/development/supercat.xml new file mode 100644 index 0000000000..18ed504971 --- /dev/null +++ b/1.6/development/supercat.xml @@ -0,0 +1,272 @@ + + + + SuperCat + + 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: + + isbn + metarecord + record + + + Return a list of ISBNs for related records + Similar to the OCLC xISBN service, Evergreen can return a list of related records based on its oISBN algorithm: + http://<hostname>/opac/extras/osibn/<ISBN> + For example, http://dev.gapines.org/opac/extras/oisbn/0439136350 returns: + + <idlist metarecord="302670"> + <isbn record="250060">0790783525</isbn> + <isbn record="20717">0736691316</isbn> + <isbn record="250045">0790783517</isbn> + <isbn record="199060">9500421151</isbn> + <isbn record="250061">0790783495</isbn> + <isbn record="154477">0807286028</isbn> + <isbn record="227297">1594130027</isbn> + <isbn record="26682">0786222743</isbn> + <isbn record="17179">0807282316</isbn> + <isbn record="34885">0807282316</isbn> + <isbn record="118019">8478885196</isbn> + <isbn record="1231">0738301477</isbn> + </idlist> + + + + Return records + SuperCat can return records and metarecords in many different formats (see + http://<hostname>/opac/extras/supercat/retrieve/<format>/<record-type>/<bib-ID> + For example, http://dev.gapines.org/opac/extras/supercat/retrieve/mods/record/555 returns: + + <mods:modsCollection version="3.0"> + <mods:mods xsi:schemaLocation="http://www.loc.gov/mods/ http://www.loc.gov/standards/mods/mods.xsd"> + <titleInfo> + <title>More Brer Rabbit stories /</title> + </titleInfo> + <typeOfResource>text</typeOfResource> + <originInfo> + <place> + <code authority="marc">xx</c0de> + </place> + <publisher>Award Publications</publisher> + <dateIssued>c1982, 1983</dateIssued> + <dateIssued encoding="marc" point="start">1983</dateIssued> + <dateIssued encoding="marc" point="end">1982</dateIssued> + <issuance>monographic</issuance> + </originInfo> + <language authority="iso639-2b">eng</language> + <physicalDescription> + <form authority="marcform">print</form> + <extent>unp. : col. ill.</extent> + </physicalDescription> + <note type="statement of responsibility">ill. by Rene Cloke.</note> + <subject authority="lcsh"> + <topic>Animals</topic> + <topic>Fiction</topic> + </subject> + <subject authority="lcsh"> + <topic>Fables</topic> + </subject> + <recordInfo> + <recordContentSource>(BRO)</recordContentSource> + <recordCreationDate encoding="marc">930903</recordCreationDate> + <recordChangeDate encoding="iso8601">19990703024637.0</recordChangeDate> + <recordIdentifier>PIN60000007 </recordIdentifier> + </recordInfo> + </mods:mods> + </mods:modsCollection> + + + + Return a feed of recently edited or created records + SuperCat can return feeds of recently edited or created authority and bibliographic records: + http://<hostname>/opac/extras/feed/freshmeat/<feed-type>/[authority|biblio]/[import|edit]/<limit>/<date> + 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. + If you do not supply a limit, then up to 10 records will be returned. + Feed-type can be one of atom, html, htmlholdings, marcxml, mods, mods3, or rss2. + For example, http://dev.gapines.org/opac/extras/feed/freshmeat/atom/biblio/import/10/2008-01-01 + + + Browse records + SuperCat can browse records in HTML and XML formats: + http://<hostname>/opac/extras/supercat/browse/<format>/call_number/<org_unit>/<call_number> + For example, http://dev.gapines.org/opac/extras/browse/xml/call_number/-/GV returns: + + <hold:volumes xmlns:hold='http://open-ils.org/spec/holdings/v1'> + <hold:volume id="tag:open-ils.org,2008:asset-call_number/130607" lib="FRRLS-FA" label="GUTCHEON BETH"> + <act:owning_lib id="tag:open-ils.org,2008:actor-org_unit/111" name="Fayette County Public Library"/> + <record xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/ + standards/marcxml/schema/MARC21slim.xsd" + id="tag:open-ils.org,2008:biblio-record_entry/21669/FRRLS-FA"> + <leader>09319pam a2200961 a 4500</leader> + <controlfield tag="001"/> + <controlfield tag="005">20000302124754.0</controlfield> + <controlfield tag="008">990817s2000 nyu 000 1 eng </controlfield> + <datafield tag="010" ind1=" " ind2=" "> + <subfield code="a"> 99045936</subfield> + </datafield> + .. + </record> + <record> + .. + </record> + </hold:volume> + </hold:volumes> + + + + Supported formats + SuperCat maintains a list of supported formats for records and metarecords: + http://<hostname>/opac/extras/supercat/formats/<record-type> + For example, http://dev.gapines.org/opac/extras/supercat/formats/record returns: + + <formats> + + <format> + <name>opac</name> + <type>text/html</type> + </format> + + <format> + <name>htmlholdings</name> + <type>text/html</type> + </format> + + <format> + <name>html</name> + <type>text/html</type> + </format> + + <format> + <name>htmlholdings-full</name> + <type>text/html</type> + </format> + + <format> + <name>html-full</name> + <type>text/html</type> + </format> + + <format> + <name>marcxml</name> + <type>application/xml</type> + <namespace_uri>http://www.loc.gov/MARC21/slim</namespace_uri> + <docs>http://www.loc.gov/marcxml/</docs> + + <schema_location> + http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd + </schema_location> + </format> + + <format> + <name>marcxml-full</name> + <type>application/xml</type> + <namespace_uri>http://www.loc.gov/MARC21/slim</namespace_uri> + <docs>http://www.loc.gov/marcxml/</docs> + + <schema_location> + http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd + </schema_location> + </format> + + <format> + <name>rss2</name> + <type>application/xml</type> + </format> + + <format> + <name>rss2-full</name> + <type>application/xml</type> + </format> + + <format> + <name>rdf_dc</name> + <type>application/xml</type> + <namespace_uri>http://purl.org/dc/elements/1.1/</namespace_uri> + <schema_location>http://purl.org/dc/elements/1.1/</schema_location> + </format> + + <format> + <name>oai_dc</name> + <type>application/xml</type> + <namespace_uri>http://www.openarchives.org/OAI/2.0/oai_dc/</namespace_uri> + <schema_location>http://www.openarchives.org/OAI/2.0/oai_dc.xsd</schema_location> + </format> + + <format> + <name>srw_dc</name> + <type>application/xml</type> + <namespace_uri>info:srw/schema/1/dc-schema</namespace_uri> + + <schema_location> + http://www.loc.gov/z3950/agency/zing/srw/dc-schema.xsd + </schema_location> + </format> + + <format> + <name>mods32</name> + <type>application/xml</type> + <namespace_uri>http://www.loc.gov/mods/v3</namespace_uri> + <docs>http://www.loc.gov/mods/</docs> + <schema_location>http://www.loc.gov/standards/mods/v3/mods-3-2.xsd</schema_location> + </format> + + <format> + <name>mods3</name> + <type>application/xml</type> + <namespace_uri>http://www.loc.gov/mods/v3</namespace_uri> + <docs>http://www.loc.gov/mods/</docs> + <schema_location>http://www.loc.gov/standards/mods/v3/mods-3-1.xsd</schema_location> + </format> + + <format> + <name>mods3-full</name> + <type>application/xml</type> + <namespace_uri>http://www.loc.gov/mods/v3</namespace_uri> + <docs>http://www.loc.gov/mods/</docs> + <schema_location>http://www.loc.gov/standards/mods/v3/mods-3-1.xsd</schema_location> + </format> + + <format> + <name>mods</name> + <type>application/xml</type> + <namespace_uri>http://www.loc.gov/mods/</namespace_uri> + <docs>http://www.loc.gov/mods/</docs> + <schema_location>http://www.loc.gov/standards/mods/mods.xsd</schema_location> + </format> + + <format> + <name>mods-full</name> + <type>application/xml</type> + <namespace_uri>http://www.loc.gov/mods/</namespace_uri> + <docs>http://www.loc.gov/mods/</docs> + <schema_location>http://www.loc.gov/standards/mods/mods.xsd</schema_location> + </format> + + <format> + <name>atom</name> + <type>application/xml</type> + <namespace_uri>http://www.w3.org/2005/Atom</namespace_uri> + <docs>http://www.ietf.org/rfc/rfc4287.txt</docs> + </format> + + <format> + <name>atom-full</name> + <type>application/xml</type> + <namespace_uri>http://www.w3.org/2005/Atom</namespace_uri> + <docs>http://www.ietf.org/rfc/rfc4287.txt</docs> + </format> + </formats> + + + + Adding new SuperCat formats + SuperCat web services are based on the OpenSRF application, open-ils.supercat. + Developers are able to add new formats by adding the xsl + stylesheet for the format in the directory/openils/var/web/opac/extras/xsl/, and by adding the feed references to the perl modules + openils/lib/perl5/OpenILS/WWW/SuperCat/feed.pm and openils/lib/perl5/OpenILS/WWW/SuperCat.pm. An Evergreen restart is + required for the new format to be activated. + Use an existing xsl stylesheet and perm module entry as a guide for your new format. + + + diff --git a/1.6/opac/search_URL.xml b/1.6/opac/search_URL.xml index 220042ea27..3b7b48ddf4 100644 --- a/1.6/opac/search_URL.xml +++ b/1.6/opac/search_URL.xml @@ -1,5 +1,5 @@ - Search URL diff --git a/1.6/root.xml b/1.6/root.xml index 8dde994dfb..45657417c8 100755 --- a/1.6/root.xml +++ b/1.6/root.xml @@ -57,6 +57,7 @@ Core Staff Tasks + @@ -106,6 +107,7 @@ + diff --git a/1.6/stafftasks/stafftasks_intro.xml b/1.6/stafftasks/stafftasks_intro.xml new file mode 100644 index 0000000000..4f6e262aa7 --- /dev/null +++ b/1.6/stafftasks/stafftasks_intro.xml @@ -0,0 +1,3 @@ + + 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. + -- 2.11.0