Changeset 36518 for documented-examples/trunk/oai-e
- Timestamp:
- 2022-08-26T19:23:36+12:00 (20 months ago)
- Location:
- documented-examples/trunk/oai-e/resources
- Files:
-
- 2 edited
-
collectionConfig.properties (modified) (2 diffs)
-
collectionConfig.properties.template (modified) (2 diffs)
Legend:
- Unmodified
- Added
- Removed
-
documented-examples/trunk/oai-e/resources/collectionConfig.properties
r36510 r36518 11 11 12 12 13 shortDescription=<p>This collection demonstrates Greenstone\'s <i>ImportFrom</i> feature. Using the <a href="http ://www.openarchives.org">Open Archive Protocol</a> (version 1.1), it retrieves metadata from <a href="http://rocky.dlib.vt.edu/~jcdlpix">rocky.dlib.vt.edu/~jcdlpix</a>, a collection of photographs taken at the inaugural <a href="http://www.acm.org/jcdl/jcdl01/">Joint Conference on Digital Libraries</a>. A Greenstone collection is built from the records exported from this OAI data provider. The implementation is flexible enough to cope with the minor syntax differences between OAI 1.1 and OAI 2.0.</p>13 shortDescription=<p>This collection demonstrates Greenstone\'s <i>ImportFrom</i> feature. Using the <a href="http\://www.openarchives.org">Open Archive Protocol</a> (version 1.1), it retrieves metadata from <a href="http\://rocky.dlib.vt.edu/~jcdlpix">rocky.dlib.vt.edu/~jcdlpix</a>, a collection of photographs taken at the inaugural <a href="http\://www.acm.org/jcdl/jcdl01/">Joint Conference on Digital Libraries</a>. A Greenstone collection is built from the records exported from this OAI data provider. The implementation is flexible enough to cope with the minor syntax differences between OAI 1.1 and OAI 2.0.</p> 14 14 15 description1=<h3>How the collection works</h3><p>The collection configuration file, <tt>collectionConfig.xml</tt>, includes an <i>acquire</i> line that is interpreted by a special program called <i>importfrom.pl</i>. Like other Greenstone programs, this takes as argument the name of the collection, and provides a summary of other arguments when invoked with argument <i>-help</i>. It reads the collection configuration file, finds the acquire line, and processes it. In this case, it is run with the command : <pre> importfrom.pl oai-e </pre> (the collection\'s name is <i>oai-e</i>).</p>15 description1=<h3>How the collection works</h3><p>The collection configuration file, <tt>collectionConfig.xml</tt>, includes an <i>acquire</i> line that is interpreted by a special program called <i>importfrom.pl</i>. Like other Greenstone programs, this takes as argument the name of the collection, and provides a summary of other arguments when invoked with argument <i>-help</i>. It reads the collection configuration file, finds the acquire line, and processes it. In this case, it is run with the command\: <pre> importfrom.pl oai-e </pre> (the collection\'s name is <i>oai-e</i>).</p> 16 16 17 17 description2=<p>The <i>acquire</i> line in the configuration file specifies the OAI protocol and gives the base URL of an OAI repository. The <i>importfrom</i> program downloads all the metadata in that repository into the collection\'s <i>import</i> directory. The <i>getdoc</i> argument instructs it to also download the collection\'s source documents, whose URLs are given in each document\'s Dublin Core <i>Identifier</i> field (this is a common convention). The metadata files, which each contain an XML record for one source document, are placed in the <i>import</i> file structure along with the documents themselves, and the document filename is the same as the filename in the URL. The <i>Identifier</i> field is overridden to give the local filename, and its original value is retained in a new field called <i>OrigURL</i>.</p> … … 19 19 description3=<p>This <i>oai-e</i> collection\'s own <tt>etc/oai.txt</tt> is an example of a downloaded metadata file.</p> 20 20 21 description4=<p>Once the OAI information has been imported, the collection is processed in the usual way. Besides the four standard plugins (GreenstoneXMLPlugin, MetadataXMLPlugin, ArchivesInfPlugin and DirectoryPlugin), the configuration file specifies the OAI plugin, which processes OAI metadata, and the image plugin, because in this case the collection\'s source documents are image files. The OAI plugin has been supplied with an <i>input_encoding</i> argument because data in this archive contains extended characters. It also has a <i>default_language</i> argument. Greenstone normally determines the language of documents automatically, but these metadata records are too small for this to be done reliably : hence English is specified explicitly in the <i>language</i> argument. The OAI plugin parses the metadata and passes it to the appropriate source document file, which is then processed by an appropriate plugin -- in this case <i>ImagePlugin</i>. This plugin specifies the resolution for the screen versions of the images.</p>21 description4=<p>Once the OAI information has been imported, the collection is processed in the usual way. Besides the four standard plugins (GreenstoneXMLPlugin, MetadataXMLPlugin, ArchivesInfPlugin and DirectoryPlugin), the configuration file specifies the OAI plugin, which processes OAI metadata, and the image plugin, because in this case the collection\'s source documents are image files. The OAI plugin has been supplied with an <i>input_encoding</i> argument because data in this archive contains extended characters. It also has a <i>default_language</i> argument. Greenstone normally determines the language of documents automatically, but these metadata records are too small for this to be done reliably\: hence English is specified explicitly in the <i>language</i> argument. The OAI plugin parses the metadata and passes it to the appropriate source document file, which is then processed by an appropriate plugin -- in this case <i>ImagePlugin</i>. This plugin specifies the resolution for the screen versions of the images.</p> 22 22 23 23 description5=<p>Extracted metadata from OAI records are mapped to Dublin Core Metadata Set by default. As a result, classifiers and indexes in this collection are built with Dublin meatadata elements.</p> -
documented-examples/trunk/oai-e/resources/collectionConfig.properties.template
r36307 r36518 13 13 search/TextQuery?qs=1&rt=rd&s1.level=&startPage=1&s1.query=cat&s1.index=dte 14 14 15 http ://localhost:8383/greenstone3/library/collection/gsarch-e/search/TextQuery?qs=1&rt=rd&s1.level=&startPage=1&s1.query=%22cat+and+dog%22&s1.index=dte15 http\://localhost\:8383/greenstone3/library/collection/gsarch-e/search/TextQuery?qs=1&rt=rd&s1.level=&startPage=1&s1.query=%22cat+and+dog%22&s1.index=dte 16 16 17 17 … … 22 22 23 23 24 <td><b><gsf :link type="document"><gsf:metadata name="Subject"/></gsf:link></b><br/><gsf:displayItem name="From"/>:<gsf:metadata name="FromName"/> (<a href="_httpquery_&q=&h=dfr"><gsf:displayItem name="SearchBySender"/></a>)<br/><gsf:displayItem name="Date"/>:<gsf:metadata name="DateText"/></td>24 <td><b><gsf\:link type="document"><gsf\:metadata name="Subject"/></gsf\:link></b><br/><gsf\:displayItem name="From"/>\:<gsf\:metadata name="FromName"/> (<a href="_httpquery_&q=&h=dfr"><gsf\:displayItem name="SearchBySender"/></a>)<br/><gsf\:displayItem name="Date"/>\:<gsf\:metadata name="DateText"/></td> 25 25 26 26 27 27 28 <a><xsl :attribute name="href"><gsf:metadata name="httpPath" type="collection"/>/index/assoc/<gsf:metadata name="archivedir"/>/<gsf:metadata name="srclinkFile"/>#search=&quot;<gsf:cgi-param name="query"/>&quot;</xsl:attribute>src doc link with query highlighting</a>28 <a><xsl\:attribute name="href"><gsf\:metadata name="httpPath" type="collection"/>/index/assoc/<gsf\:metadata name="archivedir"/>/<gsf\:metadata name="srclinkFile"/>#search=&quot;<gsf\:cgi-param name="query"/>&quot;</xsl\:attribute>src doc link with query highlighting</a> 29 29 30 <td><b><gsf :link type="document"><gsf:metadata name="Subject"/></gsf:link></b><br/><gsf:displayItem name="From"/>:<gsf:metadata name="FromName"/> (31 <a><xsl :attribute name="href"><gsf:metadata name="httpPath" type="collection"/>/search/TextQuery?qs=1&rt=rd&s1.level=&startPage=1&s1.index=dfr&s1.query=&quot;<gsf:cgi-param name="query"/>&quot;</xsl:attribute><gsf:displayItem name="SearchBySender"/></a>30 <td><b><gsf\:link type="document"><gsf\:metadata name="Subject"/></gsf\:link></b><br/><gsf\:displayItem name="From"/>\:<gsf\:metadata name="FromName"/> ( 31 <a><xsl\:attribute name="href"><gsf\:metadata name="httpPath" type="collection"/>/search/TextQuery?qs=1&rt=rd&s1.level=&startPage=1&s1.index=dfr&s1.query=&quot;<gsf\:cgi-param name="query"/>&quot;</xsl\:attribute><gsf\:displayItem name="SearchBySender"/></a> 32 32 33 33 34 <td><b><gsf :link type="document"><gsf:metadata name="Subject"/></gsf:link></b><br/><gsf:displayItem name="From"/>:<gsf:metadata name="FromName"/> (<a><xsl:attribute name="href">library/collection/gsarch-e/search/TextQuery?qs=1&rt=rd&s1.level=&startPage=1&s1.index=dfr&s1.query=&quot;<gsf:metadata name="FromName"/>&quot;</xsl:attribute><gsf:displayItem name="SearchBySender"/></a>)<br/><gsf:displayItem name="Date"/>:<gsf:metadata name="DateText"/></td>34 <td><b><gsf\:link type="document"><gsf\:metadata name="Subject"/></gsf\:link></b><br/><gsf\:displayItem name="From"/>\:<gsf\:metadata name="FromName"/> (<a><xsl\:attribute name="href">library/collection/gsarch-e/search/TextQuery?qs=1&rt=rd&s1.level=&startPage=1&s1.index=dfr&s1.query=&quot;<gsf\:metadata name="FromName"/>&quot;</xsl\:attribute><gsf\:displayItem name="SearchBySender"/></a>)<br/><gsf\:displayItem name="Date"/>\:<gsf\:metadata name="DateText"/></td> 35 35 36 36 37 <xslt :value-of disable-output-escaping="yes" select="/page/pageRequest/paramList/param[@name='c']/@value" />38 <xslt :value-of disable-output-escaping="yes" select="/page/pageResponse/interfaceOptions/option[@name='library_name']/@value" />37 <xslt\:value-of disable-output-escaping="yes" select="/page/pageRequest/paramList/param[@name='c']/@value" /> 38 <xslt\:value-of disable-output-escaping="yes" select="/page/pageResponse/interfaceOptions/option[@name='library_name']/@value" /> 39 39 40 <a><xsl :attribute name="href"><xsl:value-of disable-output-escaping="yes" select="/page/pageResponse/interfaceOptions/option[@name='library_name']/@value" />/collection/<xsl:value-of disable-output-escaping="yes" select="/page/pageRequest/paramList/param[@name='c']/@value" />/search/TextQuery?qs=1&rt=rd&s1.level=&startPage=1&s1.index=dfr&s1.query=&quot;<gsf:metadata name="FromName"/>&quot;</xsl:attribute><gsf:displayItem name="SearchBySender"/></a>40 <a><xsl\:attribute name="href"><xsl\:value-of disable-output-escaping="yes" select="/page/pageResponse/interfaceOptions/option[@name='library_name']/@value" />/collection/<xsl\:value-of disable-output-escaping="yes" select="/page/pageRequest/paramList/param[@name='c']/@value" />/search/TextQuery?qs=1&rt=rd&s1.level=&startPage=1&s1.index=dfr&s1.query=&quot;<gsf\:metadata name="FromName"/>&quot;</xsl\:attribute><gsf\:displayItem name="SearchBySender"/></a> 41 41 42 42
Note:
See TracChangeset
for help on using the changeset viewer.
