source: documented-examples/trunk/wrdpdf-e/resources/collectionConfig.properties@ 36589

Last change on this file since 36589 was 36589, checked in by anupama, 20 months ago

Commit 2 of 2. The usual insertion of QQQ to English language DEC collection descriptions (to be followed in next commit by undoing QQQ) to force GTI to mark translated strings as requiring updating.

File size: 5.0 KB
Line 
1name=MSWord and PDF demonstration
2document_text=documents
3
4shortDescription=<p>This collection demonstrates Greenstone\'s ability to build collections from documents provided in different formats. It contains a number of papers written by various members of the NZDL project in PDF, MSWord, RTF, and Postscript formats.</p>
5
6description1=<p>The documents in this collection have been produced by members of the Department of Computer Science, University of Waikato. The University of Waikato holds copyright. They may be distributed freely, without any restrictions.</p>
7
8description2=<h3>How the collection works</h3> <p> This collection\'s configuration file, <tt>collectionConfig.xml</tt>, contains the four plugins <i>WordPlugin</i>, <i>RTFPlugin</i>, <i>PDFPlugin</i> and <i>PostScriptPlugin</i> (along with the standard four, <i>GreenstoneXMLPlugin</i>, <i>MetadataXMLPlugin</i>, <i>ArchivesInfPlugin</i> and <i>DirectoryPlugin</i>). These four plugins all extract <i>Title</i> and <i>Source</i> (i.e. filename) metadata.</p>
9
10description3=<p>Greenstone contains third-party software that is used to convert Word, RTF, PDF and PostScript files into HTML. The Greenstone team does not maintain these modules, although we do try to include the latest versions with each Greenstone release. Bugs arise with unusual Word documents (e.g. from older Macintosh systems), and sometimes the text is badly extracted. Some PDF files have no machine-readable text at all, comprising instead a sequence of page <i>images</i> from which text can only be extracted by optical character recognition (OCR), which Greenstone does not attempt. If you encounter these problems, you can either remove the offending documents from your collection, or try using some of the advanced plugin options to process the documents in different ways. For more information, see the Enhanced PDF and Word tutorials on the <a href='http\://wiki.greenstone.org/wiki/index.php/Tutorial_exercises'>Greenstone wiki</a>. Alternatively, a new Greenstone 3 collection will add in a pre-configured <i>UnknownConverterPlugin</i> that will use <i>apache tika</i> by default to process docx files. You can reconfigure it, or add another UnknownConverterPlugin and configure it appropriately, to process other document types, refer to <a href="http\://wiki.greenstone.org/doku.php?id=en\:plugin\:unknownconverterplugin">The UnknownConverterPlugin</a> page on the Greenstone wiki.</p>
11
12description4=<p>The collection configuration file, <tt>collectionConfig.xml</tt>, includes a single index, based on document text, and one classifier, an <i>AZList</i> based on <i>Title</i> metadata, shown in <tt>CL1</tt> (the alphabetic selector is suppressed automatically because the collection contains only a few documents). However, no format statement is specified. In the absence of explicit information, Greenstone supplies sensible defaults. In this case, the default format statement for the classifier gives\: \n\
13<ul> \n\
14<li>an icon for the HTML version of the document (the text that is actually indexed, essentially the same as the Greenstone Archive format);</li> \n\
15<li>an icon for the original version of the document (clicking it opens the document in its original form);</li> \n\
16<li><i>Title</i> metadata, extracted from the document; <li> <i>Source</i> (i.e. filename) metadata, extracted from the document.</li> \n\
17</ul> \n\
18</p>
19
20description5=<p>Here is a format statement that achieves exactly the same effect explicitly. It applies to all <i>Vlists</i>, and so controls both search results list and the alphabetic title browser. \n\
21<pre>\
22&lt;format&gt; \n\
23 &lt;gsf\:template match="documentNode"&gt; \n\
24 &lt;gsf\:format-gs2&gt;&lt;![CDATA[&lt;td valign="top"&gt;[link][icon][/link]&lt;/td&gt; \n\
25&lt;td valign="top"&gt;[ex.srclink]{Or}{[ex.thumbicon],[ex.srcicon]}[ex./srclink]&lt;/td&gt; \n\
26&lt;td valign="top"&gt;[highlight] {Or}{[dc.Title],[exp.Title],[ex.Title],Untitled} [/highlight]{If}{[ex.Source],&lt;br&gt;&lt;i&gt;([ex.Source])&lt;/i&gt;}&lt;/td&gt;]]&gt;&lt;/gsf\:format-gs2&gt; \n\
27 &lt;td valign="top"&gt; \n\
28 &lt;gsf\:link type="document"&gt; \n\
29 &lt;gsf\:icon type="document"/&gt; \n\
30 &lt;/gsf\:link&gt; \n\
31 &lt;/td&gt; \n\
32 &lt;td valign="top"&gt; \n\
33 &lt;gsf\:link type="source"&gt; \n\
34 &lt;gsf\:choose-metadata&gt; \n\
35 &lt;gsf\:metadata name="thumbicon"/&gt; \n\
36 &lt;gsf\:metadata name="srcicon"/&gt; \n\
37 &lt;/gsf\:choose-metadata&gt; \n\
38 &lt;/gsf\:link&gt; \n\
39 &lt;/td&gt; \n\
40 &lt;td valign="top"&gt; \n\
41 &lt;span class="highlight"&gt; \n\
42 &lt;gsf\:choose-metadata&gt;&lt;gsf\:metadata name="dc.Title"/&gt;&lt;gsf\:metadata name="exp.Title"/&gt;&lt;gsf\:metadata name="Title"/&gt;Untitled&lt;/gsf\:choose-metadata&gt; \n\
43 &lt;/span&gt; \n\
44 &lt;gsf\:switch&gt; \n\
45 &lt;gsf\:metadata name="Source"/&gt; \n\
46 &lt;gsf\:when test="exists"&gt; \n\
47 &lt;br/&gt; \n\
48 &lt;i&gt;(&lt;gsf\:metadata name="Source"/&gt;)&lt;/i&gt; \n\
49 &lt;/gsf\:when&gt; \n\
50 &lt;/gsf\:switch&gt; \n\
51 &lt;/td&gt; \n\
52 &lt;/gsf\:template&gt; \n\
53&lt;/format&gt;
54</pre> \n\
55</p>
Note: See TracBrowser for help on using the repository browser.