Changeset 36474 for documented-examples/trunk/dls-e
- Timestamp:
- 2022-08-24T19:22:14+12:00 (20 months ago)
- Location:
- documented-examples/trunk/dls-e
- Files:
-
- 3 edited
Legend:
- Unmodified
- Added
- Removed
-
documented-examples/trunk/dls-e/etc/collectionConfig.xml
r36368 r36474 32 32 <displayItem assigned="true" dictionary="collectionConfig" key="description20" name="description20"/> 33 33 <displayItem assigned="true" dictionary="collectionConfig" key="description21" name="description21"/> 34 <displayItem assigned="true" dictionary="collectionConfig" key="textsource" name="textsource"/> 35 <displayItem assigned="true" dictionary="collectionConfig" key="textnumpages" name="textnumpages"/> 36 <displayItem assigned="true" dictionary="collectionConfig" key="textdate" name="textdate"/> 34 37 </displayItemList> 35 38 <format/> … … 145 148 <gsf:switch> 146 149 <gsf:metadata name="Date"/> 147 <gsf:when test="exists"><br/> _textdate_<gsf:metadata name="Date"/></gsf:when>150 <gsf:when test="exists"><br/><gsf:metadata name="Date"/><gsf:metadata name="Date"/></gsf:when> 148 151 </gsf:switch> 149 152 <gsf:switch> 150 153 <gsf:metadata name="NumPages"/> 151 <gsf:when test="exists"><br/> _textnumpages_<gsf:metadata name="NumPages"/></gsf:when>154 <gsf:when test="exists"><br/><gsf:metadata name="NumPages"/><gsf:metadata name="NumPages"/></gsf:when> 152 155 </gsf:switch> 153 156 <gsf:switch> 154 157 <gsf:metadata name="Source"/> 155 <gsf:when test="exists"><br/> _textsource_<gsf:metadata name="Source"/></gsf:when>158 <gsf:when test="exists"><br/><gsf:metadata name="Source"/><gsf:metadata name="Source"/></gsf:when> 156 159 </gsf:switch> 157 160 </small> … … 174 177 <gsf:switch> 175 178 <gsf:metadata name="Date"/> 176 <gsf:when test="exists"><br/> _textdate_<gsf:metadata name="Date"/></gsf:when>179 <gsf:when test="exists"><br/><gsf:metadata name="Date"/><gsf:metadata name="Date"/></gsf:when> 177 180 </gsf:switch> 178 181 <gsf:switch> 179 182 <gsf:metadata name="NumPages"/> 180 <gsf:when test="exists"><br/> _textnumpages_<gsf:metadata name="NumPages"/></gsf:when>183 <gsf:when test="exists"><br/><gsf:metadata name="NumPages"/><gsf:metadata name="NumPages"/></gsf:when> 181 184 </gsf:switch> 182 185 <gsf:switch> 183 186 <gsf:metadata name="Source"/> 184 <gsf:when test="exists"><br/> _textsource_<gsf:metadata name="Source"/></gsf:when>187 <gsf:when test="exists"><br/><gsf:metadata name="Source"/><gsf:metadata name="Source"/></gsf:when> 185 188 </gsf:switch> 186 189 </small> -
documented-examples/trunk/dls-e/etc/dls.AZList.txt
r18738 r36474 5 5 "Q-R-S" 5 "Q-R-S" 6 6 "T-U-V-W-X-Y-Z" 6 "T-U-V-W-X-Y-Z" 7 "_textperiodicals_" 7 " _textperiodicals_"7 "_textperiodicals_" 7 "Periodicals" 8 8 "_textperiodicals_|Go Between" 7.1 "Go Between" 9 9 "_textperiodicals_|The Courier" 7.2 "The Courier" -
documented-examples/trunk/dls-e/resources/collectionConfig.properties
r36446 r36474 3 3 section_text=chapters 4 4 document_text=entire documents 5 document=_textdocument_ 6 5 document=Document 6 textdate=publication date: 7 textnumpages=no. of pages: 8 textsource=source ref: 9 10 7 11 shortDescription=<p>The Humanitarian Development Libraries represent a large collection of practical information aimed at helping reduce poverty, increasing human potential, and providing a practical and useful education for all. This subset contains about 25 publications--documents, reports, and periodical articles--in various areas of human development, from agricultural practice to economic policies, from water and sanitation to society and culture, from education to manufacturing, from disaster mitigation to micro-enterprises.</p> 8 12 9 13 description0=<p>The editors of this collection are Human Info NGO, HumanityCD Ltd, and participating organizations. Contact us at Humanitarian and Development Libraries Project, Oosterveldiaan 196, B-2610 Antwerp, Belgium, Tel 32-3-448.05.54, Fax 32-3-449.75.74, email <a href=mailto:[email protected]>[email protected]</a>. 10 14 11 description1=<h3>How the collection works</h3><p>The DLS collection is fairly complex. If you\'re just starting out you might prefer to look at some other collections first (e.g. < i>Word and PDF demonstration</i>, or the <i>Greenstone Archives</i>, or the <i>Simple Image collection</i>).</p>15 description1=<h3>How the collection works</h3><p>The DLS collection is fairly complex. If you\'re just starting out you might prefer to look at some other collections first (e.g. <a href="library/collection/wrdpdf-e/page/about">Word and PDF demonstration</a>, or the <a href="library/collection/gsarch-e/page/about">Greenstone Archives</a>, or the <a href="library/collection/image-e/page/about">Simple Image collection</a>).</p> 12 16 13 17 description2=<p>The collection configuration file, <tt>collectionConfig.xml</tt>, like all collection configuration files, begins with the <i>creator</i> metadata element that gives the email address of the collection\'s creator, and another metadata ("public") that determines whether the collection will appear on the home page of the Greenstone installation. Note that setting "public" to "false" only removes it from the home page; it will still be accessible in the library to anyone that knows the URL to the collection.</p> … … 17 21 description4=<p>The other plugins, <i>GreenstoneXMLPlugin, MetadataXMLPlugin, ArchivesInfPlugin, and DirectoryPlugin</i>, are used by Greenstone for internal purposes and are standard in almost all collections.</p> 18 22 19 description5=<p><b>Searchable indexes</b>. The block of lines starting with <i>indexes</i> specifies what searchable indexes will be available. In this collection there are three: you can see them when you pull down the "Search for" menu on the collection\'s < tt>search page</tt>. The first index is called "chapters", the second "section titles", and the third "entire documents". The names of these three indexes are given by three properties (section_text, section_Title and document_text) in the translatable <tt>collectionConfig.properties</tt> file located in the collection\'s <tt>resources</tt> subfolder.</p>23 description5=<p><b>Searchable indexes</b>. The block of lines starting with <i>indexes</i> specifies what searchable indexes will be available. In this collection there are three: you can see them when you pull down the "Search for" menu on the collection\'s <a href="library/collection/dls-e/search/TextQuery">search page</a>. The first index is called "chapters", the second "section titles", and the third "entire documents". The names of these three indexes are given by three properties (section_text, section_Title and document_text) in the translatable <tt>collectionConfig.properties</tt> file located in the collection\'s <tt>resources</tt> subfolder.</p> 20 24 21 25 description6=<p>The contents of the indexes -- that is, the specification of what it is that will be searched -- are defined by the <i>indexes</i> line at the beginning of this block. This specifies three indexes, two at the section level (beginning with <i>section:</i>) and one at the document level (beginning with <i>document:</i>). The difference is that a multi-word query will only match a section-level index if all query terms appear in the same section, whereas it will match a document-level index if the terms appear anywhere within the document (which typically comprises several sections). The first and third indexes are <i>section:text</i> and <i>document:text</i>, and the <i>:text</i> means that the full text of sections and documents respectively will be searched. The second is <i>section:Title</i>, which means that <i>Title</i> metadata will be searched -- in this case, section titles (rather than document titles). The three indexes appear in the order in which they are specified on the <i>indexes</i> line.</p> 22 26 23 description7=<p><b>Classifiers</b>. The block of lines labeled <i>classify</i> define the browsing indexes, called "classifiers" in Greenstone. There are four of them, corresponding to four buttons on the navigation bar at the top of each page in the collection (e.g. the < tt>search page</tt>): <i>subjects</i>, <i>titles</i>, <i>organisations</i>, and <i>howto</i> The <i>search</i> button comes first, then come the four classifiers, in order.</p>27 description7=<p><b>Classifiers</b>. The block of lines labeled <i>classify</i> define the browsing indexes, called "classifiers" in Greenstone. There are four of them, corresponding to four buttons on the navigation bar at the top of each page in the collection (e.g. the <a href="library/collection/dls-e/search/TextQuery">search page</a>): <i>subjects</i>, <i>titles</i>, <i>organisations</i>, and <i>howto</i> The <i>search</i> button comes first, then come the four classifiers, in order.</p> 24 28 25 description8=<p>The first classifier provides access by subject. It is a <i>Hierarchy</i> classifier whose hierarchy is defined in the file <tt> dls.Subject.txt</tt> (the <i>hfile</i> argument); this file is discussed below. This classifier is based on <i>dls.Subject</i> metadata, and when several books appear at a leaf of the hierarchy they are sorted by <i>dls.Title</i> metadata (as you can see when you open classifier browser <tt>CL1.4.1</tt>). The second classifier provides access by title. It is also a <i>Hierarchy</i> classifier, this time based on <i>dls.AZList</i> metadata, whose hierarchy is defined in <tt>dls.AZList.txt</tt>. This file is discussed below. The third provides access by organization: it is a <i>List</i> classifier based on <i>dls.Organization</i> metadata. The <i>-bookshelf_type always</i> option creates a new bookshelf for each organization, even if only one document belongs to that category. The fourth provides access by "Howto" text: it is a <i>List</i> classifier based on <i>dls.Keyword</i> metadata. The <i>-bookshelf_type never</i> option prevents bookshelves being created even if two documents share the same keywords.</p>29 description8=<p>The first classifier provides access by subject. It is a <i>Hierarchy</i> classifier whose hierarchy is defined in the file <tt>etc/dls.Subject.txt</tt> (the <i>hfile</i> argument); this file is discussed below. This classifier is based on <i>dls.Subject</i> metadata, and when several books appear at a leaf of the hierarchy they are sorted by <i>dls.Title</i> metadata (as you can see when you open classifier browser <tt>CL1.4.1</tt>). The second classifier provides access by title. It is also a <i>Hierarchy</i> classifier, this time based on <i>dls.AZList</i> metadata, whose hierarchy is defined in <tt>etc/dls.AZList.txt</tt>. This file is discussed below. The third provides access by organization: it is a <i>List</i> classifier based on <i>dls.Organization</i> metadata. The <i>-bookshelf_type always</i> option creates a new bookshelf for each organization, even if only one document belongs to that category. The fourth provides access by "Howto" text: it is a <i>List</i> classifier based on <i>dls.Keyword</i> metadata. The <i>-bookshelf_type never</i> option prevents bookshelves being created even if two documents share the same keywords.</p> 26 30 27 31 description9=<p><b>Cover images</b>. Greenstone looks for a cover image for each document, whose name is the same as the document\'s but with a <i>.jpg</i> extension. This image is associated with the document, and may be displayed on the document page (see below). Cover images can be switched off by setting the -no_cover_image flag for each plugin.</p> … … 43 47 description17=<p><b>Hierarchy files</b>. Hierarchy files contain a succession of lines each of which has three items. The first item is a text string which is matched against the metadata that occurs in the <i>metadata.xml</i> file described above. The second item is a number that defines the position in the hierarchy. The third item is a text string that describes the node of the hierarchy on the web pages that Greenstone generates.</p> 44 48 45 description18=<p>For example, the following shows three lines from the subject hierarchy file <tt> dls.Subject.txt</tt>. \n\49 description18=<p>For example, the following shows three lines from the subject hierarchy file <tt>etc/dls.Subject.txt</tt>. \n\ 46 50 <pre> "Animal Husbandry and Animal Product Processing " \n\ 47 51 7 "Animal Husbandry and Animal Product Processing " "Animal Husbandry and Animal Product Processing|Cattle " \n\ … … 55 59 description20=<p>In this case, the first strings (and therefore the entries in metadata.xml files) contain the entire hierarchy values. Levels in the hierarchy are separated by "| ". They could be used directly by a <i>Hierarchy</i> classifier without the use of the hierarchy file. However, then the entries would be ordered alphabetically, not in the special order defined by the file.</p> 56 60 57 description21=<p>The <tt> dls.AZList.txt</tt> hierarchy file used by the titles classifier contains a similar structure. Ordinarily, a titles browser would use a <i>List</i> (or <i>AZList</i>) classifier. In this case, we want to predefine the A-Z groupings, and include a separate entry for periodicals, as can be seen in classifier browser <tt>CL2.7</tt>.</p>61 description21=<p>The <tt>etc/dls.AZList.txt</tt> hierarchy file used by the titles classifier contains a similar structure. Ordinarily, a titles browser would use a <i>List</i> (or <i>AZList</i>) classifier. In this case, we want to predefine the A-Z groupings, and include a separate entry for periodicals, as can be seen in classifier browser <a href="library/collection/dls-e/browse/CL2/7">here</a>.</p>
Note:
See TracChangeset
for help on using the changeset viewer.