From bd2c63e13427d0f669dbe865953a0f0205685c56 Mon Sep 17 00:00:00 2001 From: Robert Soulliere Date: Tue, 2 Nov 2010 12:08:30 -0400 Subject: [PATCH] Add supercat editing info. --- 1.6/development/customize_opac.xml | 11 ++-- 1.6/development/supercat.xml | 104 +++++++++++++++++++++---------------- 2 files changed, 66 insertions(+), 49 deletions(-) diff --git a/1.6/development/customize_opac.xml b/1.6/development/customize_opac.xml index 42771de..2498f12 100644 --- a/1.6/development/customize_opac.xml +++ b/1.6/development/customize_opac.xml @@ -288,10 +288,15 @@ name='Default' csstype='color'/> Customizing the Slimpac Results Display Two files control the display results for the slimpac. Edit the XSL stylesheet (/openils/var/xsl/ATOM2XHTML.xsl) to edit the elements of the record as pulled from the XML output. - You may also change the style of the page by editing the CSS stylesheet for the results display (/openils/var/web/opac/extras/os.css). To edit the - holdings display which contains the details of the specific record linked from the results display, edit the CSS stylesheet for the holdings/details page - (/openils/var/web/opac/extras/htmlcard.css). You may also control the holdings content by editing MARC21slim2HTMLCard.xsl. + You may also change the style of the page by editing the CSS stylesheet for the results display (/openils/var/web/opac/extras/os.css). + + + Customizing the Slimpac Details/Holdings Display + It is also possible to customize the details page when viewing specific items from the results list. To edit the holdings display which contains the details of the specific + record linked from the results display, edit the CSS stylesheet for the holdings/details page + (/openils/var/web/opac/extras/htmlcard.css). You may also control the content of the record by editing MARC21slim2HTMLCard.xsl. Holdings data may also be controlled by editing MARC21slim2HTMLCard-holdings.xsl. +
Integrating a Evergreen Search Form on a Web Page diff --git a/1.6/development/supercat.xml b/1.6/development/supercat.xml index b3edff0..8018a7b 100644 --- a/1.6/development/supercat.xml +++ b/1.6/development/supercat.xml @@ -4,17 +4,20 @@ 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: +
> + Using 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> @@ -31,12 +34,12 @@ <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: + + + 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"> @@ -76,21 +79,21 @@ </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: + + + 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"> @@ -113,12 +116,12 @@ </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: + + + 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> @@ -258,15 +261,24 @@ </format> </formats> - - - Adding new SuperCat formats + +
+
+ Adding new SuperCat Formats + Adding SuperCat formats requires experience editing XSL files and familiarity with XML and Perl.. SuperCat web services are based on the OpenSRF service, >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. - + stylesheet for the format. By default, the location of the stylesheets is /openils/var/xsl/. You must also add the feed 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 feed to be activated. + Use an existing xsl stylesheet and Perl module entry as a template for your new format. +
+
+ Customizing SuperCat Formats + Editing SuperCat formats requires experience editing XSL files and familiarity with XML.. + It is possible to customize existing supercat formats using XSL stylesheets. You arwe able to change the content to be displayed and the design of the pages. + 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 + /openils/var/xsl/. +
-- 2.11.0