Changeset 36614 for documented-examples


Ignore:
Timestamp:
2022-09-14T19:35:58+12:00 (19 months ago)
Author:
anupama
Message:

Forgot to ensure English appears as last edited on GTI. Commit 1/2

Location:
documented-examples/trunk
Files:
15 edited

Legend:

Unmodified
Added
Removed

  • documented-examples/trunk/authen-e/resources/collectionConfig.properties

    r36589 r36614  
    1 name=Authentication demo
    2 textdate=publication date\:
    3 textnumpages=no. of pages\:
    4 textsource=source ref\:
    5 section_chapter=chapter
    6 document_book=book
     1name=QQQQAuthentication demo
     2textdate=QQQQpublication date\:
     3textnumpages=QQQQno. of pages\:
     4textsource=QQQQsource ref\:
     5section_chapter=QQQQchapter
     6document_book=QQQQbook
    77
    8 dls.Organization=Organizations
    9 dls.Subject=Subjects
    10 index_text=Text
    11 index_document=Book
    12 index_section=Chapter
    13 dls.Titles=Titles
    14 dls.Keyword=How to
     8dls.Organization=QQQQOrganizations
     9dls.Subject=QQQQSubjects
     10index_text=QQQQText
     11index_document=QQQQBook
     12index_section=QQQQChapter
     13dls.Titles=QQQQTitles
     14dls.Keyword=QQQQHow to
    1515
    16 shortDescription=<p>Collection that demonstrates document-level collection authentication in Greenstone 3.</p>
     16shortDescription=QQQQ<p>Collection that demonstrates document-level collection authentication in Greenstone 3.</p>
    1717
    18 description1=<p>This demonstration collection contains the same material as the original Greenstone demo collection, but it includes some basic authentication commands. Two documents are publicly available (Farming snails 1 &amp; 2), while the others require logging in to view.</p> <p><center><b> To access this collection try user\:</b> <i>demo</i> <b>and password\:</b> <i>demo</i></center></p>
     18description1=QQQQ<p>This demonstration collection contains the same material as the original Greenstone demo collection, but it includes some basic authentication commands. Two documents are publicly available (Farming snails 1 &amp; 2), while the others require logging in to view.</p> <p><center><b> To access this collection try user\:</b> <i>demo</i> <b>and password\:</b> <i>demo</i></center></p>
    1919
    20 description2=<h3>How the collection works</h3><p> The collection configuration file is exactly the same as for the original demo collection apart from the authentication directives, one plugin option (and this description).</p>
     20description2=QQQQ<h3>How the collection works</h3><p> The collection configuration file is exactly the same as for the original demo collection apart from the authentication directives, one plugin option (and this description).</p>
    2121
    22 description3=<p>The authentication scheme controls access to the collection. It works in two steps. First it determines whether to restrict access to the collection as a whole or to individual documents in it, and in the latter case which documents those are (either by giving a list of private documents for which access is to be authenticated, or specifying that all documents are private except for a given list of public documents). Then for access-restricted documents it determines which user groups are to have access.</p>
     22description3=QQQQ<p>The authentication scheme controls access to the collection. It works in two steps. First it determines whether to restrict access to the collection as a whole or to individual documents in it, and in the latter case which documents those are (either by giving a list of private documents for which access is to be authenticated, or specifying that all documents are private except for a given list of public documents). Then for access-restricted documents it determines which user groups are to have access.</p>
    2323
    24 description4=<p>Authentication is activated using the <i>&lt;security&gt;</i> XML element in the collectionConfig.xml file. In the example of the authen-e collection, all <i>document</i>s are set to <i>private</i> access by default, with the <i>exception</i> that they are accessible to logged in members of a <i>group</i> called <i>"demo"</i>. The <i>security</i> element further defines a set of documents (<i>documentSet</i>) called "always-public" which contains 2 documents denoted by their document identifiers/OIDs (fb33fe and fb34fe). This documentSet specifies an exceptional case\: the documents in the documentSet are <i>not</i> private access like other documents in the collection are by default, but can instead be accessed by anyone in <i>any</i> group, as no group is specified for their access. \n\
    25    <pre>&lt;security default_access="private" scope="document"&gt; \n\
     24description4=QQQQ<p>Authentication is activated using the <i>&lt;security&gt;</i> XML element in the collectionConfig.xml file. In the example of the authen-e collection, all <i>document</i>s are set to <i>private</i> access by default, with the <i>exception</i> that they are accessible to logged in members of a <i>group</i> called <i>"demo"</i>. The <i>security</i> element further defines a set of documents (<i>documentSet</i>) called "always-public" which contains 2 documents denoted by their document identifiers/OIDs (fb33fe and fb34fe). This documentSet specifies an exceptional case\: the documents in the documentSet are <i>not</i> private access like other documents in the collection are by default, but can instead be accessed by anyone in <i>any</i> group, as no group is specified for their access. \n\
     25   <pre>&lt;security default_access=QQQQ"private" scope="document"&gt; \n\
    2626        &lt;exception&gt; \n\
    27             &lt;group name="demo"/&gt; \n\
     27            &lt;group name=QQQQ"demo"/&gt; \n\
    2828        &lt;/exception&gt; \n\
    2929        &lt;exception&gt; \n\
    30             &lt;documentSet name="always-public"/&gt; \n\
    31             &lt;group name=""/&gt; \n\
     30            &lt;documentSet name=QQQQ"always-public"/&gt; \n\
     31            &lt;group name=QQQQ""/&gt; \n\
    3232        &lt;/exception&gt; \n\
    33         &lt;documentSet name="always-public"&gt; \n\
     33        &lt;documentSet name=QQQQ"always-public"&gt; \n\
    3434            &lt;match&gt;fb33fe&lt;/match&gt; \n\
    3535            &lt;match&gt;fb34fe&lt;/match&gt; \n\
    … …  
    3838</p>
    3939
    40 description5=<p>In this case, we have used the <i>-OIDtype dirname</i> option to HTMLPlugin, which specifies that directory names should be used as identifiers. This works for collections where each document is in a separate directory. We have used this option to ensure that identifiers remain the same across different platforms (which may not be the case for HASH identifiers), as we need to specify identifiers here for the <i>documentSet</i>s controlling exceptions to the default access granted (or withheld) by the <i>security</i> element.</p>
     40description5=QQQQ<p>In this case, we have used the <i>-OIDtype dirname</i> option to HTMLPlugin, which specifies that directory names should be used as identifiers. This works for collections where each document is in a separate directory. We have used this option to ensure that identifiers remain the same across different platforms (which may not be the case for HASH identifiers), as we need to specify identifiers here for the <i>documentSet</i>s controlling exceptions to the default access granted (or withheld) by the <i>security</i> element.</p>
    4141
    42 description6=<p>The <i>security</i> directive element specifies the Greenstone <i>group</i>s for to which access will be permitted, if the document (or collection) is one of those that requires authentication. The security element is to contain <i>exception</i> and <i>documentSet</i> elements to define one or more group names that will override the <i>default_access</i> set on the security element (whether all documents are private by default, for example, in which case <i>exception</i> elements define which groups <i>do</i> have access to the collection materials). The Greenstone <i>admin</i> pages allow you to define groups and add members to them.</p>
     42description6=QQQQ<p>The <i>security</i> directive element specifies the Greenstone <i>group</i>s for to which access will be permitted, if the document (or collection) is one of those that requires authentication. The security element is to contain <i>exception</i> and <i>documentSet</i> elements to define one or more group names that will override the <i>default_access</i> set on the security element (whether all documents are private by default, for example, in which case <i>exception</i> elements define which groups <i>do</i> have access to the collection materials). The Greenstone <i>admin</i> pages allow you to define groups and add members to them.</p>
    4343
    44 description7=<p>For more information on authentication in GS3, the different possibilities when using the <i>security</i> element in a GS3 collectionConfig file, and creating new users and adding them to groups, refer to the following pages on the Greenstone wiki \n\
     44description7=QQQQ<p>For more information on authentication in GS3, the different possibilities when using the <i>security</i> element in a GS3 collectionConfig file, and creating new users and adding them to groups, refer to the following pages on the Greenstone wiki \n\
    4545<ul> \n\
    46 <li><a href="http\://wiki.greenstone.org/doku.php?id=en\:user\:authentication">Authentication in Greenstone</a></li> \n\
    47 <li><a href="http\://wiki.greenstone.org/doku.php?id=en\:user_advanced\:security">Security in Greenstone Collections</a></li> \n\
    48 <li><a href="http\://wiki.greenstone.org/doku.php?id=en\:user_advanced\:gs3_user_management">Greenstone 3 User Management</a></li> \n\
     46<li><a href=QQQQ"http\://wiki.greenstone.org/doku.php?id=en\:user\:authentication">Authentication in Greenstone</a></li> \n\
     47<li><a href=QQQQ"http\://wiki.greenstone.org/doku.php?id=en\:user_advanced\:security">Security in Greenstone Collections</a></li> \n\
     48<li><a href=QQQQ"http\://wiki.greenstone.org/doku.php?id=en\:user_advanced\:gs3_user_management">Greenstone 3 User Management</a></li> \n\
    4949</ul> \n\
    5050</p>

  • documented-examples/trunk/bibtex-e/resources/collectionConfig.properties

    r36589 r36614  
    1 name=Bibliography collection
     1name=QQQQBibliography collection
    22
    3 ShowBibTeXrecord=Show BibTeX Record
    4 HideBibTeXrecord=Hide BibTeX Record
    5 Number=Number
    6 AuthoredBy=Authored By
    7 PaperTitle=Paper Title
    8 DocType=DocType
    9 BookJournalTitle=Book/Journal Title
    10 BibTeXrecord=BibTeX Record
    11 PublicationDate=Publication Date
    12 Editors=Editor(s)
    13 PublicationPlace=Publication Place
    14 Annotations=Annotations
    15 Abstract=Abstract
    16 Pages=Pages
    17 Keywords=Keywords
    18 In=In
    19 EditorRole=Editor Role
    20 Vol=Vol.
    21 MeetingPlace=Meeting Place
    22 Publisher=Publisher
    23 LocationURL=Location/URL
    24 MeetingDate=Meeting Date
     3ShowBibTeXrecord=QQQQShow BibTeX Record
     4HideBibTeXrecord=QQQQHide BibTeX Record
     5Number=QQQQNumber
     6AuthoredBy=QQQQAuthored By
     7PaperTitle=QQQQPaper Title
     8DocType=QQQQDocType
     9BookJournalTitle=QQQQBook/Journal Title
     10BibTeXrecord=QQQQBibTeX Record
     11PublicationDate=QQQQPublication Date
     12Editors=QQQQEditor(s)
     13PublicationPlace=QQQQPublication Place
     14Annotations=QQQQAnnotations
     15Abstract=QQQQAbstract
     16Pages=QQQQPages
     17Keywords=QQQQKeywords
     18In=QQQQIn
     19EditorRole=QQQQEditor Role
     20Vol=QQQQVol.
     21MeetingPlace=QQQQMeeting Place
     22Publisher=QQQQPublisher
     23LocationURL=QQQQLocation/URL
     24MeetingDate=QQQQMeeting Date
    2525
    26 source_text=filenames
    27 text_text=full records
    28 Title_text=titles
    29 sampleoid_text=13/2004
     26source_text=QQQQfilenames
     27text_text=QQQQfull records
     28Title_text=QQQQtitles
     29sampleoid_text=QQQQ13/2004
    3030
    31 shortDescription=<p>This collection, which contains 135 BibTeX entries, is a collection of working papers published from 1997 to 2006 at <a href="http\://www.cs.waikato.ac.nz/">Department of Computer Science</a>, <a href="http\://www.waikato.ac.nz/">the University of Waikato</a>.</p>
     31shortDescription=QQQQ<p>This collection, which contains 135 BibTeX entries, is a collection of working papers published from 1997 to 2006 at <a href="http\://www.cs.waikato.ac.nz/">Department of Computer Science</a>, <a href="http\://www.waikato.ac.nz/">the University of Waikato</a>.</p>
    3232
    33 description1=<h3>How the collection works</h3><p>The collection configuration file (the collection\'s <tt>etc/collectionConfig.xml</tt>) begins with the specification <i>groupsize 200</i>. This groups 200 documents together into a single archive file. Bibliography collections typically have many small documents, and grouping them together prevents Greenstone\'s internal file structures from becoming bloated and occupying more disk space than necessary.</p>
     33description1=QQQQ<h3>How the collection works</h3><p>The collection configuration file (the collection\'s <tt>etc/collectionConfig.xml</tt>) begins with the specification <i>groupsize 200</i>. This groups 200 documents together into a single archive file. Bibliography collections typically have many small documents, and grouping them together prevents Greenstone\'s internal file structures from becoming bloated and occupying more disk space than necessary.</p>
    3434
    35 description2=<p>Apart from the standard plugins, this collection uses <i>BibTexPlugin</i>, which processes references in the BibTeX format (well known to computer scientists). Two options have been set for BibTexPlugin\: <i>-OIDtype assigned -OIDmetadata Number</i>. This means the metadata element "Number" will be used as the record identifier, instead of Greenstone\'s default hash identifiers. These options are available for all plugins.</p>
     35description2=QQQQ<p>Apart from the standard plugins, this collection uses <i>BibTexPlugin</i>, which processes references in the BibTeX format (well known to computer scientists). Two options have been set for BibTexPlugin\: <i>-OIDtype assigned -OIDmetadata Number</i>. This means the metadata element "Number" will be used as the record identifier, instead of Greenstone\'s default hash identifiers. These options are available for all plugins.</p>
    3636
    37 description3=<p>Fielded searching, with a form-based interface, is selected by <i>format SearchTypes "form,plain" </i> in the configuration file. In fact, a plain textual full-text search index is included in this collection as well (since <i>form</i> comes first, it is the default interface; you reach the <i>plain</i> search through the <i>Preferences</i> page).</p>
     37description3=QQQQ<p>Fielded searching, with a form-based interface, is selected by <i>format SearchTypes "form,plain" </i> in the configuration file. In fact, a plain textual full-text search index is included in this collection as well (since <i>form</i> comes first, it is the default interface; you reach the <i>plain</i> search through the <i>Preferences</i> page).</p>
    3838
    39 description4=<p>The <i>buildtype</i> option shows that the default search engine <i>mgpp</i> is used. The <i>indexes</i> line specifies indexes for "text", and "metadata". In this case, "text" will be the original BibTeX record. "metadata" is a special keyword signifying that an index should be built for any metadata item found in the collection. Thus when the "field" menus in the collection\'s <a href="library/collection/bibtex-e/search/FieldQuery">search page</a> are pulled down, they show <i>full records</i> followed by an entry for each metadata element. In the collection\'s <tt>resources/collectionConfig.properties</tt> file, collection-level metadata <i>collectionmeta</i> can be specified for any index to determine what it is called (except for <i>metadata</i>, which produces many menu items). In this case, the <i>collectionConfig.properties</i> file specifies that the <i>text</i> index (referred to by collection\'s configuration file, <tt>collectionConfig.xml</tt>) should be named "full records" because it contains the original bibliographic record.</p>
     39description4=QQQQ<p>The <i>buildtype</i> option shows that the default search engine <i>mgpp</i> is used. The <i>indexes</i> line specifies indexes for "text", and "metadata". In this case, "text" will be the original BibTeX record. "metadata" is a special keyword signifying that an index should be built for any metadata item found in the collection. Thus when the "field" menus in the collection\'s <a href="library/collection/bibtex-e/search/FieldQuery">search page</a> are pulled down, they show <i>full records</i> followed by an entry for each metadata element. In the collection\'s <tt>resources/collectionConfig.properties</tt> file, collection-level metadata <i>collectionmeta</i> can be specified for any index to determine what it is called (except for <i>metadata</i>, which produces many menu items). In this case, the <i>collectionConfig.properties</i> file specifies that the <i>text</i> index (referred to by collection\'s configuration file, <tt>collectionConfig.xml</tt>) should be named "full records" because it contains the original bibliographic record.</p>
    4040
    41 description5=<p>An additional keyword, "allfields", could also be used in the <i>indexes</i> line, specifying that combined searching over all indexes should be available.</p>
     41description5=QQQQ<p>An additional keyword, "allfields", could also be used in the <i>indexes</i> line, specifying that combined searching over all indexes should be available.</p>
    4242
    43 description6=<p>The <i>levels</i> lines specifies only document level, as bibliographic records don\'t have internal structure.</p>
     43description6=QQQQ<p>The <i>levels</i> lines specifies only document level, as bibliographic records don\'t have internal structure.</p>
    4444
    45 description7=<p>This collection contains <i>Title, Author</i>, and <i>Date</i> browsers. The <i>AZCompactList</i> classifier used for the <i>Author</i> browser is like <i>AZList</i> but generates a bookshelf for duplicate items. The BibTeX plugin records each author as <i>Author</i> metadata; it also puts a list containing all authors into the <i>Creator</i> metadata element. Consequently the <i>AZCompactList</i> classifier is based on <i>Author</i>. However, Greenstone has a standard button reading <i>authors</i> whose name is (confusingly) "Creator", so this button name is specified for the classifier.</p>
     45description7=QQQQ<p>This collection contains <i>Title, Author</i>, and <i>Date</i> browsers. The <i>AZCompactList</i> classifier used for the <i>Author</i> browser is like <i>AZList</i> but generates a bookshelf for duplicate items. The BibTeX plugin records each author as <i>Author</i> metadata; it also puts a list containing all authors into the <i>Creator</i> metadata element. Consequently the <i>AZCompactList</i> classifier is based on <i>Author</i>. However, Greenstone has a standard button reading <i>authors</i> whose name is (confusingly) "Creator", so this button name is specified for the classifier.</p>
    4646
    47 description8=<p>The format statements for the search results list and the title browser are both determined by the <i>VList</i> specification. It gives a document icon that links to the document itself (which in this collection is the full reference); the title in bold; <i>Creator</i> metadata if there is any, otherwise <i>Editor</i> metadata; and <i>Month, Year</i> metadata if there is any. <a href="library/collection/bibtex-e/search/FieldQuery?a=q&sa=&rt=rd&s1.level=Doc&s1.case=1&s1.stem=0&s1.matchMode=some&s1.sortBy=1&s1.maxDocs=50&s1.fqv=Jain&s1.fqf=TX&s1.fqv=&s1.fqf=NU&s1.fqv=&s1.fqf=NU&s1.fqv=&s1.fqf=NU&s1.hitsPerPage=20">Here</a> is an example.</p>
     47description8=QQQQ<p>The format statements for the search results list and the title browser are both determined by the <i>VList</i> specification. It gives a document icon that links to the document itself (which in this collection is the full reference); the title in bold; <i>Creator</i> metadata if there is any, otherwise <i>Editor</i> metadata; and <i>Month, Year</i> metadata if there is any. <a href="library/collection/bibtex-e/search/FieldQuery?a=q&sa=&rt=rd&s1.level=Doc&s1.case=1&s1.stem=0&s1.matchMode=some&s1.sortBy=1&s1.maxDocs=50&s1.fqv=Jain&s1.fqf=TX&s1.fqv=&s1.fqf=NU&s1.fqv=&s1.fqf=NU&s1.fqv=&s1.fqf=NU&s1.hitsPerPage=20">Here</a> is an example.</p>
    4848
    49 description9=<p>The format statement for the author browser (<i>CL2VList</i>) is more complex. The <i>AZCompactList</i> classifier generates a tree whose nodes are either leaf nodes, representing documents, or internal nodes. A metadata item called <i>numleafdocs</i> gives the total number of documents below an internal node. This format statement checks whether numleafdocs exists. If so the node must be an internal node, in which case the node is labeled by its <i>Title</i>. But beware\: this classifier is generated on <i>Author</i> metadata, so its title -- the title of the classifier -- is actually the author\'s name! This means that the bookshelf nodes <a href="library/collection/bibtex-e/browse/CL2">here</a> are labeled by author\'s name. The leaf nodes, however, are labeled the same way as documents (i.e. references) are in the search results list.</p>
     49description9=QQQQ<p>The format statement for the author browser (<i>CL2VList</i>) is more complex. The <i>AZCompactList</i> classifier generates a tree whose nodes are either leaf nodes, representing documents, or internal nodes. A metadata item called <i>numleafdocs</i> gives the total number of documents below an internal node. This format statement checks whether numleafdocs exists. If so the node must be an internal node, in which case the node is labeled by its <i>Title</i>. But beware\: this classifier is generated on <i>Author</i> metadata, so its title -- the title of the classifier -- is actually the author\'s name! This means that the bookshelf nodes <a href="library/collection/bibtex-e/browse/CL2">here</a> are labeled by author\'s name. The leaf nodes, however, are labeled the same way as documents (i.e. references) are in the search results list.</p>
    5050
    51 description10=<p>The documents themselves (here is an <a href="library/collection/bibtex-e/document/98_9">example</a>) are generated by two format statements, one (a long one) called <i>DocumentHeading</i>, and another called <i>DocumentContent</i>. The <i>DocumentHeading</i>, which is the top two-thirds of the page, contains the document\'s <i>Title</i> followed by a table that gives all the metadata elements that the BibTeX plugin can generate. The role of all the <i>gsf\:switch</i> statements in the collection cofiguration file, <tt>collectionConfig.xml</tt>, is to determine which elements are defined.</p>
     51description10=QQQQ<p>The documents themselves (here is an <a href="library/collection/bibtex-e/document/98_9">example</a>) are generated by two format statements, one (a long one) called <i>DocumentHeading</i>, and another called <i>DocumentContent</i>. The <i>DocumentHeading</i>, which is the top two-thirds of the page, contains the document\'s <i>Title</i> followed by a table that gives all the metadata elements that the BibTeX plugin can generate. The role of all the <i>gsf\:switch</i> statements in the collection cofiguration file, <tt>collectionConfig.xml</tt>, is to determine which elements are defined.</p>
    5252
    53 description11=<p>The <i>DocumentContent</i> has been overridden. When the document is displayed initially, only a hyperlink reading <i>Show/Hide BibTex Record</i> appears -- clicking this invokes JavaScript to toggle the display of the raw BibTex record (showing the BibText version of the reference), which is hidden by default.</p>
     53description11=QQQQ<p>The <i>DocumentContent</i> has been overridden. When the document is displayed initially, only a hyperlink reading <i>Show/Hide BibTex Record</i> appears -- clicking this invokes JavaScript to toggle the display of the raw BibTex record (showing the BibText version of the reference), which is hidden by default.</p>

  • documented-examples/trunk/dls-e/resources/collectionConfig.properties

    r36596 r36614  
    1 name=Development Library Subset collection
    2 section_Title=section titles
    3 section_text=chapters
    4 document_text=entire documents
    5 document=Document
    6 textdate=publication date\:
    7 textnumpages=no. of pages\:
    8 textsource=source ref\:
     1name=QQQQDevelopment Library Subset collection
     2section_Title=QQQQsection titles
     3section_text=QQQQchapters
     4document_text=QQQQentire documents
     5document=QQQQDocument
     6textdate=QQQQpublication date\:
     7textnumpages=QQQQno. of pages\:
     8textsource=QQQQsource ref\:
    99
    1010
    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>
     11shortDescription=QQQQ<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>
    1212
    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>.
     13description0=QQQQ<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>.
    1414
    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>
     15description1=QQQQ<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>
    1616
    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>
     17description2=QQQQ<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>
    1818
    19 description3=<p><b>Plugins</b>. The "plugin" lines in the collection configuration file give the plugins used by the collection. The documents in the DLS collection are in HTML, so <i>HTMLPlugin</i> must be included. The <i>description_tags</i> option processes tags in the text that define sections and section titles as described below.</p>
     19description3=QQQQ<p><b>Plugins</b>. The "plugin" lines in the collection configuration file give the plugins used by the collection. The documents in the DLS collection are in HTML, so <i>HTMLPlugin</i> must be included. The <i>description_tags</i> option processes tags in the text that define sections and section titles as described below.</p>
    2020
    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>
     21description4=QQQQ<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>
    2222
    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>
     23description5=QQQQ<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>
    2424
    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>
     25description6=QQQQ<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>
    2626
    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>
     27description7=QQQQ<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>
    2828
    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>
     29description8=QQQQ<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>
    3030
    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>
     31description9=QQQQ<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>
    3232
    33 description10=<p><b>Format statements</b>. The <i>format</i> elements (&lt;format;&gt;, &lt;browse&gt;, &lt;search&gt; and &lt;display&gt; XML elements), called "format statements", govern how various parts of the collection should be displayed. The <i>VList</i> format statement applies to lists of items displayed vertically, such as the lists of titles, subjects and organisations, and the table of contents for the target documents. It is overridden for the search results list by the <i>SearchVList</i> format statement, and also for the <i>Howto</i> classifier by the <i>CL4VList</i> statement (CL4 specifies the fourth classifier).</p>
     33description10=QQQQ<p><b>Format statements</b>. The <i>format</i> elements (&lt;format;&gt;, &lt;browse&gt;, &lt;search&gt; and &lt;display&gt; XML elements), called "format statements", govern how various parts of the collection should be displayed. The <i>VList</i> format statement applies to lists of items displayed vertically, such as the lists of titles, subjects and organisations, and the table of contents for the target documents. It is overridden for the search results list by the <i>SearchVList</i> format statement, and also for the <i>Howto</i> classifier by the <i>CL4VList</i> statement (CL4 specifies the fourth classifier).</p>
    3434
    35 description11=<p>The <i>DocumentText</i> statement governs how the document text is formatted, with <i>Title</i> metadata ([<i>Title</i>]) in HTML <i>heading</i> format followed by the text of the document [<i>Text</i>]. By default, cover images are shown with each document (<i>DocumentImages</i>), and the <i>DocumentButtons</i> are available\: the <i>Expand Text, Expand Contents, Detach</i> and <i>Highlight</i> buttons are shown with each document.</p>
     35description11=QQQQ<p>The <i>DocumentText</i> statement governs how the document text is formatted, with <i>Title</i> metadata ([<i>Title</i>]) in HTML <i>heading</i> format followed by the text of the document [<i>Text</i>]. By default, cover images are shown with each document (<i>DocumentImages</i>), and the <i>DocumentButtons</i> are available\: the <i>Expand Text, Expand Contents, Detach</i> and <i>Highlight</i> buttons are shown with each document.</p>
    3636
    37 description12=<p>Greenstone 3 uses XML for format statements, allowing librarians with XML experience to more easily understand and use format statements than Greenstone 2 which worked with a custom way of specifying format statements. For more information on understanding format statements and writing your own format statements for collections, refer to <a href="http\://wiki.greenstone.org/doku.php?id=en\:user\:gs3_format_statements">Greenstone 3 Format Statements</a> on the Greenstone wiki.</p>
     37description12=QQQQ<p>Greenstone 3 uses XML for format statements, allowing librarians with XML experience to more easily understand and use format statements than Greenstone 2 which worked with a custom way of specifying format statements. For more information on understanding format statements and writing your own format statements for collections, refer to <a href="http\://wiki.greenstone.org/doku.php?id=en\:user\:gs3_format_statements">Greenstone 3 Format Statements</a> on the Greenstone wiki.</p>
    3838
    39 description13=<p><b>Collection-level metadata</b>. The <i>&lt;displayItem&gt;</i> elements under the top-level <i>&lt;displayItemList&gt;</i> in the configuration file are also standard in all Greenstone collections. They give general information about the collection, defining its name, and a description that appears on its home page. The description text (defined in the translatable <tt>resources/collectionConfig.properties</tt> files) can be seen on the DLS collection\'s home page (this text is part of it).</p>
     39description13=QQQQ<p><b>Collection-level metadata</b>. The <i>&lt;displayItem&gt;</i> elements under the top-level <i>&lt;displayItemList&gt;</i> in the configuration file are also standard in all Greenstone collections. They give general information about the collection, defining its name, and a description that appears on its home page. The description text (defined in the translatable <tt>resources/collectionConfig.properties</tt> files) can be seen on the DLS collection\'s home page (this text is part of it).</p>
    4040
    41 description14=<p><b>Language translations</b>. In the collection configuration file, lines that look like <tt>&lt;displayItem assigned="true" dictionary="collectionConfig" key="..." name="..."/&gt;</tt> allow for translatable collection-level metadata, that are defined in the <tt>resources/collectionConfig.properties</tt> text files and can be translated in the same location such as by creating French and Spanish versions (in <tt>resources/collectionConfig_fr.properties</tt> and <tt>resources/collectionConfig_es.properties</tt>, respectively). Note that we advise translators to go through the GTI (Greenstone Translation Interface) system if they want to contribute translations to Greenstone as used by everyone, such as translations to Greenstone\'s demo collections and these documented example collections. The properties files allow for accented characters (e.g. French <i>é</i>). The files are in UTF-8, and these characters are represented by multi-byte sequences (&lt;C3&gt;&lt;A9&gt; in this case). Alternatively they could be represented by their HTML entity names (like <i>& eacute ;</i>). It makes no difference for how they appear on the screen.</p>
     41description14=QQQQ<p><b>Language translations</b>. In the collection configuration file, lines that look like <tt>&lt;displayItem assigned="true" dictionary="collectionConfig" key="..." name="..."/&gt;</tt> allow for translatable collection-level metadata, that are defined in the <tt>resources/collectionConfig.properties</tt> text files and can be translated in the same location such as by creating French and Spanish versions (in <tt>resources/collectionConfig_fr.properties</tt> and <tt>resources/collectionConfig_es.properties</tt>, respectively). Note that we advise translators to go through the GTI (Greenstone Translation Interface) system if they want to contribute translations to Greenstone as used by everyone, such as translations to Greenstone\'s demo collections and these documented example collections. The properties files allow for accented characters (e.g. French <i>é</i>). The files are in UTF-8, and these characters are represented by multi-byte sequences (&lt;C3&gt;&lt;A9&gt; in this case). Alternatively they could be represented by their HTML entity names (like <i>& eacute ;</i>). It makes no difference for how they appear on the screen.</p>
    4242
    43 description15=<p><b>Description tags</b>. The description tags recognized by <i>HTMLPlugin</i> are inserted into the HTML source text of the documents to define where sections begin and end, and to specify section titles. They look like this\: <pre> &lt;!-- &lt;Section&gt; &lt;Description&gt; &lt;Metadata name="Title"&gt; Realizing human rights for poor people\: Strategies for achieving the international development targets &lt;/Metadata&gt; &lt;/Description&gt; --&gt; (text of section goes here) &lt;!-- &lt;/Section&gt; --&gt; </pre> The &lt;!-- ... --&gt; markers are used to ensure that these tags are marked as comments in HTML and therefore do not affect document formatting. In the <i>Description</i> part other kinds of metadata can be specified, but this is not done for the style of collection we are describing here. Exactly the same specification (including the &lt;!-- ... --&gt; markers) can be used in Word documents too.</p>
     43description15=QQQQ<p><b>Description tags</b>. The description tags recognized by <i>HTMLPlugin</i> are inserted into the HTML source text of the documents to define where sections begin and end, and to specify section titles. They look like this\: <pre> &lt;!-- &lt;Section&gt; &lt;Description&gt; &lt;Metadata name="Title"&gt; Realizing human rights for poor people\: Strategies for achieving the international development targets &lt;/Metadata&gt; &lt;/Description&gt; --&gt; (text of section goes here) &lt;!-- &lt;/Section&gt; --&gt; </pre> The &lt;!-- ... --&gt; markers are used to ensure that these tags are marked as comments in HTML and therefore do not affect document formatting. In the <i>Description</i> part other kinds of metadata can be specified, but this is not done for the style of collection we are describing here. Exactly the same specification (including the &lt;!-- ... --&gt; markers) can be used in Word documents too.</p>
    4444
    45 description16=<p><b>Metadata Files</b>. Metadata for all documents in the DLS collection is provided in metadata.xml files, one per document folder. In this collection\'s <tt>import/r0087e</tt> is the <tt>metadata.xml</tt> file for one book -- <i>Income generation and money management\: training women as entrepreneurs</i> -- which is a block of about ten lines encased in &lt;<i>FileSet</i>&gt; ... &lt;<i>/FileSet</i>&gt; tags. It defines <i>dls.Title</i>, <i>dls.Language</i>, <i>dls.Subject</i> and <i>dls.AZList</i> metadata. More than one value can be specified for any metadata item. For example, this book has two dls.Subject classifications. Both of these are stored as metadata values for this particular document (because <i>mode=accumulate</i> is specified; the alternative, and the default, is <i>mode=override</i>).</p>
     45description16=QQQQ<p><b>Metadata Files</b>. Metadata for all documents in the DLS collection is provided in metadata.xml files, one per document folder. In this collection\'s <tt>import/r0087e</tt> is the <tt>metadata.xml</tt> file for one book -- <i>Income generation and money management\: training women as entrepreneurs</i> -- which is a block of about ten lines encased in &lt;<i>FileSet</i>&gt; ... &lt;<i>/FileSet</i>&gt; tags. It defines <i>dls.Title</i>, <i>dls.Language</i>, <i>dls.Subject</i> and <i>dls.AZList</i> metadata. More than one value can be specified for any metadata item. For example, this book has two dls.Subject classifications. Both of these are stored as metadata values for this particular document (because <i>mode=accumulate</i> is specified; the alternative, and the default, is <i>mode=override</i>).</p>
    4646
    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>
     47description17=QQQQ<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>
    4848
    49 description18=<p>For example, the following shows three lines from the subject hierarchy file <tt>etc/dls.Subject.txt</tt>. \n\
     49description18=QQQQ<p>For example, the following shows three lines from the subject hierarchy file <tt>etc/dls.Subject.txt</tt>. \n\
    5050<pre> "Animal Husbandry and Animal Product Processing " \n\
    51517  "Animal Husbandry and Animal Product Processing "   "Animal Husbandry and Animal Product Processing|Cattle " \n\
    … …  
    5555</p>
    5656
    57 description19=<p>These three lines define one top level bookshelf (at position 7), titled  "Animal Husbandry and Animal Product Processing ", with two bookshelves underneath it, titled  "Cattle " and  "Other animals (micro-livestock, little known animals, silkworms, reptiles, frogs, snails, game, etc.) " respectively.</p>
     57description19=QQQQ<p>These three lines define one top level bookshelf (at position 7), titled  "Animal Husbandry and Animal Product Processing ", with two bookshelves underneath it, titled  "Cattle " and  "Other animals (micro-livestock, little known animals, silkworms, reptiles, frogs, snails, game, etc.) " respectively.</p>
    5858
    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>
     59description20=QQQQ<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>
    6060
    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>
     61description21=QQQQ<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>

  • documented-examples/trunk/garish-e/resources/collectionConfig.properties

    r36589 r36614  
    1 name=Custom stylesheet demo collection
     1name=QQQQCustom stylesheet demo collection
    22
    3 textdate=publication date\:
    4 textnumpages=no. of pages\:
    5 textsource=source ref\:
     3textdate=QQQQpublication date\:
     4textnumpages=QQQQno. of pages\:
     5textsource=QQQQsource ref\:
    66
    7 dls.Organization=Organizations
    8 dls.Titles=Titles
    9 dls.Keyword=How to
    10 dls.Subject=Subjects
    11 index_text=Text
    12 index_document=Book
    13 index_section=Chapter
     7dls.Organization=QQQQOrganizations
     8dls.Titles=QQQQTitles
     9dls.Keyword=QQQQHow to
     10dls.Subject=QQQQSubjects
     11index_text=QQQQText
     12index_document=QQQQBook
     13index_section=QQQQChapter
    1414
    15 shortDescription=<p>This demonstration collection contains the same material as the original Greenstone demo collection, but its appearance has been altered slightly using a custom stylesheet.</p>
     15shortDescription=QQQQ<p>This demonstration collection contains the same material as the original Greenstone demo collection, but its appearance has been altered slightly using a custom stylesheet.</p>
    1616
    17 description1=<p>Greenstone 3 uses default stylesheets, which can be overridden for all collections in a site or for any particular collection. This documented example collection covers the last case.</p>
     17description1=QQQQ<p>Greenstone 3 uses default stylesheets, which can be overridden for all collections in a site or for any particular collection. This documented example collection covers the last case.</p>
    1818
    19 description2=<h3>How the collection works</h3><p>The <b>global</b> format statement contains a link to the collection\'s custom stylesheet, which is located inside the collection\: \n\
    20 <pre>&lt;xsl\:template name="additionalHeaderContent"&gt; \n\
    21     &lt;xsl\:variable name="httpCollection"&gt; \n\
    22       &lt;xsl\:value-of select="/page/pageResponse/collection/metadataList/metadata[@name='httpPath']"/&gt; \n\
     19description2=QQQQ<h3>How the collection works</h3><p>The <b>global</b> format statement contains a link to the collection\'s custom stylesheet, which is located inside the collection\: \n\
     20<pre>&lt;xsl\:template name=QQQQ"additionalHeaderContent"&gt; \n\
     21    &lt;xsl\:variable name=QQQQ"httpCollection"&gt; \n\
     22      &lt;xsl\:value-of select=QQQQ"/page/pageResponse/collection/metadataList/metadata[@name='httpPath']"/&gt; \n\
    2323    &lt;/xsl\:variable&gt; \n\
    24     &lt;link href="{$httpCollection}/style/style.css" rel="stylesheet" type="text/css"/&gt; \n\
     24    &lt;link href=QQQQ"{$httpCollection}/style/style.css" rel="stylesheet" type="text/css"/&gt; \n\
    2525  &lt;/xsl\:template&gt; \n\
    2626</pre> \n\
    2727</p>
    2828
    29 description3=<p>Next, a folder named <i>style</i> is created within the collection and a new text file, called <i>custom-style.css</i>, is created within that folder. The css suffix indicates it\'s a <i>Cascading Style Sheet</i>. CSS files define the look of web pages such as the colours, borders, fonts, heading styles and more. CSS files are just text files, and can thus be edited with any text editor.</p>
     29description3=QQQQ<p>Next, a folder named <i>style</i> is created within the collection and a new text file, called <i>custom-style.css</i>, is created within that folder. The css suffix indicates it\'s a <i>Cascading Style Sheet</i>. CSS files define the look of web pages such as the colours, borders, fonts, heading styles and more. CSS files are just text files, and can thus be edited with any text editor.</p>
    3030
    31 description4=<p>The default Greenstone CSS style sheets define certain styles for all collections, that are <i>overridden</i> for the collection by defining CSS rules within its new custom stylesheet. It is by linking the CSS file in the Greenstone collection\'s <b>global</b> format statement as above, that the general Greenstone CSS styling rules get overridden at the collection level.</p>
     31description4=QQQQ<p>The default Greenstone CSS style sheets define certain styles for all collections, that are <i>overridden</i> for the collection by defining CSS rules within its new custom stylesheet. It is by linking the CSS file in the Greenstone collection\'s <b>global</b> format statement as above, that the general Greenstone CSS styling rules get overridden at the collection level.</p>
    3232
    33 description5=<p>You can quickly learn how to write CSS at <a href="https\://www.w3schools.com/css/default.asp">W3schools</a> and other online sites.</p>
     33description5=QQQQ<p>You can quickly learn how to write CSS at <a href="https\://www.w3schools.com/css/default.asp">W3schools</a> and other online sites.</p>
    3434

  • documented-examples/trunk/gsarch-e/resources/collectionConfig.properties

    r36598 r36614  
    1 name=Greenstone Archives collection
    2 SearchBySender=search by sender
    3 Subject=Subject
    4 Date=Date
    5 From=From
    6 ReplyTo=In reply to
    7 index_text=Messages
    8 index_subject=Subject lines
    9 index_from=From fields
     1name=QQQQGreenstone Archives collection
     2SearchBySender=QQQQsearch by sender
     3Subject=QQQQSubject
     4Date=QQQQDate
     5From=QQQQFrom
     6ReplyTo=QQQQIn reply to
     7index_text=QQQQMessages
     8index_subject=QQQQSubject lines
     9index_from=QQQQFrom fields
    1010
    11 shortDescription=<p>This is a collection of email messages from the Greenstone mailing list archives, from November/December, 2008.</p>
     11shortDescription=QQQQ<p>This is a collection of email messages from the Greenstone mailing list archives, from November/December, 2008.</p>
    1212
    13 description1=<h3>How the collection works</h3><p>The Greenstone Archives collection uses the <i>Email</i> plugin, which parses files in email formats. In this case, there is a file per month per mailing list, and each file contains many email messages. The <i>Email</i> plugin splits these into individual documents, and produces <i>Title</i>, <i>Subject</i>, <i>From</i>, <i>FromName</i>, <i>FromAddr</i>, <i>Date</i>, <i>DateText</i>, <i>InReplyTo</i>, and optionally <i>Headers</i>, metadata.</p>
     13description1=QQQQ<h3>How the collection works</h3><p>The Greenstone Archives collection uses the <i>Email</i> plugin, which parses files in email formats. In this case, there is a file per month per mailing list, and each file contains many email messages. The <i>Email</i> plugin splits these into individual documents, and produces <i>Title</i>, <i>Subject</i>, <i>From</i>, <i>FromName</i>, <i>FromAddr</i>, <i>Date</i>, <i>DateText</i>, <i>InReplyTo</i>, and optionally <i>Headers</i>, metadata.</p>
    1414
    15 description2=<p>The collection configuration file, <tt>etc/collectionConfig.xml</tt> specifies <i>&lt;importOption name="groupsize" value="200"/&gt;</i>. This groups documents together into groups of 200. Email collections typically have many small documents, and grouping them together prevents Greenstone\'s internal file structures from becoming bloated and occupying more disk space than necessary. Notice that the <i>Email</i> plugin first splits the input files up into individual Emails, then <i>groupsize</i> groups them together again. This allows the collection designer to control what is going on.</p>
     15description2=QQQQ<p>The collection configuration file, <tt>etc/collectionConfig.xml</tt> specifies <i>&lt;importOption name="groupsize" value="200"/&gt;</i>. This groups documents together into groups of 200. Email collections typically have many small documents, and grouping them together prevents Greenstone\'s internal file structures from becoming bloated and occupying more disk space than necessary. Notice that the <i>Email</i> plugin first splits the input files up into individual Emails, then <i>groupsize</i> groups them together again. This allows the collection designer to control what is going on.</p>
    1616
    17 description3=<p>The <i>indexes</i> line specifies 3 searchable indexes, which can be seen by clicking beside the word "Messages" on the <a href="library/collection/gsarch-e/search/TextQuery">search page</a> to reveal a drop-down menu. The first (called <i>Messages</i>) is created from the document text, while the others are formed from <i>From</i> and <i>Subject</i> metadata.</p>
     17description3=QQQQ<p>The <i>indexes</i> line specifies 3 searchable indexes, which can be seen by clicking beside the word "Messages" on the <a href="library/collection/gsarch-e/search/TextQuery">search page</a> to reveal a drop-down menu. The first (called <i>Messages</i>) is created from the document text, while the others are formed from <i>From</i> and <i>Subject</i> metadata.</p>
    1818
    19 description4=<p>There are three classifiers, based on <i>Subject</i>, <i>FromName</i>, and <i>Date</i> metadata. The <i>AZCompactList</i> classifier used for the first two is like <i>AZList</i> but generates a bookshelf for duplicate items, as illustrated <a href="library/collection/gsarch-e/browse/CL1">here</a>. This is represented by a tree structure whose nodes are either leaf nodes, representing documents, or internal nodes. A metadata item called numleafdocs gives the total number of documents below an internal node. The format statement for the first classifier, called <i>CL1Vlist</i>, checks whether this item exists. If so the node must be an internal one, in which case it is labeled by its <i>Title</i>. Otherwise the node\'s label starts with the <i>Subject</i> which links to the document, then gives <i>FromName</i> metadata, with a link to "Search by Sender", followed by the <i>DateText</i>.</p>
     19description4=QQQQ<p>There are three classifiers, based on <i>Subject</i>, <i>FromName</i>, and <i>Date</i> metadata. The <i>AZCompactList</i> classifier used for the first two is like <i>AZList</i> but generates a bookshelf for duplicate items, as illustrated <a href="library/collection/gsarch-e/browse/CL1">here</a>. This is represented by a tree structure whose nodes are either leaf nodes, representing documents, or internal nodes. A metadata item called numleafdocs gives the total number of documents below an internal node. The format statement for the first classifier, called <i>CL1Vlist</i>, checks whether this item exists. If so the node must be an internal one, in which case it is labeled by its <i>Title</i>. Otherwise the node\'s label starts with the <i>Subject</i> which links to the document, then gives <i>FromName</i> metadata, with a link to "Search by Sender", followed by the <i>DateText</i>.</p>
    2020
    21 description5=<p>The second classifier (<i>CL2Vlist</i>) is similar, but shows slightly different information -- the result can be seen <a href="library/collection/gsarch-e/browse/CL2">here</a>. For internal nodes, the actual number of leaf documents (<i>numleafdocs</i>) is given in parentheses after the <i>Title</i>. For document nodes the <i>FromName</i>, with a link to "Search By Sender", <i>Subject</i> (linked to the document), and <i>DateText</i> metadata is shown.</p>
     21description5=QQQQ<p>The second classifier (<i>CL2Vlist</i>) is similar, but shows slightly different information -- the result can be seen <a href="library/collection/gsarch-e/browse/CL2">here</a>. For internal nodes, the actual number of leaf documents (<i>numleafdocs</i>) is given in parentheses after the <i>Title</i>. For document nodes the <i>FromName</i>, with a link to "Search By Sender", <i>Subject</i> (linked to the document), and <i>DateText</i> metadata is shown.</p>
    2222
    23 description6=<p>The third classifier is a <i>DateList</i>, which allows selection by month and year.</p>
     23description6=QQQQ<p>The third classifier is a <i>DateList</i>, which allows selection by month and year.</p>
    2424
    25 description7=<p>Finally, the <tt>documentHeading</tt> is overridden to show the header fields\: <i>FromName</i>, <i>DateText</i>, <i>Subject</i>, <i>InReplyTo</i> (as the default documentHeading would not show the <i>InReplyTo</i> Field, nor to label the fields). The default <tt>documentContent</tt> already displays the message text (with the call to &lt;xsl\:call-template name="documentNodeText"/&gt;). <i>FromName</i> is linked to a search on that name, while <i>InReplyTo</i> links to the email message that it refers to.</p>
     25description7=QQQQ<p>Finally, the <tt>documentHeading</tt> is overridden to show the header fields\: <i>FromName</i>, <i>DateText</i>, <i>Subject</i>, <i>InReplyTo</i> (as the default documentHeading would not show the <i>InReplyTo</i> Field, nor to label the fields). The default <tt>documentContent</tt> already displays the message text (with the call to &lt;xsl\:call-template name="documentNodeText"/&gt;). <i>FromName</i> is linked to a search on that name, while <i>InReplyTo</i> links to the email message that it refers to.</p>

  • documented-examples/trunk/image-e/resources/collectionConfig.properties

    r36599 r36614  
    1 name=Simple image collection
    2 Height=Height
    3 Size=Size
    4 Width=Width
    5 ImageName=Image Name
    6 sampleoid=D2
     1name=QQQQSimple image collection
     2Height=QQQQHeight
     3Size=QQQQSize
     4Width=QQQQWidth
     5ImageName=QQQQImage Name
     6sampleoid=QQQQD2
    77
    8 shortDescription=<p>This is a basic image collection that contains no text and no explicit metadata. Several JPEG files are placed in the import directory prior to importing and building the collection, that\'s all.</p>
     8shortDescription=QQQQ<p>This is a basic image collection that contains no text and no explicit metadata. Several JPEG files are placed in the import directory prior to importing and building the collection, that\'s all.</p>
    99
    10 description1=<p>The images 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>
     10description1=QQQQ<p>The images 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>
    1111
    12 description2=<h3>How the collection works</h3><p><a href="library/collection/image-e/document/D2">Here</a> is a sample document in the collection. The configuration file, <tt>collectionConfig.xml</tt>, specifies no indexes, so the search button is suppressed.</p>
     12description2=QQQQ<h3>How the collection works</h3><p><a href="library/collection/image-e/document/D2">Here</a> is a sample document in the collection. The configuration file, <tt>collectionConfig.xml</tt>, specifies no indexes, so the search button is suppressed.</p>
    1313
    14 description3=<p>There is only one plugin, <i>ImagePlugin</i>, aside from the others that are always present (crucially <i>GreenstoneXMLPlugin</i>, <i>MetadataXMLPlugin</i>, <i>ArchivesInfPlugin</i>, <i>DirectoryPlugin</i>). <i>ImagePlugin</i> relies on the existence of two programs from the ImageMagick suite (<a href="http\://www.imagemagick.org">www.imagemagick.org</a>)\: <i>convert</i> and <i>identify</i>. Greenstone 3 binaries come bundled with Imagemagick as one of the components that can be optionally installed. Greenstone will not be able to build the collection correctly unless an ImageMagick is installed on your computer.</p>
     14description3=QQQQ<p>There is only one plugin, <i>ImagePlugin</i>, aside from the others that are always present (crucially <i>GreenstoneXMLPlugin</i>, <i>MetadataXMLPlugin</i>, <i>ArchivesInfPlugin</i>, <i>DirectoryPlugin</i>). <i>ImagePlugin</i> relies on the existence of two programs from the ImageMagick suite (<a href="http\://www.imagemagick.org">www.imagemagick.org</a>)\: <i>convert</i> and <i>identify</i>. Greenstone 3 binaries come bundled with Imagemagick as one of the components that can be optionally installed. Greenstone will not be able to build the collection correctly unless an ImageMagick is installed on your computer.</p>
    1515
    16 description4=<p><i>ImagePlugin</i> automatically creates a thumbnail and generates the following metadata for each image in the collection\:  <blockquote> <table border=0 cellspacing=0> <tr><td width=125 valign=top><i>Image</i></td><td>Name of file containing the image <tr> <tr><td valign=top><i>ImageWidth</i></td><td>Width of image (in pixels) <tr> <tr><td valign=top><i>ImageHeight</i></td><td>Height of image (in pixels) <tr> <tr><td valign=top><i>Thumb</i></td><td> Name of gif file containing thumbnail of image <tr> <tr><td valign=top><i>ThumbWidth</i></td><td>Width of thumbnail image (in pixels) <tr> <tr><td valign=top><i>ThumbHeight</i></td><td>Height of thumbnail image (in pixels) <tr> <tr><td valign=top><i>thumbicon</i></td><td>Full pathname specification of thumbnail image <tr> <tr><td valign=top><i>assocfilepath</i></td><td>Pathname of image directory in the collection\'s <i>assoc</i> directory <tr> </table> </blockquote></p>
     16description4=QQQQ<p><i>ImagePlugin</i> automatically creates a thumbnail and generates the following metadata for each image in the collection\:  <blockquote> <table border=0 cellspacing=0> <tr><td width=125 valign=top><i>Image</i></td><td>Name of file containing the image <tr> <tr><td valign=top><i>ImageWidth</i></td><td>Width of image (in pixels) <tr> <tr><td valign=top><i>ImageHeight</i></td><td>Height of image (in pixels) <tr> <tr><td valign=top><i>Thumb</i></td><td> Name of gif file containing thumbnail of image <tr> <tr><td valign=top><i>ThumbWidth</i></td><td>Width of thumbnail image (in pixels) <tr> <tr><td valign=top><i>ThumbHeight</i></td><td>Height of thumbnail image (in pixels) <tr> <tr><td valign=top><i>thumbicon</i></td><td>Full pathname specification of thumbnail image <tr> <tr><td valign=top><i>assocfilepath</i></td><td>Pathname of image directory in the collection\'s <i>assoc</i> directory <tr> </table> </blockquote></p>
    1717
    18 description5=<p>The image is stored as an "associated file" in the <i>assoc</i> subdirectory of the collection\'s <i>index</i> directory. (<i>Index</i> is where all files necessary to serve the collection are placed, to make it self-contained.) For any document, its thumbnail and image are both in a subdirectory whose filename is given by <i>assocfilepath</i>. The metadata element <i>thumbicon</i> is set to the full pathname specification of the thumbnail image, and can be used in the same way as <i>srcicon</i> (see the MSWord and PDF demonstration collection).</p>
     18description5=QQQQ<p>The image is stored as an "associated file" in the <i>assoc</i> subdirectory of the collection\'s <i>index</i> directory. (<i>Index</i> is where all files necessary to serve the collection are placed, to make it self-contained.) For any document, its thumbnail and image are both in a subdirectory whose filename is given by <i>assocfilepath</i>. The metadata element <i>thumbicon</i> is set to the full pathname specification of the thumbnail image, and can be used in the same way as <i>srcicon</i> (see the MSWord and PDF demonstration collection).</p>
    1919
    20 description6=<p>The <tt>browse</tt> format statement in the collection configuration file, <tt>collectionConfig.xml</tt>, dictates how the document will appear, and <a href="library/collection/image-e/document/D2">this</a> is the result. There is no document text (if there were, it would be producible by <i>&lt;xsl\:call-template name="documentNodeText"/&gt;</i> in format statements). What is shown is the image itself, along with some metadata extracted from it.</p>
     20description6=QQQQ<p>The <tt>browse</tt> format statement in the collection configuration file, <tt>collectionConfig.xml</tt>, dictates how the document will appear, and <a href="library/collection/image-e/document/D2">this</a> is the result. There is no document text (if there were, it would be producible by <i>&lt;xsl\:call-template name="documentNodeText"/&gt;</i> in format statements). What is shown is the image itself, along with some metadata extracted from it.</p>
    2121
    22 description7=<p>The configuration file specifies one classifier, a <i>List</i> based on <i>Image</i> metadata, shown <a href="library/collection/image-e/browse/CL1">here</a>. The format statement shows the thumbnail image along with some metadata. (Any other classifiers would have the same format, since this statement does not name the classifier.)</p>
     22description7=QQQQ<p>The configuration file specifies one classifier, a <i>List</i> based on <i>Image</i> metadata, shown <a href="library/collection/image-e/browse/CL1">here</a>. The format statement shows the thumbnail image along with some metadata. (Any other classifiers would have the same format, since this statement does not name the classifier.)</p>
    2323
    24 description8=<p>You may wonder why the thumbnail image is generated and stored explicitly, when the same effect would be obtained by using the original image and scaling it (as would happen if you did not have an Imagemagick installed).</p>
     24description8=QQQQ<p>You may wonder why the thumbnail image is generated and stored explicitly, when the same effect would be obtained by using the original image and scaling it (as would happen if you did not have an Imagemagick installed).</p>
    2525
    26 description9=<p>The reason is to save communication bandwidth by not sending large images when small ones would do.</p>
     26description9=QQQQ<p>The reason is to save communication bandwidth by not sending large images when small ones would do.</p>
    2727
    28 description10=<p>For a more comprehensive image collection, see the <a href="http\://www.nzdl.org/cgi-bin/library?a=p&sa=about&c=aircraft">kiwi aircraft images</a> in the New Zealand Digital Library. The structure of this collection is quite different, however\: it is a collection of web pages that include many images along with the text. The HTML plugin <i>HTMLPlugin</i> also processes image files, but it does so in a different way from ImagePlugin (for example, it does not produce the metadata described above).</p>
     28description10=QQQQ<p>For a more comprehensive image collection, see the <a href="http\://www.nzdl.org/cgi-bin/library?a=p&sa=about&c=aircraft">kiwi aircraft images</a> in the New Zealand Digital Library. The structure of this collection is quite different, however\: it is a collection of web pages that include many images along with the text. The HTML plugin <i>HTMLPlugin</i> also processes image files, but it does so in a different way from ImagePlugin (for example, it does not produce the metadata described above).</p>

  • documented-examples/trunk/isis-e/resources/collectionConfig.properties

    r36601 r36614  
    1 name=CDS/ISIS example
    2 Collation=Collation
    3 HideCDSrecord=Hide CDS/ISIS record
    4 CorporateAuthors=Corporate authors
    5 ShowCDSrecord=Show CDS/ISIS record
    6 Series=Series
    7 Authors=Authors
    8 OtherLanguageTitles=Other language titles
    9 Imprint=Imprint
    10 sampleoid=D0s103
    11 Keywords=Keywords
    12 Title=Title
    13 Conference=Conference
    14 Notes=Notes
    15 CDSrecord=CDS/ISIS record
    16 AddedTitle=Added title
    17 Edition=Edition
    18 Meetings=Meetings
     1name=QQQQCDS/ISIS example
     2Collation=QQQQCollation
     3HideCDSrecord=QQQQHide CDS/ISIS record
     4CorporateAuthors=QQQQCorporate authors
     5ShowCDSrecord=QQQQShow CDS/ISIS record
     6Series=QQQQSeries
     7Authors=QQQQAuthors
     8OtherLanguageTitles=QQQQOther language titles
     9Imprint=QQQQImprint
     10sampleoid=QQQQD0s103
     11Keywords=QQQQKeywords
     12Title=QQQQTitle
     13Conference=QQQQConference
     14Notes=QQQQNotes
     15CDSrecord=QQQQCDS/ISIS record
     16AddedTitle=QQQQAdded title
     17Edition=QQQQEdition
     18Meetings=QQQQMeetings
    1919
    20 Notes^all=notes
    21 PersonalAuthors^all=personal authors
    22 AddedTitle^all=added title
    23 Imprint^all=imprint
    24 ConferenceMainEntry^all=conference main entry
    25 CorporateBodies^all=corporate bodies
    26 Series^all=series
    27 OtherLanguageTitles^all=other language titles
    28 Keywords^all=keywords
    29 Collation^all=collation
    30 Title^all=title
    31 text=raw record
    32 Meetings^all=meetings
    33 Edition^all=edition
     20Notes^all=QQQQnotes
     21PersonalAuthors^all=QQQQpersonal authors
     22AddedTitle^all=QQQQadded title
     23Imprint^all=QQQQimprint
     24ConferenceMainEntry^all=QQQQconference main entry
     25CorporateBodies^all=QQQQcorporate bodies
     26Series^all=QQQQseries
     27OtherLanguageTitles^all=QQQQother language titles
     28Keywords^all=QQQQkeywords
     29Collation^all=QQQQcollation
     30Title^all=QQQQtitle
     31text=QQQQraw record
     32Meetings^all=QQQQmeetings
     33Edition^all=QQQQedition
    3434
    35 shortDescription=<p>This collection shows a <a href="http\://portal.unesco.org/ci/ev.php?URL_ID=2071&amp;URL_DO=DO_TOPIC&amp;URL_SECTION=201">CDS/ISIS</a> database of bibliography entries. <a href="library/collection/isis-e/document/D0s103">Here</a> is an example record.</p>
     35shortDescription=QQQQ<p>This collection shows a <a href="http\://portal.unesco.org/ci/ev.php?URL_ID=2071&amp;URL_DO=DO_TOPIC&amp;URL_SECTION=201">CDS/ISIS</a> database of bibliography entries. <a href="library/collection/isis-e/document/D0s103">Here</a> is an example record.</p>
    3636
    37 description1=<h3>How the collection works</h3><p>The collection configuration file, <tt>etc/collectionConfig.xml</tt> specifies the ISISPlugin plugin, which processes CDS/ISIS databases. These databases have several files, but ISISPlugin uses just three\: CDS.fdt (where CDS is the name of the database), containing the field names used in the database, CDF.xrf (a cross-reference file), and CDS.mst, containing the actual records. Whenever ISISPlugin encounters an ".mst" file, it looks for the corresponding ".fdt" and ".xrf" files. In this case the plugin has been given an <i>input_encoding</i> argument because some entries in the database contain extended characters (in a form that was used in early versions of the DOS operating system). It has also been given a subfield separator argument, whose purpose is explained below. The <i>-OIDtype incremental</i> plugin option was used to give identifiers that are consistent across different operating systems (which may not happen with HASH identifiers), so that we can link to a document in this description.</p>
     37description1=QQQQ<h3>How the collection works</h3><p>The collection configuration file, <tt>etc/collectionConfig.xml</tt> specifies the ISISPlugin plugin, which processes CDS/ISIS databases. These databases have several files, but ISISPlugin uses just three\: CDS.fdt (where CDS is the name of the database), containing the field names used in the database, CDF.xrf (a cross-reference file), and CDS.mst, containing the actual records. Whenever ISISPlugin encounters an ".mst" file, it looks for the corresponding ".fdt" and ".xrf" files. In this case the plugin has been given an <i>input_encoding</i> argument because some entries in the database contain extended characters (in a form that was used in early versions of the DOS operating system). It has also been given a subfield separator argument, whose purpose is explained below. The <i>-OIDtype incremental</i> plugin option was used to give identifiers that are consistent across different operating systems (which may not happen with HASH identifiers), so that we can link to a document in this description.</p>
    3838
    39 description2=<p>Like the <a href="library/collection/bibtex-e/page/about">bibliography collection</a>, this collection incorporates a <a href="library/collection/isis-e/search/FieldQuery">form-based search interface</a> that allows fielded searching. This is specified by the line <i>format SearchTypes "form,plain"</i> in the configuration file; the <i>plain</i> argument ensures that there is a plain textual full-text search feature as well (which can be selected from the <a href="library/page/pref">Preferences</a> page). The <i>&lt;importOption name="groupsize" value="100"/&gt;</i> line in the <tt>collectionConfig.xml</tt> file puts documents together into groups of 100 (as explained in the <a href="library/collection/bibtex-e/page/about">bibliography collection</a>).</p>
     39description2=QQQQ<p>Like the <a href="library/collection/bibtex-e/page/about">bibliography collection</a>, this collection incorporates a <a href="library/collection/isis-e/search/FieldQuery">form-based search interface</a> that allows fielded searching. This is specified by the line <i>format SearchTypes "form,plain"</i> in the configuration file; the <i>plain</i> argument ensures that there is a plain textual full-text search feature as well (which can be selected from the <a href="library/page/pref">Preferences</a> page). The <i>&lt;importOption name="groupsize" value="100"/&gt;</i> line in the <tt>collectionConfig.xml</tt> file puts documents together into groups of 100 (as explained in the <a href="library/collection/bibtex-e/page/about">bibliography collection</a>).</p>
    4040
    41 description3=<p>Some fields in CDS/ISIS databases have subfields. For example, in this case the <i>Imprint</i> field has subfields <i>Imprint.a</i> for place, <i>Imprint.b</i> for publisher and <i>Imprint.c</i> for date. For each field and subfield, ISISPlugin generates a metadata element -- in this case there will be metadata called <i>Imprint^a</i>, <i>Imprint^b</i> and <i>Imprint^c</i>. (There could be a field called just <i>Imprint</i>, although in this case there is not.) ISISPlugin also generates a metadata element called <i>Imprint^all</i> that gives all subfields concatenated together, separated by the character string that was specified as a plugin argument (in this case ", ").</p>
     41description3=QQQQ<p>Some fields in CDS/ISIS databases have subfields. For example, in this case the <i>Imprint</i> field has subfields <i>Imprint.a</i> for place, <i>Imprint.b</i> for publisher and <i>Imprint.c</i> for date. For each field and subfield, ISISPlugin generates a metadata element -- in this case there will be metadata called <i>Imprint^a</i>, <i>Imprint^b</i> and <i>Imprint^c</i>. (There could be a field called just <i>Imprint</i>, although in this case there is not.) ISISPlugin also generates a metadata element called <i>Imprint^all</i> that gives all subfields concatenated together, separated by the character string that was specified as a plugin argument (in this case ", ").</p>
    4242
    43 description4=<p>The designer of this collection has decided to create searchable indexes on all the <i>^all</i> metadata fields, as well as one on <i>text</i> which makes the raw records searchable too. Of course, the designer could have created searchable indexes on any of the subfields instead -- or as well.</p>
     43description4=QQQQ<p>The designer of this collection has decided to create searchable indexes on all the <i>^all</i> metadata fields, as well as one on <i>text</i> which makes the raw records searchable too. Of course, the designer could have created searchable indexes on any of the subfields instead -- or as well.</p>
    4444
    45 description5=<p>There are two browsing classifiers, an <i>AZList</i> based on <i>Title</i> metadata and an <i>AZCompactList</i> based on <i>Keyword</i> metadata. Recall that the <i>AZCompactList</i> classifier is like <i>AZList</i> but generates a bookshelf for duplicate items. The <i>VList</i> format specification applies to both the search results list and the <i>Title</i> classifier, while the <i>CL2VList</i> puts the number of documents associated with each keyword as described in the <a href="library/collection/marc-e/page/about">MARC example collection</a>. In Greenstone, and in CDS/ISIS, any metadata item can have several different values. The <i>VList</i> specification <nobr><i>sibling(All'; ')</i></nobr> gathers together all the values, separated (in this case) by semicolon.</p>
     45description5=QQQQ<p>There are two browsing classifiers, an <i>AZList</i> based on <i>Title</i> metadata and an <i>AZCompactList</i> based on <i>Keyword</i> metadata. Recall that the <i>AZCompactList</i> classifier is like <i>AZList</i> but generates a bookshelf for duplicate items. The <i>VList</i> format specification applies to both the search results list and the <i>Title</i> classifier, while the <i>CL2VList</i> puts the number of documents associated with each keyword as described in the <a href="library/collection/marc-e/page/about">MARC example collection</a>. In Greenstone, and in CDS/ISIS, any metadata item can have several different values. The <i>VList</i> specification <nobr><i>sibling(All'; ')</i></nobr> gathers together all the values, separated (in this case) by semicolon.</p>
    4646
    47 description6=<p>The <i>DocumentContent</i> format specification incorporates the same mechanism for hiding and showing raw records as explained for the <a href="library/collection/bibtex-e/page/about">Bibliography collection</a>, using the <i>DocumentHeading</i> to show the formatted record and <i>DocumentContent</i> to show (or hide) the original database entry.</p>
     47description6=QQQQ<p>The <i>DocumentContent</i> format specification incorporates the same mechanism for hiding and showing raw records as explained for the <a href="library/collection/bibtex-e/page/about">Bibliography collection</a>, using the <i>DocumentHeading</i> to show the formatted record and <i>DocumentContent</i> to show (or hide) the original database entry.</p>

  • documented-examples/trunk/lomdemo-e/resources/collectionConfig.properties

    r36589 r36614  
    1 as=all resources
    2 sc=science resources
    3 name=LOM Demonstration
    4 ar=arts resources
    5 general^title=Titles
    6 general^description=Descriptions
    7 general^keyword=Keywords
    8 text_and_rawtext=All text
     1as=QQQQall resources
     2sc=QQQQscience resources
     3name=QQQQLOM Demonstration
     4ar=QQQQarts resources
     5general^title=QQQQTitles
     6general^description=QQQQDescriptions
     7general^keyword=QQQQKeywords
     8text_and_rawtext=QQQQAll text
    99
    10 shortDescription=<p>This collection is a sample excerpt of educational resources from the University of Calgary\'s Learning Commons Educational Object Repository (no longer active). Taken from the subject areas of the arts and science, 38 items from the repository were exported in the IEEE LOM (Learning Object Metadata) format and digested into a Greenstone collection. For sample LOM metadata, see the records <tt>arts/657841.xml</tt> or <tt>record science/582041.xml</tt>.</p>
     10shortDescription=QQQQ<p>This collection is a sample excerpt of educational resources from the University of Calgary\'s Learning Commons Educational Object Repository (no longer active). Taken from the subject areas of the arts and science, 38 items from the repository were exported in the IEEE LOM (Learning Object Metadata) format and digested into a Greenstone collection. For sample LOM metadata, see the records <tt>arts/657841.xml</tt> or <tt>record science/582041.xml</tt>.</p>
    1111
    12 description1=<p>Traditional educational learning object repositories base searching and browsing around the provided metadata. This demonstration collection goes one step further and provides <i>full-text</i> indexing of the on-line resources, where possible.</p>
     12description1=QQQQ<p>Traditional educational learning object repositories base searching and browsing around the provided metadata. This demonstration collection goes one step further and provides <i>full-text</i> indexing of the on-line resources, where possible.</p>
    1313
    14 description2=<p>Browse around the collection\'s items ordered by subject then title, or view the items chronologically. Alternatively search the text or titles of the items in the collection, optionally restricted to arts or science. When you view an item from the collection various views of it are available. You start by viewing its Learning Object Metadata (LOM) record in a tabulated form and divided into sections\: these sections can be expanded or contracted to reveal more or less information as desired. Use the tabs at the top of the table to change the view of the learning object. There will always be a tab for "XML Record" which displays the metadata in its original IEEE LOM format. Depending on whether or not the learning object references an on-line resource that is available for indexing, a third tab may be present that displays the source document.</p>
     14description2=QQQQ<p>Browse around the collection\'s items ordered by subject then title, or view the items chronologically. Alternatively search the text or titles of the items in the collection, optionally restricted to arts or science. When you view an item from the collection various views of it are available. You start by viewing its Learning Object Metadata (LOM) record in a tabulated form and divided into sections\: these sections can be expanded or contracted to reveal more or less information as desired. Use the tabs at the top of the table to change the view of the learning object. There will always be a tab for "XML Record" which displays the metadata in its original IEEE LOM format. Depending on whether or not the learning object references an on-line resource that is available for indexing, a third tab may be present that displays the source document.</p>
    1515
    16 description3=<h3>How the collection works</h3><p>The records were exported from the Calgary Repository in LOM format. LOMPlugin is used to process the records. Using the <tt>-download_srcdocs</tt> option to the plugin will search for <tt>general^identifier^entry</tt> or <tt>technical^location</tt>, and attempt to download the source document into a <i>_gsdldown.all</i> folder (<tt>import/arts/_gsdldown.all</tt>) in the same folder as the LOM record.</p>
     16description3=QQQQ<h3>How the collection works</h3><p>The records were exported from the Calgary Repository in LOM format. LOMPlugin is used to process the records. Using the <tt>-download_srcdocs</tt> option to the plugin will search for <tt>general^identifier^entry</tt> or <tt>technical^location</tt>, and attempt to download the source document into a <i>_gsdldown.all</i> folder (<tt>import/arts/_gsdldown.all</tt>) in the same folder as the LOM record.</p>
    1717
    18 description4=<p>In porting the lomdemo-e collection from Greenstone 2 (GS2) to Greenstone 3, the predefined GS2 macros of <i>_httpopenmdicon_</i> and <i>httpclosemdicon_</i>, used to show and hide sections of the tabular display of LOM metadata, needed to be defined in <tt>siteConfig.xml</tt> by inserting the following 2 lines into the file\: \
     18description4=QQQQ<p>In porting the lomdemo-e collection from Greenstone 2 (GS2) to Greenstone 3, the predefined GS2 macros of <i>_httpopenmdicon_</i> and <i>httpclosemdicon_</i>, used to show and hide sections of the tabular display of LOM metadata, needed to be defined in <tt>siteConfig.xml</tt> by inserting the following 2 lines into the file\: \
    1919<pre>\
    20 &lt;replace macro="_httpopenmdicon_" scope="metadata" text="sites/localsite/collect/lomdemo-e/images/open.gif" data-img-path="sites/localsite/collect/lomdemo-e/images/" resolve="false"/&gt; \n\
    21 &lt;replace macro="_httpclosemdicon_" scope="metadata" text="sites/localsite/collect/lomdemo-e/images/close.gif" data-img-path="sites/localsite/collect/lomdemo-e/images/" resolve="false"/&gt; \n\
     20&lt;replace macro=QQQQ"_httpopenmdicon_" scope="metadata" text="sites/localsite/collect/lomdemo-e/images/open.gif" data-img-path="sites/localsite/collect/lomdemo-e/images/" resolve="false"/&gt; \n\
     21&lt;replace macro=QQQQ"_httpclosemdicon_" scope="metadata" text="sites/localsite/collect/lomdemo-e/images/close.gif" data-img-path="sites/localsite/collect/lomdemo-e/images/" resolve="false"/&gt; \n\
    2222</pre> \n\
    2323</p>
    2424
    25 description5=<p>The open and close icon images themselves were then placed into the location indicated above\: <tt>lomdemo-e/images/</tt> subfolder. The JavaScript to show and hide associated sections of LOM metadata when the close and open icons are clicked is defined in <tt>lomdemo-e/script/lomscript.js</tt>, and the CSS styling rules for the tabular display of the LOM metadata is in <tt>lomdemo-e/style/lom-style.css</tt>.</p>
     25description5=QQQQ<p>The open and close icon images themselves were then placed into the location indicated above\: <tt>lomdemo-e/images/</tt> subfolder. The JavaScript to show and hide associated sections of LOM metadata when the close and open icons are clicked is defined in <tt>lomdemo-e/script/lomscript.js</tt>, and the CSS styling rules for the tabular display of the LOM metadata is in <tt>lomdemo-e/style/lom-style.css</tt>.</p>

  • documented-examples/trunk/manifest-demo-e/resources/collectionConfig.properties

    r36589 r36614  
    1 name=manifest-demo-e
    2 dls.Organization=Organizations
    3 text=Text
    4 section=Chapter
    5 document=Book
    6 dls.Titles=Titles
    7 dls.Keyword=How to
    8 dls.Subject=Subjects
     1name=QQQQmanifest-demo-e
     2dls.Organization=QQQQOrganizations
     3text=QQQQText
     4section=QQQQChapter
     5document=QQQQBook
     6dls.Titles=QQQQTitles
     7dls.Keyword=QQQQHow to
     8dls.Subject=QQQQSubjects
    99
    10 textdate=publication date\:
    11 textnumpages=no. of pages\:
    12 textsource=source ref\:
     10textdate=QQQQpublication date\:
     11textnumpages=QQQQno. of pages\:
     12textsource=QQQQsource ref\:
    1313
    14 shortDescription=<p>This demonstration collection contains the same material as the original Greenstone demo collection. In addition it has some predefined manifest files, to show off their use with incremental building.</p>
     14shortDescription=QQQQ<p>This demonstration collection contains the same material as the original Greenstone demo collection. In addition it has some predefined manifest files, to show off their use with incremental building.</p>
    1515
    16 description=<h3>Features of this collection</h3> \n\
     16description=QQQQ<h3>Features of this collection</h3> \n\
    1717<ul> \n\
    1818<li>Uses <tt>lucene</tt> to do incremental build.</li> \n\
    … …  
    2525
    2626
    27 description0=<h3>Instructions</h3><br /><p>0. Run setup/source setup.bash in top level before starting.</p><br />
     27description0=QQQQ<h3>Instructions</h3><br /><p>0. Run setup/source setup.bash in top level before starting.</p><br />
    2828
    29 description1=<p>1. Build the collection initially\:<br /> \n\
     29description1=QQQQ<p>1. Build the collection initially\:<br /> \n\
    3030<pre>perl -S import.pl -site localsite documented-examples/manifest-demo-e \n\
    3131perl -S buildcol.pl -site localsite -activate documented-examples/manifest-demo-e</pre> \n\
    … …  
    3434Preview the collection. Contains 8 documents, 5 from BOSTID and 3 from EC Courier.</p><br />
    3535
    36 description2=<p>2. Add some new documents into the collection.<br /> \n\
     36description2=QQQQ<p>2. Add some new documents into the collection.<br /> \n\
    3737<br /> \n\
    3838Copy the three folders fb33fe fb34fe wb34te from import.extra into import. \n\
    … …  
    4343Now there should be FAO Better Farming Documents, and one World Bank document.</p><br />
    4444
    45 description3=<p>3. Delete some documents from the collection.<br /> \n\
     45description3=QQQQ<p>3. Delete some documents from the collection.<br /> \n\
    4646<pre>perl -S incremental-import.pl -site localsite -manifest manifests/delete-some-files.xml documented-examples/manifest-demo-e \n\
    4747perl -S incremental-buildcol.pl -site localsite -activate documented-examples/manifest-demo-e</pre> \n\
    … …  
    5050Now the EC Courier documents should be gone.</p><br />
    5151
    52 description4=<p>4. Modify some metadata<br /> \n\
     52description4=QQQQ<p>4. Modify some metadata<br /> \n\
    5353<pre>Copy import.extra/fb33fe-metadata.xml to import/fb33fe/metadata.xml \n\
    5454Copy import.extra/fb34fe-metadata.xml to import/fb34fe/metadata.xml \n\

  • documented-examples/trunk/marc-e/resources/collectionConfig.properties

    r36602 r36614  
    1 name=MARC example
    2 index_text=text
    3 index_Title=Title
    4 sampleoid=D0s156
     1name=QQQQMARC example
     2index_text=QQQQtext
     3index_Title=QQQQTitle
     4sampleoid=QQQQD0s156
    55
    6 shortDescription=<p>This collection, which contains _about\:numdocs_ MARC entries, is based on the MARC records of working papers published by <a href="http\://www.cs.waikato.ac.nz">Computer Science Department</a> at <a href="http\://www.waikato.ac.nz">the University of Waikato</a>. <a href="library/collection/marc-e/document/D0s156">Here</a> is a sample document in the collection.</p>
     6shortDescription=QQQQ<p>This collection, which contains _about\:numdocs_ MARC entries, is based on the MARC records of working papers published by <a href="http\://www.cs.waikato.ac.nz">Computer Science Department</a> at <a href="http\://www.waikato.ac.nz">the University of Waikato</a>. <a href="library/collection/marc-e/document/D0s156">Here</a> is a sample document in the collection.</p>
    77
    8 description1=<h3>How the collection works</h3><p>The configuration file, <tt>collectionConfig.xml</tt>, uses <i>MARCPlugin</i> to process the MARC records, as well as the standard plugins. There are three classifiers, based on <i>dc.Title</i>, <i>dc.Creator</i>, and <i>dc.Subject</i> metadata. The <i>Title</i> classifier uses AZList, while the other two use AZCompactList, which groups items with the same metadata into a bookshelf. The <i>-removesuffix</i> argument for the <i>Title</i> and <i>Creator</i> classifiers removes suffixes from the metadata string (<i>dc.Title</i> and <i>dc.Creator</i> respectively). This is specified as a PERL regular expression, and trims characters (such as trailing punctuation) from the strings for display.</p>
     8description1=QQQQ<h3>How the collection works</h3><p>The configuration file, <tt>collectionConfig.xml</tt>, uses <i>MARCPlugin</i> to process the MARC records, as well as the standard plugins. There are three classifiers, based on <i>dc.Title</i>, <i>dc.Creator</i>, and <i>dc.Subject</i> metadata. The <i>Title</i> classifier uses AZList, while the other two use AZCompactList, which groups items with the same metadata into a bookshelf. The <i>-removesuffix</i> argument for the <i>Title</i> and <i>Creator</i> classifiers removes suffixes from the metadata string (<i>dc.Title</i> and <i>dc.Creator</i> respectively). This is specified as a PERL regular expression, and trims characters (such as trailing punctuation) from the strings for display.</p>
    99
    10 description2=<p>The <i>VList</i> format statement controls the display of search results and all classifiers. For bookshelves, the number of leaf documents is displayed on the right-hand side. For documents, <i>dc.Title</i> is displayed, along with <i>dc.Creator</i> and <i>dc.Publisher</i>. <i>[sibling\:dc.Creator]</i> is used as dc.Creator has multiple values, and specifies that all values be output, not just the first one.</p>
     10description2=QQQQ<p>The <i>VList</i> format statement controls the display of search results and all classifiers. For bookshelves, the number of leaf documents is displayed on the right-hand side. For documents, <i>dc.Title</i> is displayed, along with <i>dc.Creator</i> and <i>dc.Publisher</i>. <i>[sibling\:dc.Creator]</i> is used as dc.Creator has multiple values, and specifies that all values be output, not just the first one.</p>
    1111
    12 description3=<p>The MARC plugin uses a special file to map MARC field numbers to Greenstone-style metadata. This file resides in the greenstone3 installation folder\'s <i>gs2build/etc</i> directory, and is called <tt>marc2dc.txt</tt>. It lists the correspondences between MARC field numbers and Greenstone metadata. Any MARC fields that are not listed simply do not appear as metadata, though they are still present in the Greenstone document. Each line in the file has the format <blockquote> &lt;MARC field number&gt; -&gt; GreenstoneMetadataName </blockquote> Lines in the file that begin with "\#" are comments.</p>
     12description3=QQQQ<p>The MARC plugin uses a special file to map MARC field numbers to Greenstone-style metadata. This file resides in the greenstone3 installation folder\'s <i>gs2build/etc</i> directory, and is called <tt>marc2dc.txt</tt>. It lists the correspondences between MARC field numbers and Greenstone metadata. Any MARC fields that are not listed simply do not appear as metadata, though they are still present in the Greenstone document. Each line in the file has the format <blockquote> &lt;MARC field number&gt; -&gt; GreenstoneMetadataName </blockquote> Lines in the file that begin with "\#" are comments.</p>
    1313
    14 description4=<p>The standard version of this file is loosely based on the MARC to Dublin Core mapping found at <a href="http\://www.loc.gov/marc/marc2dc.html">http\://www.loc.gov/marc/marc2dc.html</a> (which assumes USMARC/MARC21).</p>
     14description4=QQQQ<p>The standard version of this file is loosely based on the MARC to Dublin Core mapping found at <a href="http\://www.loc.gov/marc/marc2dc.html">http\://www.loc.gov/marc/marc2dc.html</a> (which assumes USMARC/MARC21).</p>
    1515
    16 description5=<p>Multiple MARC fields may map to a single Dublin Core field. For example, fields 720 ("Uncontrolled name"), 100 ("Personal name"), 110 ("Corporate name") and 111 ("Meeting name") all map to <i>dc.Creator</i>. Actual MARC records normally define only one of these fields, and anyway Greenstone allows multi-valued metadata.</p>
     16description5=QQQQ<p>Multiple MARC fields may map to a single Dublin Core field. For example, fields 720 ("Uncontrolled name"), 100 ("Personal name"), 110 ("Corporate name") and 111 ("Meeting name") all map to <i>dc.Creator</i>. Actual MARC records normally define only one of these fields, and anyway Greenstone allows multi-valued metadata.</p>
    1717
    18 description6=<p>Some mappings are dependent on subfields. For example, MARC field 260 contains information about publication and distribution. Subfields "c" (Date of Publication) and "g" (Date of manufacture) are mapped to <i>dc.Date</i>, using the following mapping line\: <blockquote> 260$c$g -&gt; dc.Date </blockquote>  Greenstone also provides a file for mapping MARC to <b>qualified</b> dublin core\: in your Greenstone 3 installation folder\'s <tt>gs2build/etc/marc2qdc.txt</tt>. This can be used by the MARC plugin by setting the <i>-metadata_mapping_file</i> option to "marc2qdc.txt".</p>
     18description6=QQQQ<p>Some mappings are dependent on subfields. For example, MARC field 260 contains information about publication and distribution. Subfields "c" (Date of Publication) and "g" (Date of manufacture) are mapped to <i>dc.Date</i>, using the following mapping line\: <blockquote> 260$c$g -&gt; dc.Date </blockquote>  Greenstone also provides a file for mapping MARC to <b>qualified</b> dublin core\: in your Greenstone 3 installation folder\'s <tt>gs2build/etc/marc2qdc.txt</tt>. This can be used by the MARC plugin by setting the <i>-metadata_mapping_file</i> option to "marc2qdc.txt".</p>

  • documented-examples/trunk/oai-e/resources/collectionConfig.properties

    r36603 r36614  
    1 name=OAI demo
    2 Rights=Rights
    3 Caption=Caption
    4 Publisher=Publisher
    5 original=original
    6 Subject=Subject
    7 available=available
    8 sampleoid=01dle6
    9 index_Description=photo captions
    10 document=Document
     1name=QQQQOAI demo
     2Rights=QQQQRights
     3Caption=QQQQCaption
     4Publisher=QQQQPublisher
     5original=QQQQoriginal
     6Subject=QQQQSubject
     7available=QQQQavailable
     8sampleoid=QQQQ01dle6
     9index_Description=QQQQphoto captions
     10document=QQQQDocument
    1111
    1212
    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>
     13shortDescription=QQQQ<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>
    1414
    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>
     15description1=QQQQ<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>
    1616
    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>
     17description2=QQQQ<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>
    1818
    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>
     19description3=QQQQ<p>This <i>oai-e</i> collection\'s own <tt>etc/oai.txt</tt> is an example of a downloaded metadata file.</p>
    2020
    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>
     21description4=QQQQ<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>
    2222
    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>
     23description5=QQQQ<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>
    2424
    25 description6=<p>The collection configuration file, <tt>collectionConfig.xml</tt>, specifies a single full-text index containing <i>dc.Description</i> metadata and overrides Greenstone\'s custom <i>gsf</i> format templates <tt>DocumentHeading</tt> and <tt>DocumentContent</tt> (XSL). When a document is displayed, the <i>DocumentHeading</i> format statement puts out its <i>dc.Subject</i>. Then the <i>DocumentContent</i> statement follows this with <i>screenicon</i>, which is produced by <i>ImagePlugin</i> and gives a screen-resolution version of the image; it can be hyperlinked to the <i>dc.OrigURL</i> metadata -- that is, the original version of the image on the remote OAI site. Since this is no longer available on the web, it is now hyperlinked to the full version of the image file. This is followed by the image\'s <i>dc.Description</i>, also with a hyperlink; the image\'s size and type, again generated as metadata by <i>ImagePlugin</i>; and then <i>dc.Subject</i>, <i>dc.Publisher</i>, and <i>dc.Rights</i> metadata. <a href="library/collection/oai-e/document/01dle6">This</a> is the result.</p>
     25description6=QQQQ<p>The collection configuration file, <tt>collectionConfig.xml</tt>, specifies a single full-text index containing <i>dc.Description</i> metadata and overrides Greenstone\'s custom <i>gsf</i> format templates <tt>DocumentHeading</tt> and <tt>DocumentContent</tt> (XSL). When a document is displayed, the <i>DocumentHeading</i> format statement puts out its <i>dc.Subject</i>. Then the <i>DocumentContent</i> statement follows this with <i>screenicon</i>, which is produced by <i>ImagePlugin</i> and gives a screen-resolution version of the image; it can be hyperlinked to the <i>dc.OrigURL</i> metadata -- that is, the original version of the image on the remote OAI site. Since this is no longer available on the web, it is now hyperlinked to the full version of the image file. This is followed by the image\'s <i>dc.Description</i>, also with a hyperlink; the image\'s size and type, again generated as metadata by <i>ImagePlugin</i>; and then <i>dc.Subject</i>, <i>dc.Publisher</i>, and <i>dc.Rights</i> metadata. <a href="library/collection/oai-e/document/01dle6">This</a> is the result.</p>
    2626
    27 description7=<p>There are two browsing classifiers, one based on <i>dc.Subject</i> metadata and the other on <i>dc.Description</i> metadata (but with a button named "captions"). Recall that the <i>AZCompactList</i> classifier is like <i>AZList</i> but generates a bookshelf for duplicate items. In this collection there are a lot of images but only a few different values for <i>dc.Subject</i> metadata.</p>
     27description7=QQQQ<p>There are two browsing classifiers, one based on <i>dc.Subject</i> metadata and the other on <i>dc.Description</i> metadata (but with a button named "captions"). Recall that the <i>AZCompactList</i> classifier is like <i>AZList</i> but generates a bookshelf for duplicate items. In this collection there are a lot of images but only a few different values for <i>dc.Subject</i> metadata.</p>
    2828
    29 description8=<p>It\'s a little surprising that <i>AZCompactList</i> is used (instead of <i>AZList</i>) for the <i>dc.Description</i> index too, because <i>dc.Description</i> metadata is usually unique for each image. However, in this collection the same description has occasionally been given to several images, and some of the divisions in an <i>AZList</i> would contain a large number of images, slowing down transmission of that page. To avoid this, the compact version of the list is used with some arguments (<i>mincompact</i>, <i>maxcompact</i>, <i>mingroup</i>, <i>minnesting</i>) to control the display -- e.g. groups (represented by bookshelves) are not formed unless they have at least 5 (<i>mingroup</i>) items. To find out the meaning of the other arguments for this classifier, execute the command <i>classinfo.pl AZCompactList</i>. The programs <i>classinfo.pl</i> (for classifiers) and <i>pluginfo.pl</i> (for plugins) are useful tools for learning about the capabilities of Greenstone modules. Note incidentally the backslash in the configuration file, used to indicate a continuation of the previous line.</p>
     29description8=QQQQ<p>It\'s a little surprising that <i>AZCompactList</i> is used (instead of <i>AZList</i>) for the <i>dc.Description</i> index too, because <i>dc.Description</i> metadata is usually unique for each image. However, in this collection the same description has occasionally been given to several images, and some of the divisions in an <i>AZList</i> would contain a large number of images, slowing down transmission of that page. To avoid this, the compact version of the list is used with some arguments (<i>mincompact</i>, <i>maxcompact</i>, <i>mingroup</i>, <i>minnesting</i>) to control the display -- e.g. groups (represented by bookshelves) are not formed unless they have at least 5 (<i>mingroup</i>) items. To find out the meaning of the other arguments for this classifier, execute the command <i>classinfo.pl AZCompactList</i>. The programs <i>classinfo.pl</i> (for classifiers) and <i>pluginfo.pl</i> (for plugins) are useful tools for learning about the capabilities of Greenstone modules. Note incidentally the backslash in the configuration file, used to indicate a continuation of the previous line.</p>
    3030
    31 description9=<p>The <i>VList</i> format specification shows the image thumbnail, hyperlinked to the associated document, followed by <i>dc.Description</i> metadata; the result can be seen <a href="library/collection/oai-e/browse/CL2">here</a>. The <i>Vlists</i> for the classifiers use <i>numleafdocs</i> to switch between an icon representing several documents (which will appear as a bookshelf) and the thumbnail itself, if there is only one image.</p>
     31description9=QQQQ<p>The <i>VList</i> format specification shows the image thumbnail, hyperlinked to the associated document, followed by <i>dc.Description</i> metadata; the result can be seen <a href="library/collection/oai-e/browse/CL2">here</a>. The <i>Vlists</i> for the classifiers use <i>numleafdocs</i> to switch between an icon representing several documents (which will appear as a bookshelf) and the thumbnail itself, if there is only one image.</p>
    3232
    33 description10=<h3>The Greenstone OAI server</h3><p>Greenstone comes with a built-in OAI data provider. This runs as a CGI program called "oaiserver.cgi", and is installed in the Greenstone <i>cgi-bin</i> directory. It can be accessed via the same URL as the Greenstone library (replacing "library.cgi" with "oaiserver.cgi"). If you are using the Windows local library server, you must install a web server (such as Apache) to run the OAI server.</p>
     33description10=QQQQ<h3>The Greenstone OAI server</h3><p>Greenstone comes with a built-in OAI data provider. This runs as a CGI program called "oaiserver.cgi", and is installed in the Greenstone <i>cgi-bin</i> directory. It can be accessed via the same URL as the Greenstone library (replacing "library.cgi" with "oaiserver.cgi"). If you are using the Windows local library server, you must install a web server (such as Apache) to run the OAI server.</p>
    3434
    35 description11=<p>Configuration of the server is done via the <i>oai.cfg</i> file in the Greenstone <i>etc</i> directory. This file specifies general information about the repository, and lists collections to be made accessible to OAI clients. By default, collections are not accessible. To enable a collection, add its name to the <i>oaicollection</i> list.</p>
     35description11=QQQQ<p>Configuration of the server is done via the <i>oai.cfg</i> file in the Greenstone <i>etc</i> directory. This file specifies general information about the repository, and lists collections to be made accessible to OAI clients. By default, collections are not accessible. To enable a collection, add its name to the <i>oaicollection</i> list.</p>
    3636
    37 description12=<p>Greenstone\'s OAI server currently supports Dublin Core, qualified Dublin Core and rfc1807 metadata sets. The <i>oaimetadata</i> line specifies which sets should be used. For collections that use other metadata sets, metadata mapping rules should be provided to map the existing metadata to the sets in use. See the <i>oai.cfg</i> file for details.</p>
     37description12=QQQQ<p>Greenstone\'s OAI server currently supports Dublin Core, qualified Dublin Core and rfc1807 metadata sets. The <i>oaimetadata</i> line specifies which sets should be used. For collections that use other metadata sets, metadata mapping rules should be provided to map the existing metadata to the sets in use. See the <i>oai.cfg</i> file for details.</p>

  • documented-examples/trunk/pagedimg-e/resources/collectionConfig.properties

    r36589 r36614  
    1 name=Paged Image example
    2 section_text=newspaper pages
     1name=QQQQPaged Image example
     2section_text=QQQQnewspaper pages
    33
    4 shortDescription=<p>This collection contains a few newspapers from the <a href='http\://www.nzdl.org/cgi-bin/library?a=p&amp;p=about&amp;c=niupepa'>Niupepa</a> collection of Maori newspapers.</p>
     4shortDescription=QQQQ<p>This collection contains a few newspapers from the <a href='http\://www.nzdl.org/cgi-bin/library?a=p&amp;p=about&amp;c=niupepa'>Niupepa</a> collection of Maori newspapers.</p>
    55
    6 description1=<h3>How the collection works</h3> <p>Each newspaper issue consists of a set of images, one per page, and a set of text files for the OCR\'d text. An item file links the set of pages into a single newspaper document. PagedImagePlugin is used to process the item files.</p>
     6description1=QQQQ<h3>How the collection works</h3> <p>Each newspaper issue consists of a set of images, one per page, and a set of text files for the OCR\'d text. An item file links the set of pages into a single newspaper document. PagedImagePlugin is used to process the item files.</p>
    77
    8 description2=<p>There are two styles of item files, and this collection demonstrates both. The first uses a text based format, and consists of a list of metadata for the document, and a list of pages. Some examples are\: <i>Te Waka o Te Iwi, Vol. 1, No. 1</i> (in <tt>import/09/09_1_1.item</tt>) and <i>Te Whetu o Te Tau, Vol. 1, No. 3</i> (in <tt>import/10/10_1_3.item</tt>. This format allows specification of document level metadata, and a single list of pages.</p>
     8description2=QQQQ<p>There are two styles of item files, and this collection demonstrates both. The first uses a text based format, and consists of a list of metadata for the document, and a list of pages. Some examples are\: <i>Te Waka o Te Iwi, Vol. 1, No. 1</i> (in <tt>import/09/09_1_1.item</tt>) and <i>Te Whetu o Te Tau, Vol. 1, No. 3</i> (in <tt>import/10/10_1_3.item</tt>. This format allows specification of document level metadata, and a single list of pages.</p>
    99
    10 description3=<p>The second style is an extended format, and uses XML. It allows a hierarchy of pages, and metadata specification at the page level as well as at the document level. An example is <i>Matariki 1881, No. 2</i> in <tt>import/xml/23/23__2.item</tt>. This newspaper also has an abstract associated with it. The contents have been grouped into two sections\: Supplementary Material, which contains the Abstract, and Newspaper Pages, which contains the page images.</p>
     10description3=QQQQ<p>The second style is an extended format, and uses XML. It allows a hierarchy of pages, and metadata specification at the page level as well as at the document level. An example is <i>Matariki 1881, No. 2</i> in <tt>import/xml/23/23__2.item</tt>. This newspaper also has an abstract associated with it. The contents have been grouped into two sections\: Supplementary Material, which contains the Abstract, and Newspaper Pages, which contains the page images.</p>
    1111
    12 description4=<p>Paged documents can be presented with a hierarchical table of contents (e.g. <a href="library/collection/pagedimg-e/document/23__1?ed=1">23__1.2.1</a>), or with a single-depth structure (e.g. <a href="library/collection/pagedimg-e/document/10_1_2">10_1_2</a>). This is specified by the <tt>-documenttype (hierarchy|paged)</tt> option to PagedImagePlugin. Ordinarily, a Greenstone collection would have one plugin per document type, and all documents of that type get the same processing. In this case, we want to treat the XML-based item files differently from the text-based item files. We can achieve this by adding two PagedImagePlugin plugins to the collection, and configuring them differently.</p>
     12description4=QQQQ<p>Paged documents can be presented with a hierarchical table of contents (e.g. <a href="library/collection/pagedimg-e/document/23__1?ed=1">23__1.2.1</a>), or with a single-depth structure (e.g. <a href="library/collection/pagedimg-e/document/10_1_2">10_1_2</a>). This is specified by the <tt>-documenttype (hierarchy|paged)</tt> option to PagedImagePlugin. Ordinarily, a Greenstone collection would have one plugin per document type, and all documents of that type get the same processing. In this case, we want to treat the XML-based item files differently from the text-based item files. We can achieve this by adding two PagedImagePlugin plugins to the collection, and configuring them differently.</p>
    1313
    14 description5=<p><tt>plugin PagedImagePlugin -documenttype hierarchy -process_exp xml.*\.item$ ... <br/> plugin PagedImagePlugin -documenttype paged ...</tt></p>
     14description5=QQQQ<p><tt>plugin PagedImagePlugin -documenttype hierarchy -process_exp xml.*\.item$ ... <br/> plugin PagedImagePlugin -documenttype paged ...</tt></p>
    1515
    16 description6=<p>XML based newpapers have been grouped into a folder called <tt>xml</tt>. This enables us to process these files differently, by utilising the <tt>process_exp</tt> option which all plugins support. The first PagedImagePlugin in the list looks for item files underneath the xml folder. These documents will be processed as hierarchical documents. Item files that don\'t match the process expression (i.e. aren\'t underneath the xml folder) will be passed onto the second PagedImagePlugin, and these are treated as paged documents.</p>
     16description6=QQQQ<p>XML based newpapers have been grouped into a folder called <tt>xml</tt>. This enables us to process these files differently, by utilising the <tt>process_exp</tt> option which all plugins support. The first PagedImagePlugin in the list looks for item files underneath the xml folder. These documents will be processed as hierarchical documents. Item files that don\'t match the process expression (i.e. aren\'t underneath the xml folder) will be passed onto the second PagedImagePlugin, and these are treated as paged documents.</p>
    1717
    18 description7=<p><b>Formatting</b> <p>Unlike in Greenstone 2, where the document formatting was modified to customize the display, in Greenstone 3 we rely for the rest on Greenstone\'s default behaviour.</p>
     18description7=QQQQ<p><b>Formatting</b> <p>Unlike in Greenstone 2, where the document formatting was modified to customize the display, in Greenstone 3 we rely for the rest on Greenstone\'s default behaviour.</p>
    1919

  • documented-examples/trunk/style-e/resources/collectionConfig.properties

    r36590 r36614  
    1 name=Cascading Style Sheets<br/> Demo collection
    2 textdate=publication date\:
    3 textnumpages=no. of pages\:
    4 textsource=source ref\:
    5 section_chapter=chapter
    6 document_book=book
     1name=QQQQCascading Style Sheets<br/> Demo collection
     2textdate=QQQQpublication date\:
     3textnumpages=QQQQno. of pages\:
     4textsource=QQQQsource ref\:
     5section_chapter=QQQQchapter
     6document_book=QQQQbook
    77
    8 dls.Organization=Organizations
    9 dls.Subject=Subjects
    10 index_text=Text
    11 index_document=Book
    12 index_section=Chapter
    13 dls.Titles=Titles
    14 dls.Keyword=How to
    15 depositormetadata={"name"\:"dls.Title","label"\:"Title","tooltip"\:"dls.Title\: The title of this resource.","type"\:"text"}, {"name"\:"dls.Organization","label"\:"Organization","tooltip"\:"dls.Organization\: The organization responsible for producing this resource.","type"\:"text"}, {"name"\:"dls.Subject","label"\:"Subject","tooltip"\:"dls.Subject\: The subject of this resource.","type"\:"text"}, {"name"\:"dls.Keyword","label"\:"Keyword","tooltip"\:"dls.Keyword\: A more specific indication of what the resource can be used for.","type"\:"text"}, {"name"\:"dls.Language","label"\:"Language","tooltip"\:"dls.Language\: The language of this resource.","type"\:"text"}
     8dls.Organization=QQQQOrganizations
     9dls.Subject=QQQQSubjects
     10index_text=QQQQText
     11index_document=QQQQBook
     12index_section=QQQQChapter
     13dls.Titles=QQQQTitles
     14dls.Keyword=QQQQHow to
     15depositormetadata=QQQQ{"name"\:"dls.Title","label"\:"Title","tooltip"\:"dls.Title\: The title of this resource.","type"\:"text"}, {"name"\:"dls.Organization","label"\:"Organization","tooltip"\:"dls.Organization\: The organization responsible for producing this resource.","type"\:"text"}, {"name"\:"dls.Subject","label"\:"Subject","tooltip"\:"dls.Subject\: The subject of this resource.","type"\:"text"}, {"name"\:"dls.Keyword","label"\:"Keyword","tooltip"\:"dls.Keyword\: A more specific indication of what the resource can be used for.","type"\:"text"}, {"name"\:"dls.Language","label"\:"Language","tooltip"\:"dls.Language\: The language of this resource.","type"\:"text"}
    1616
    1717
    18 shortDescription=<p>This collection demonstrates Greenstone\'s use of Cascading Style Sheets (CSS) for visual formatting in web browsers. On every page, you can change the style-sheet in effect, to modify that page\'s appearance. This collection contains the same material as the original Greenstone demo collection.</p>
     18shortDescription=QQQQ<p>This collection demonstrates Greenstone\'s use of Cascading Style Sheets (CSS) for visual formatting in web browsers. On every page, you can change the style-sheet in effect, to modify that page\'s appearance. This collection contains the same material as the original Greenstone demo collection.</p>
    1919
    20 description1=<p>A combination of JavaScript and the overriding of GS3 XSL templates in Greenstone 3\'s <i>global</i> format statement is used by the collection to provide the stylesheet switching. As in some other <i>Documented Example Collections</i>, GLI\'s <tt>Format &gt; Format Features &gt; global</tt> can be used to define the <b>additionalHeaderContent</b> template. Doing so overrides the existing <i>additionalHeaderContent</i> template, and appends any specified HTML elements to the HTML header.</p>
     20description1=QQQQ<p>A combination of JavaScript and the overriding of GS3 XSL templates in Greenstone 3\'s <i>global</i> format statement is used by the collection to provide the stylesheet switching. As in some other <i>Documented Example Collections</i>, GLI\'s <tt>Format &gt; Format Features &gt; global</tt> can be used to define the <b>additionalHeaderContent</b> template. Doing so overrides the existing <i>additionalHeaderContent</i> template, and appends any specified HTML elements to the HTML header.</p>
    2121
    22 description2=<p>In this case, the <b>additionalHeaderContent</b> specifies the custom collection stylesheet currently active and the JavaScript to facilitate the stylesheet switching when a link is clicked. The <b>create-banner</b> XSL template in the <i>global</i> format statement is also overridden to provide links to the multiple stylesheets within the existing GS3 banner section, and invoke the custom JavaScript when any link is clicked. \n\
     22description2=QQQQ<p>In this case, the <b>additionalHeaderContent</b> specifies the custom collection stylesheet currently active and the JavaScript to facilitate the stylesheet switching when a link is clicked. The <b>create-banner</b> XSL template in the <i>global</i> format statement is also overridden to provide links to the multiple stylesheets within the existing GS3 banner section, and invoke the custom JavaScript when any link is clicked. \n\
    2323<pre> \n\
    24   &lt;xsl\:template name="additionalHeaderContent"&gt; \n\
    25     &lt;xsl\:variable name="httpCollection"&gt; \n\
    26       &lt;xsl\:value-of select="/page/pageResponse/collection/metadataList/metadata[@name=\'httpPath\']"/&gt; \n\
     24  &lt;xsl\:template name=QQQQ"additionalHeaderContent"&gt; \n\
     25    &lt;xsl\:variable name=QQQQ"httpCollection"&gt; \n\
     26      &lt;xsl\:value-of select=QQQQ"/page/pageResponse/collection/metadataList/metadata[@name=\'httpPath\']"/&gt; \n\
    2727    &lt;/xsl\:variable&gt; \n\
    28     &lt;link rel="stylesheet" href="{$httpCollection}/style/gs3-style-default-extra.css" type="text/css"  \n\
    29        title="GS3 Style" id="custom-style" charset="UTF-8"/&gt; \n\
    30     &lt;script src="{$httpCollection}/script/custom-script.js" type="text/javascript"&gt; \n\
     28    &lt;link rel=QQQQ"stylesheet" href="{$httpCollection}/style/gs3-style-default-extra.css" type="text/css"  \n\
     29       title=QQQQ"GS3 Style" id="custom-style" charset="UTF-8"/&gt; \n\
     30    &lt;script src=QQQQ"{$httpCollection}/script/custom-script.js" type="text/javascript"&gt; \n\
    3131    &lt;/script&gt; \n\
    3232  &lt;/xsl\:template&gt; \n\
    3333 \n\
    34   &lt;xsl\:template name="create-banner"&gt;   \n\
    35     &lt;div class="choose_style"&gt; \n\
     34  &lt;xsl\:template name=QQQQ"create-banner"&gt;   \n\
     35    &lt;div class=QQQQ"choose_style"&gt; \n\
    3636        Choose a style\: \n\
    37         &lt;a href="#" onclick="replaceStyle(\'gs3-style-default-extra\');return false;"&gt;Default Greenstone&lt;/a&gt;, \n\
    38         &lt;a href="#" onclick="replaceStyle(\'gs3-style-blue\');return false;"&gt;Blue&lt;/a&gt;, \n\
    39         &lt;a href="#" onclick="replaceStyle(\'gs3-style-olive-purple\');return false;"&gt;OlivePurple&lt;/a&gt;,        \n\
    40         &lt;a href="#" onclick="replaceStyle(\'');return false;"&gt;None&lt;/a&gt; \n\
     37        &lt;a href=QQQQ"#" onclick="replaceStyle(\'gs3-style-default-extra\');return false;"&gt;Default Greenstone&lt;/a&gt;, \n\
     38        &lt;a href=QQQQ"#" onclick="replaceStyle(\'gs3-style-blue\');return false;"&gt;Blue&lt;/a&gt;, \n\
     39        &lt;a href=QQQQ"#" onclick="replaceStyle(\'gs3-style-olive-purple\');return false;"&gt;OlivePurple&lt;/a&gt;,        \n\
     40        &lt;a href=QQQQ"#" onclick="replaceStyle(\'');return false;"&gt;None&lt;/a&gt; \n\
    4141        &lt;/div&gt; \n\
    42     &lt;div id="gs_banner" class="ui-widget-header ui-corner-bottom"&gt;         \n\
    43       &lt;div id="titlesearchcontainer"&gt; \n\
    44     &lt;xsl\:call-template name="page-title-area"/&gt;   \n\
    45     &lt;xsl\:call-template name="quick-search-area"/&gt; \n\
    46     &lt;div style="clear\:both;"&gt;&lt;xsl\:text&gt; &lt;/xsl\:text&gt;&lt;/div&gt;     \n\
     42    &lt;div id=QQQQ"gs_banner" class="ui-widget-header ui-corner-bottom"&gt;         \n\
     43      &lt;div id=QQQQ"titlesearchcontainer"&gt; \n\
     44    &lt;xsl\:call-template name=QQQQ"page-title-area"/&gt;   \n\
     45    &lt;xsl\:call-template name=QQQQ"quick-search-area"/&gt; \n\
     46    &lt;div style=QQQQ"clear\:both;"&gt;&lt;xsl\:text&gt; &lt;/xsl\:text&gt;&lt;/div&gt;     \n\
    4747      &lt;/div&gt; \n\
    48       &lt;xsl\:call-template name="browsing-tabs"/&gt;   \n\
     48      &lt;xsl\:call-template name=QQQQ"browsing-tabs"/&gt;   \n\
    4949    &lt;/div&gt; \n\
    5050  &lt;/xsl\:template&gt; \n\
    … …  
    5252</p>
    5353
    54 description3=<p>If you want to download any of these stylesheets for your own collections, here are links to them\: \n\
     54description3=QQQQ<p>If you want to download any of these stylesheets for your own collections, here are links to them\: \n\
    5555<ul> \n\
    56 <li><a href='https\://trac.greenstone.org/browser/documented-examples/trunk/style-e/style/gs3-style-default-extra.css\'>GS3 default extra</a> - builds on top of GS3\'s default style</li> \n\
    57 <li><a href='https\://trac.greenstone.org/browser/documented-examples/trunk/style-e/style/gs3-style-blue.css\'>Blue theme</a> - modifies the GS3 default style for a blue colouring</li> \n\
    58 <li><a href='https\://trac.greenstone.org/browser/documented-examples/trunk/style-e/style/gs3-style-olive-purple.css\'>olive-purple theme</a> - modifies the GS3 default style for a vivid colouring of vine green and purples</li> \n\
     56<li><a href=QQQQ'https\://trac.greenstone.org/browser/documented-examples/trunk/style-e/style/gs3-style-default-extra.css\'>GS3 default extra</a> - builds on top of GS3\'s default style</li> \n\
     57<li><a href=QQQQ'https\://trac.greenstone.org/browser/documented-examples/trunk/style-e/style/gs3-style-blue.css\'>Blue theme</a> - modifies the GS3 default style for a blue colouring</li> \n\
     58<li><a href=QQQQ'https\://trac.greenstone.org/browser/documented-examples/trunk/style-e/style/gs3-style-olive-purple.css\'>olive-purple theme</a> - modifies the GS3 default style for a vivid colouring of vine green and purples</li> \n\
    5959<li>None - clears all CSS styling from the current page (needs reload to get the default GS3 style back)</li> \n\
    6060</ul> \n\
    6161</p>
    6262
    63 description4=<p><b>Using a downloaded stylesheet</b> \n\
     63description4=QQQQ<p><b>Using a downloaded stylesheet</b> \n\
    6464<ul> \n\
    6565<li>To use a stylesheet as the default, place it in greenstone/web/interfaces/default/style and rename it to <tt>style.css</tt>. This will affect all collections.</li> \n\
    6666<li>To use a stylesheet for a particular collection, place it in <tt>greenstone/web/sites/localsite/collect/&lt;collection&gt;/style</tt> then specify the stylesheet link in the <b>additionalHeaderContent</b> of GLI\'s <i>global</i> format statement (<tt>Format &gt; Format Features &gt; global</tt>) as follows\: \n\
    67 <pre>&lt;xsl\:template name="additionalHeaderContent"&gt; \n\
    68     &lt;xsl\:variable name="httpCollection"&gt; \n\
    69       &lt;xsl\:value-of select="/page/pageResponse/collection/metadataList/metadata[@name=\'httpPath\']"/&gt; \n\
     67<pre>&lt;xsl\:template name=QQQQ"additionalHeaderContent"&gt; \n\
     68    &lt;xsl\:variable name=QQQQ"httpCollection"&gt; \n\
     69      &lt;xsl\:value-of select=QQQQ"/page/pageResponse/collection/metadataList/metadata[@name=\'httpPath\']"/&gt; \n\
    7070    &lt;/xsl\:variable&gt; \n\
    71     &lt;link href="{$httpCollection}/style/stylesheet-name.css" rel="stylesheet" type="text/css"/&gt; \n\
     71    &lt;link href=QQQQ"{$httpCollection}/style/stylesheet-name.css" rel="stylesheet" type="text/css"/&gt; \n\
    7272&lt;/xsl\:template&gt;</pre> \n\
    7373</li> \n\

  • documented-examples/trunk/wiki-e/resources/collectionConfig.properties

    r36589 r36614  
    1 name=MediaWiki collection
    2 index_Title=Titles
    3 index_text=Text
    4 index_Source=Filenames
     1name=QQQQMediaWiki collection
     2index_Title=QQQQTitles
     3index_text=QQQQText
     4index_Source=QQQQFilenames
    55
    66
    7 shortDescription=<p>This demonstration collection is made from the Greenstone Wiki website. It shows off the new feature of building a Greenstone collection from a MediaWiki website in Greenstone.</p>
     7shortDescription=QQQQ<p>This demonstration collection is made from the Greenstone Wiki website. It shows off the new feature of building a Greenstone collection from a MediaWiki website in Greenstone.</p>
    88
    9 description1=<h3>How the collection works</h3><p>The collection configuration file, <tt>collectionConfig.xml</tt>, contains the plugins <i>MediaWikiPlugin</i>, <i>ImagePlugin</i>, <i>ZipPlugin</i>, <i>PDFPlugin</i>, <i>PowerPointPlugin</i>, <i>WordPlugin</i> (along with the standard plugins <i>GreenstoneXMLPlugin</i>, <i>ArchivesInfPlugin</i> and <i>DirectoryPlugin</i>). The <i>MediaWikiPlugin</i> handles the HTML pages downloaded from a MediaWiki website, while <i>ImagePlugin</i>, <i>ZipPlugin</i>, <i>PDFPlugin</i>, <i>PowerPointPlugin</i> and <i>WordPlugin</i> handle the image, zip, PDF, PowerPoint and Word files associated with the Greenstone Wiki.</p>
     9description1=QQQQ<h3>How the collection works</h3><p>The collection configuration file, <tt>collectionConfig.xml</tt>, contains the plugins <i>MediaWikiPlugin</i>, <i>ImagePlugin</i>, <i>ZipPlugin</i>, <i>PDFPlugin</i>, <i>PowerPointPlugin</i>, <i>WordPlugin</i> (along with the standard plugins <i>GreenstoneXMLPlugin</i>, <i>ArchivesInfPlugin</i> and <i>DirectoryPlugin</i>). The <i>MediaWikiPlugin</i> handles the HTML pages downloaded from a MediaWiki website, while <i>ImagePlugin</i>, <i>ZipPlugin</i>, <i>PDFPlugin</i>, <i>PowerPointPlugin</i> and <i>WordPlugin</i> handle the image, zip, PDF, PowerPoint and Word files associated with the Greenstone Wiki.</p>
    1010
    11 description2=<p>To build a collection from a MediaWiki website of your choice, you would first download the wiki files using the <i>MediaWiki</i> option on the <i>Download</i> panel of GLI. This download type works in a similar way to a the <i>Web</i> download, but is specially designed for crawling MediaWiki websites.</p>
     11description2=QQQQ<p>To build a collection from a MediaWiki website of your choice, you would first download the wiki files using the <i>MediaWiki</i> option on the <i>Download</i> panel of GLI. This download type works in a similar way to a the <i>Web</i> download, but is specially designed for crawling MediaWiki websites.</p>
    1212
    13 description3=<p>Once the files are downloaded, copy them into a collection using the <i>Gather</i>, dragging them from the <i>Downloaded Files</i> folder in the Workspace tree on the left-hand side.</p>
     13description3=QQQQ<p>Once the files are downloaded, copy them into a collection using the <i>Gather</i>, dragging them from the <i>Downloaded Files</i> folder in the Workspace tree on the left-hand side.</p>
    1414
    15 description4=<p>In the <i>Document Plugins</i> section of the <i>Design</i> panel, add <i>MediaWikiPlugin</i>. <i>MediaWikiPlugin</i> has several specific options which control aspects of page presentation, such as whether or not the table of contents, navigation toolbars and search box are shown on each page. Configure these options based on how you want the pages to appear. You can see the options used by this collection in its collection configuration file, <tt>collectionConfig.xml</tt>.</p>
     15description4=QQQQ<p>In the <i>Document Plugins</i> section of the <i>Design</i> panel, add <i>MediaWikiPlugin</i>. <i>MediaWikiPlugin</i> has several specific options which control aspects of page presentation, such as whether or not the table of contents, navigation toolbars and search box are shown on each page. Configure these options based on how you want the pages to appear. You can see the options used by this collection in its collection configuration file, <tt>collectionConfig.xml</tt>.</p>
    1616

  • documented-examples/trunk/wrdpdf-e/resources/collectionConfig.properties

    r36613 r36614  
    1 name=MSWord and PDF demonstration
    2 document_text=documents
     1name=QQQQMSWord and PDF demonstration
     2document_text=QQQQdocuments
    33
    4 shortDescription=<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>
     4shortDescription=QQQQ<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>
    55
    6 description1=<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>
     6description1=QQQQ<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>
    77
    8 description2=<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>
     8description2=QQQQ<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>
    99
    10 description3=<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>
     10description3=QQQQ<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>
    1111
    12 description4=<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\
     12description4=QQQQ<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\
    1313<ul> \n\
    1414<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\
    … …  
    1818</p>
    1919
    20 description5=[PENDING]<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\
     20description5=QQQQ[PENDING]<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\
    2121<pre>\
    2222&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\
     23    &lt;gsf\:template match=QQQQ"documentNode"&gt; \n\
     24        &lt;gsf\:format-gs2&gt;&lt;![CDATA[&lt;td valign=QQQQ"top"&gt;[link][icon][/link]&lt;/td&gt; \n\
     25&lt;td valign=QQQQ"top"&gt;[ex.srclink]{Or}{[ex.thumbicon],[ex.srcicon]}[ex./srclink]&lt;/td&gt; \n\
     26&lt;td valign=QQQQ"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=QQQQ"top"&gt; \n\
     28            &lt;gsf\:link type=QQQQ"document"&gt; \n\
     29                &lt;gsf\:icon type=QQQQ"document"/&gt; \n\
    3030            &lt;/gsf\:link&gt; \n\
    3131        &lt;/td&gt; \n\
    32         &lt;td valign="top"&gt; \n\
    33             &lt;gsf\:link type="source"&gt; \n\
     32        &lt;td valign=QQQQ"top"&gt; \n\
     33            &lt;gsf\:link type=QQQQ"source"&gt; \n\
    3434                &lt;gsf\:choose-metadata&gt; \n\
    35                     &lt;gsf\:metadata name="thumbicon"/&gt; \n\
    36                     &lt;gsf\:metadata name="srcicon"/&gt; \n\
     35                    &lt;gsf\:metadata name=QQQQ"thumbicon"/&gt; \n\
     36                    &lt;gsf\:metadata name=QQQQ"srcicon"/&gt; \n\
    3737                &lt;/gsf\:choose-metadata&gt; \n\
    3838            &lt;/gsf\:link&gt; \n\
    3939        &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\
     40        &lt;td valign=QQQQ"top"&gt; \n\
     41            &lt;span class=QQQQ"highlight"&gt; \n\
     42                &lt;gsf\:choose-metadata&gt;&lt;gsf\:metadata name=QQQQ"dc.Title"/&gt;&lt;gsf\:metadata name="exp.Title"/&gt;&lt;gsf\:metadata name="Title"/&gt;Untitled&lt;/gsf\:choose-metadata&gt; \n\
    4343            &lt;/span&gt; \n\
    4444            &lt;gsf\:switch&gt; \n\
    45                 &lt;gsf\:metadata name="Source"/&gt; \n\
    46                 &lt;gsf\:when test="exists"&gt; \n\
     45                &lt;gsf\:metadata name=QQQQ"Source"/&gt; \n\
     46                &lt;gsf\:when test=QQQQ"exists"&gt; \n\
    4747                    &lt;br/&gt; \n\
    48                     &lt;i&gt;(&lt;gsf\:metadata name="Source"/&gt;)&lt;/i&gt; \n\
     48                    &lt;i&gt;(&lt;gsf\:metadata name=QQQQ"Source"/&gt;)&lt;/i&gt; \n\
    4949                &lt;/gsf\:when&gt; \n\
    5050            &lt;/gsf\:switch&gt; \n\
Note: See TracChangeset for help on using the changeset viewer.