Index: /documented-examples/trunk/authen-e/resources/collectionConfig.properties =================================================================== --- /documented-examples/trunk/authen-e/resources/collectionConfig.properties (revision 36563) +++ /documented-examples/trunk/authen-e/resources/collectionConfig.properties (revision 36564) @@ -1,35 +1,35 @@ -name=QQQAuthentication demo -textdate=QQQpublication date\: -textnumpages=QQQno. of pages\: -textsource=QQQsource ref\: -section_chapter=QQQchapter -document_book=QQQbook +name=Authentication demo +textdate=publication date\: +textnumpages=no. of pages\: +textsource=source ref\: +section_chapter=chapter +document_book=book -dls.Organization=QQQOrganizations -dls.Subject=QQQSubjects -index_text=QQQText -index_document=QQQBook -index_section=QQQChapter -dls.Titles=QQQTitles -dls.Keyword=QQQHow to +dls.Organization=Organizations +dls.Subject=Subjects +index_text=Text +index_document=Book +index_section=Chapter +dls.Titles=Titles +dls.Keyword=How to -shortDescription=QQQCollection demonstrating document-level collection authentication in Greenstone 3. +shortDescription=Collection demonstrating document-level collection authentication in Greenstone 3. -description1=QQQ
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 & 2), while the others require logging in to view.
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 & 2), while the others require logging in to view.
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).
+description2=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).
-description3=QQQThe 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.
+description3=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.
-description4=QQQAuthentication is activated using the <security> XML element in the collectionConfig.xml file. In the example of the authen-e collection, all documents are set to private access by default, with the exception that they are accessible to logged in members of a group called "demo". The security element further defines a set of documents (documentSet) 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 not private access like other documents in the collection are by default, but can instead be accessed by anyone in any group, as no group is specified for their access. \n\ -
<security default_access=QQQ"private" scope="document"> \n\ +description4=Authentication is activated using the <security> XML element in the collectionConfig.xml file. In the example of the authen-e collection, all documents are set to private access by default, with the exception that they are accessible to logged in members of a group called "demo". The security element further defines a set of documents (documentSet) 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 not private access like other documents in the collection are by default, but can instead be accessed by anyone in any group, as no group is specified for their access. \n\ +
<security default_access="private" scope="document"> \n\ <exception> \n\ - <group name=QQQ"demo"/> \n\ + <group name="demo"/> \n\ </exception> \n\ <exception> \n\ - <documentSet name=QQQ"always-public"/> \n\ - <group name=QQQ""/> \n\ + <documentSet name="always-public"/> \n\ + <group name=""/> \n\ </exception> \n\ - <documentSet name=QQQ"always-public"> \n\ + <documentSet name="always-public"> \n\ <match>fb33fe</match> \n\ <match>fb34fe</match> \n\ @@ -38,13 +38,13 @@ -description5=QQQIn this case, we have used the -OIDtype dirname 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 documentSets controlling exceptions to the default access granted (or withheld) by the security element.
+description5=In this case, we have used the -OIDtype dirname 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 documentSets controlling exceptions to the default access granted (or withheld) by the security element.
-description6=QQQThe security directive element specifies the Greenstone groups 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 exception and documentSet elements to define one or more group names that will override the default_access set on the security element (whether all documents are private by default, for example, in which case exception elements define which groups do have access to the collection materials). The Greenstone admin pages allow you to define groups and add members to them.
+description6=The security directive element specifies the Greenstone groups 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 exception and documentSet elements to define one or more group names that will override the default_access set on the security element (whether all documents are private by default, for example, in which case exception elements define which groups do have access to the collection materials). The Greenstone admin pages allow you to define groups and add members to them.
-description7=QQQFor more information on authentication in GS3, the different possibilities when using the security 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\ +description7=
For more information on authentication in GS3, the different possibilities when using the security 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\
This collection, which contains 135 BibTeX entries, is a collection of working papers published from 1997 to 2006 at Department of Computer Science, the University of Waikato.
+shortDescription=This collection, which contains 135 BibTeX entries, is a collection of working papers published from 1997 to 2006 at Department of Computer Science, the University of Waikato.
-description1=QQQThe collection configuration file (the collection\'s etc/collectionConfig.xml) begins with the specification groupsize 200. 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.
+description1=The collection configuration file (the collection\'s etc/collectionConfig.xml) begins with the specification groupsize 200. 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.
-description2=QQQApart from the standard plugins, this collection uses BibTexPlugin, which processes references in the BibTeX format (well known to computer scientists). Two options have been set for BibTexPlugin\: -OIDtype assigned -OIDmetadata Number. 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.
+description2=Apart from the standard plugins, this collection uses BibTexPlugin, which processes references in the BibTeX format (well known to computer scientists). Two options have been set for BibTexPlugin\: -OIDtype assigned -OIDmetadata Number. 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.
-description3=QQQFielded searching, with a form-based interface, is selected by format SearchTypes "form,plain" in the configuration file. In fact, a plain textual full-text search index is included in this collection as well (since form comes first, it is the default interface; you reach the plain search through the Preferences page).
+description3=Fielded searching, with a form-based interface, is selected by format SearchTypes "form,plain" in the configuration file. In fact, a plain textual full-text search index is included in this collection as well (since form comes first, it is the default interface; you reach the plain search through the Preferences page).
-description4=QQQThe buildtype option shows that the default search engine mgpp is used. The indexes 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 search page are pulled down, they show full records followed by an entry for each metadata element. In the collection\'s resources/collectionConfig.properties file, collection-level metadata collectionmeta can be specified for any index to determine what it is called (except for metadata, which produces many menu items). In this case, the collectionConfig.properties file specifies that the text index (referred to by collection\'s configuration file, collectionConfig.xml) should be named "full records" because it contains the original bibliographic record.
+description4=The buildtype option shows that the default search engine mgpp is used. The indexes 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 search page are pulled down, they show full records followed by an entry for each metadata element. In the collection\'s resources/collectionConfig.properties file, collection-level metadata collectionmeta can be specified for any index to determine what it is called (except for metadata, which produces many menu items). In this case, the collectionConfig.properties file specifies that the text index (referred to by collection\'s configuration file, collectionConfig.xml) should be named "full records" because it contains the original bibliographic record.
-description5=QQQAn additional keyword, "allfields", could also be used in the indexes line, specifying that combined searching over all indexes should be available.
+description5=An additional keyword, "allfields", could also be used in the indexes line, specifying that combined searching over all indexes should be available.
-description6=QQQThe levels lines specifies only document level, as bibliographic records don\'t have internal structure.
+description6=The levels lines specifies only document level, as bibliographic records don\'t have internal structure.
-description7=QQQThis collection contains Title, Author, and Date browsers. The AZCompactList classifier used for the Author browser is like AZList but generates a bookshelf for duplicate items. The BibTeX plugin records each author as Author metadata; it also puts a list containing all authors into the Creator metadata element. Consequently the AZCompactList classifier is based on Author. However, Greenstone has a standard button reading authors whose name is (confusingly) "Creator", so this button name is specified for the classifier.
+description7=This collection contains Title, Author, and Date browsers. The AZCompactList classifier used for the Author browser is like AZList but generates a bookshelf for duplicate items. The BibTeX plugin records each author as Author metadata; it also puts a list containing all authors into the Creator metadata element. Consequently the AZCompactList classifier is based on Author. However, Greenstone has a standard button reading authors whose name is (confusingly) "Creator", so this button name is specified for the classifier.
-description8=QQQThe format statements for the search results list and the title browser are both determined by the VList specification. It gives a document icon that links to the document itself (which in this collection is the full reference); the title in bold; Creator metadata if there is any, otherwise Editor metadata; and Month, Year metadata if there is any. Here is an example.
+description8=The format statements for the search results list and the title browser are both determined by the VList specification. It gives a document icon that links to the document itself (which in this collection is the full reference); the title in bold; Creator metadata if there is any, otherwise Editor metadata; and Month, Year metadata if there is any. Here is an example.
-description9=QQQThe format statement for the author browser (CL2VList) is more complex. The AZCompactList classifier generates a tree 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. 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 Title. But beware\: this classifier is generated on Author metadata, so its title -- the title of the classifier -- is actually the author\'s name! This means that the bookshelf nodes here 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.
+description9=The format statement for the author browser (CL2VList) is more complex. The AZCompactList classifier generates a tree 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. 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 Title. But beware\: this classifier is generated on Author metadata, so its title -- the title of the classifier -- is actually the author\'s name! This means that the bookshelf nodes here 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.
-description10=QQQThe documents themselves (here is an example) are generated by two format statements, one (a long one) called DocumentHeading, and another called DocumentContent. The DocumentHeading, which is the top two-thirds of the page, contains the document\'s Title followed by a table that gives all the metadata elements that the BibTeX plugin can generate. The role of all the gsf\:switch statements in the collection cofiguration file, collectionConfig.xml, is to determine which elements are defined.
+description10=The documents themselves (here is an example) are generated by two format statements, one (a long one) called DocumentHeading, and another called DocumentContent. The DocumentHeading, which is the top two-thirds of the page, contains the document\'s Title followed by a table that gives all the metadata elements that the BibTeX plugin can generate. The role of all the gsf\:switch statements in the collection cofiguration file, collectionConfig.xml, is to determine which elements are defined.
-description11=QQQThe DocumentContent has been overridden. When the document is displayed initially, only a hyperlink reading Show/Hide BibTex Record 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.
+description11=The DocumentContent has been overridden. When the document is displayed initially, only a hyperlink reading Show/Hide BibTex Record 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.
Index: /documented-examples/trunk/dls-e/resources/collectionConfig.properties =================================================================== --- /documented-examples/trunk/dls-e/resources/collectionConfig.properties (revision 36563) +++ /documented-examples/trunk/dls-e/resources/collectionConfig.properties (revision 36564) @@ -1,51 +1,51 @@ -name=QQQDevelopment Library Subset collection -section_Title=QQQsection titles -section_text=QQQchapters -document_text=QQQentire documents -document=QQQDocument -textdate=QQQpublication date\: -textnumpages=QQQno. of pages\: -textsource=QQQsource ref\: +name=Development Library Subset collection +section_Title=section titles +section_text=chapters +document_text=entire documents +document=Document +textdate=publication date\: +textnumpages=no. of pages\: +textsource=source ref\: -shortDescription=QQQThe 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.
+shortDescription=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.
-description0=QQQThe 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 humanity@humaninfo.org. +description0=
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 humanity@humaninfo.org. -description1=QQQ
The DLS collection is fairly complex. If you\'re just starting out you might prefer to look at some other collections first (e.g. Word and PDF demonstration, or the Greenstone Archives, or the Simple Image collection).
+description1=The DLS collection is fairly complex. If you\'re just starting out you might prefer to look at some other collections first (e.g. Word and PDF demonstration, or the Greenstone Archives, or the Simple Image collection).
-description2=QQQThe collection configuration file, collectionConfig.xml, like all collection configuration files, begins with the creator 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.
+description2=The collection configuration file, collectionConfig.xml, like all collection configuration files, begins with the creator 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.
-description3=QQQPlugins. 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 HTMLPlugin must be included. The description_tags option processes tags in the text that define sections and section titles as described below.
+description3=Plugins. 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 HTMLPlugin must be included. The description_tags option processes tags in the text that define sections and section titles as described below.
-description4=QQQThe other plugins, GreenstoneXMLPlugin, MetadataXMLPlugin, ArchivesInfPlugin, and DirectoryPlugin, are used by Greenstone for internal purposes and are standard in almost all collections.
+description4=The other plugins, GreenstoneXMLPlugin, MetadataXMLPlugin, ArchivesInfPlugin, and DirectoryPlugin, are used by Greenstone for internal purposes and are standard in almost all collections.
-description5=QQQSearchable indexes. The block of lines starting with indexes 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 search page. 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 collectionConfig.properties file located in the collection\'s resources subfolder.
+description5=Searchable indexes. The block of lines starting with indexes 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 search page. 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 collectionConfig.properties file located in the collection\'s resources subfolder.
-description6=QQQThe contents of the indexes -- that is, the specification of what it is that will be searched -- are defined by the indexes line at the beginning of this block. This specifies three indexes, two at the section level (beginning with section\:) and one at the document level (beginning with document\:). 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 section\:text and document\:text, and the \:text means that the full text of sections and documents respectively will be searched. The second is section\:Title, which means that Title 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 indexes line.
+description6=The contents of the indexes -- that is, the specification of what it is that will be searched -- are defined by the indexes line at the beginning of this block. This specifies three indexes, two at the section level (beginning with section\:) and one at the document level (beginning with document\:). 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 section\:text and document\:text, and the \:text means that the full text of sections and documents respectively will be searched. The second is section\:Title, which means that Title 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 indexes line.
-description7=QQQClassifiers. The block of lines labeled classify 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 search page)\: subjects, titles, organisations, and howto The search button comes first, then come the four classifiers, in order.
+description7=Classifiers. The block of lines labeled classify 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 search page)\: subjects, titles, organisations, and howto The search button comes first, then come the four classifiers, in order.
-description8=QQQThe first classifier provides access by subject. It is a Hierarchy classifier whose hierarchy is defined in the file etc/dls.Subject.txt (the hfile argument); this file is discussed below. This classifier is based on dls.Subject metadata, and when several books appear at a leaf of the hierarchy they are sorted by dls.Title metadata (as you can see when you open classifier browser CL1.4.1). The second classifier provides access by title. It is also a Hierarchy classifier, this time based on dls.AZList metadata, whose hierarchy is defined in etc/dls.AZList.txt. This file is discussed below. The third provides access by organization\: it is a List classifier based on dls.Organization metadata. The -bookshelf_type always 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 List classifier based on dls.Keyword metadata. The -bookshelf_type never option prevents bookshelves being created even if two documents share the same keywords.
+description8=The first classifier provides access by subject. It is a Hierarchy classifier whose hierarchy is defined in the file etc/dls.Subject.txt (the hfile argument); this file is discussed below. This classifier is based on dls.Subject metadata, and when several books appear at a leaf of the hierarchy they are sorted by dls.Title metadata (as you can see when you open classifier browser CL1.4.1). The second classifier provides access by title. It is also a Hierarchy classifier, this time based on dls.AZList metadata, whose hierarchy is defined in etc/dls.AZList.txt. This file is discussed below. The third provides access by organization\: it is a List classifier based on dls.Organization metadata. The -bookshelf_type always 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 List classifier based on dls.Keyword metadata. The -bookshelf_type never option prevents bookshelves being created even if two documents share the same keywords.
-description9=QQQCover images. Greenstone looks for a cover image for each document, whose name is the same as the document\'s but with a .jpg 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.
+description9=Cover images. Greenstone looks for a cover image for each document, whose name is the same as the document\'s but with a .jpg 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.
-description10=QQQFormat statements. The format elements (<format;>, <browse>, <search> and <display> XML elements), called "format statements", govern how various parts of the collection should be displayed. The VList 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 SearchVList format statement, and also for the Howto classifier by the CL4VList statement (CL4 specifies the fourth classifier).
+description10=Format statements. The format elements (<format;>, <browse>, <search> and <display> XML elements), called "format statements", govern how various parts of the collection should be displayed. The VList 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 SearchVList format statement, and also for the Howto classifier by the CL4VList statement (CL4 specifies the fourth classifier).
-description11=QQQThe DocumentText statement governs how the document text is formatted, with Title metadata ([Title]) in HTML heading format followed by the text of the document [Text]. By default, cover images are shown with each document (DocumentImages), and the DocumentButtons are available\: the Expand Text, Expand Contents, Detach and Highlight buttons are shown with each document.
+description11=The DocumentText statement governs how the document text is formatted, with Title metadata ([Title]) in HTML heading format followed by the text of the document [Text]. By default, cover images are shown with each document (DocumentImages), and the DocumentButtons are available\: the Expand Text, Expand Contents, Detach and Highlight buttons are shown with each document.
-description12=QQQGreenstone 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 Greenstone 3 Format Statements on the Greenstone wiki.
+description12=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 Greenstone 3 Format Statements on the Greenstone wiki.
-description13=QQQCollection-level metadata. The <displayItem> elements under the top-level <displayItemList> 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 resources/collectionConfig.properties files) can be seen on the DLS collection\'s home page (this text is part of it).
+description13=Collection-level metadata. The <displayItem> elements under the top-level <displayItemList> 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 resources/collectionConfig.properties files) can be seen on the DLS collection\'s home page (this text is part of it).
-description14=QQQLanguage translations. In the collection configuration file, lines that look like <displayItem assigned="true" dictionary="collectionConfig" key="..." name="..."/> allow for translatable collection-level metadata, that are defined in the resources/collectionConfig.properties text files and can be translated in the same location such as by creating French and Spanish versions (in resources/collectionConfig_fr.properties and resources/collectionConfig_es.properties, 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 é). The files are in UTF-8, and these characters are represented by multi-byte sequences (<C3><A9> in this case). Alternatively they could be represented by their HTML entity names (like & eacute ;). It makes no difference for how they appear on the screen.
+description14=Language translations. In the collection configuration file, lines that look like <displayItem assigned="true" dictionary="collectionConfig" key="..." name="..."/> allow for translatable collection-level metadata, that are defined in the resources/collectionConfig.properties text files and can be translated in the same location such as by creating French and Spanish versions (in resources/collectionConfig_fr.properties and resources/collectionConfig_es.properties, 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 é). The files are in UTF-8, and these characters are represented by multi-byte sequences (<C3><A9> in this case). Alternatively they could be represented by their HTML entity names (like & eacute ;). It makes no difference for how they appear on the screen.
-description15=QQQDescription tags. The description tags recognized by HTMLPlugin 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\:
<!-- <Section> <Description> <Metadata name="Title"> Realizing human rights for poor people\: Strategies for achieving the international development targets </Metadata> </Description> --> (text of section goes here) <!-- </Section> -->The <!-- ... --> markers are used to ensure that these tags are marked as comments in HTML and therefore do not affect document formatting. In the Description 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 <!-- ... --> markers) can be used in Word documents too. +description15=
Description tags. The description tags recognized by HTMLPlugin 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\:
<!-- <Section> <Description> <Metadata name="Title"> Realizing human rights for poor people\: Strategies for achieving the international development targets </Metadata> </Description> --> (text of section goes here) <!-- </Section> -->The <!-- ... --> markers are used to ensure that these tags are marked as comments in HTML and therefore do not affect document formatting. In the Description 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 <!-- ... --> markers) can be used in Word documents too. -description16=QQQ
Metadata Files. Metadata for all documents in the DLS collection is provided in metadata.xml files, one per document folder. In this collection\'s import/r0087e is the metadata.xml file for one book -- Income generation and money management\: training women as entrepreneurs -- which is a block of about ten lines encased in <FileSet> ... </FileSet> tags. It defines dls.Title, dls.Language, dls.Subject and dls.AZList 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 mode=accumulate is specified; the alternative, and the default, is mode=override).
+description16=Metadata Files. Metadata for all documents in the DLS collection is provided in metadata.xml files, one per document folder. In this collection\'s import/r0087e is the metadata.xml file for one book -- Income generation and money management\: training women as entrepreneurs -- which is a block of about ten lines encased in <FileSet> ... </FileSet> tags. It defines dls.Title, dls.Language, dls.Subject and dls.AZList 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 mode=accumulate is specified; the alternative, and the default, is mode=override).
-description17=QQQHierarchy files. 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 metadata.xml 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.
+description17=Hierarchy files. 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 metadata.xml 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.
-description18=QQQFor example, the following shows three lines from the subject hierarchy file etc/dls.Subject.txt. \n\ +description18=
For example, the following shows three lines from the subject hierarchy file etc/dls.Subject.txt. \n\
"Animal Husbandry and Animal Product Processing " \n\ 7 "Animal Husbandry and Animal Product Processing " "Animal Husbandry and Animal Product Processing|Cattle " \n\ @@ -55,7 +55,7 @@ -description19=QQQThese 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.
+description19=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.
-description20=QQQIn 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 Hierarchy 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.
+description20=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 Hierarchy 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.
-description21=QQQThe etc/dls.AZList.txt hierarchy file used by the titles classifier contains a similar structure. Ordinarily, a titles browser would use a List (or AZList) 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 here.
+description21=The etc/dls.AZList.txt hierarchy file used by the titles classifier contains a similar structure. Ordinarily, a titles browser would use a List (or AZList) 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 here.
Index: /documented-examples/trunk/garish-e/resources/collectionConfig.properties =================================================================== --- /documented-examples/trunk/garish-e/resources/collectionConfig.properties (revision 36563) +++ /documented-examples/trunk/garish-e/resources/collectionConfig.properties (revision 36564) @@ -1,34 +1,34 @@ -name=QQQQQQCustom stylesheet demo collection +name=Custom stylesheet demo collection -textdate=QQQQQQpublication date\: -textnumpages=QQQno. of pages\: -textsource=QQQsource ref\: +textdate=publication date\: +textnumpages=no. of pages\: +textsource=source ref\: -dls.Organization=QQQOrganizations -dls.Titles=QQQTitles -dls.Keyword=QQQHow to -dls.Subject=QQQSubjects -index_text=QQQText -index_document=QQQBook -index_section=QQQChapter +dls.Organization=Organizations +dls.Titles=Titles +dls.Keyword=How to +dls.Subject=Subjects +index_text=Text +index_document=Book +index_section=Chapter -shortDescription=QQQThis demonstration collection contains the same material as the original Greenstone demo collection, but its appearance has been altered slightly using a custom stylesheet.
+shortDescription=This demonstration collection contains the same material as the original Greenstone demo collection, but its appearance has been altered slightly using a custom stylesheet.
-description1=QQQGreenstone 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.
+description1=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.
-description2=QQQHow the collection works
The global format statement contains a link to the collection\'s custom stylesheet, which is located inside the collection\: \n\ -
<xsl\:template name=QQQ"additionalHeaderContent"> \n\ - <xsl\:variable name=QQQ"httpCollection"> \n\ - <xsl\:value-of select=QQQ"/page/pageResponse/collection/metadataList/metadata[@name='httpPath']"/> \n\ +description2=How the collection works
The global format statement contains a link to the collection\'s custom stylesheet, which is located inside the collection\: \n\ +
<xsl\:template name="additionalHeaderContent"> \n\ + <xsl\:variable name="httpCollection"> \n\ + <xsl\:value-of select="/page/pageResponse/collection/metadataList/metadata[@name='httpPath']"/> \n\ </xsl\:variable> \n\ - <link href=QQQ"{$httpCollection}/style/style.css" rel="stylesheet" type="text/css"/> \n\ + <link href="{$httpCollection}/style/style.css" rel="stylesheet" type="text/css"/> \n\ </xsl\:template> \n\\n\ -description3=QQQNext, a folder named style is created within the collection and a new text file, called custom-style.css, is created within that folder. The css suffix indicates it\'s a Cascading Style Sheet. 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.
+description3=Next, a folder named style is created within the collection and a new text file, called custom-style.css, is created within that folder. The css suffix indicates it\'s a Cascading Style Sheet. 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.
-description4=QQQThe default Greenstone CSS style sheets define certain styles for all collections, that are overridden for the collection by defining CSS rules within its new custom stylesheet. It is by linking the CSS file in the Greenstone collection\'s global format statement as above, that the general Greenstone CSS styling rules get overridden at the collection level.
+description4=The default Greenstone CSS style sheets define certain styles for all collections, that are overridden for the collection by defining CSS rules within its new custom stylesheet. It is by linking the CSS file in the Greenstone collection\'s global format statement as above, that the general Greenstone CSS styling rules get overridden at the collection level.
-description5=QQQYou can quickly learn how to write CSS at W3schools and other online sites.
+description5=You can quickly learn how to write CSS at W3schools and other online sites.
Index: /documented-examples/trunk/gsarch-e/resources/collectionConfig.properties =================================================================== --- /documented-examples/trunk/gsarch-e/resources/collectionConfig.properties (revision 36563) +++ /documented-examples/trunk/gsarch-e/resources/collectionConfig.properties (revision 36564) @@ -1,25 +1,25 @@ -name=QQQGreenstone Archives collection -SearchBySender=QQQsearch by sender -Subject=QQQSubject -Date=QQQDate -From=QQQFrom -ReplyTo=QQQIn reply to -index_text=QQQMessages -index_subject=QQQSubject lines -index_from=QQQFrom fields +name=Greenstone Archives collection +SearchBySender=search by sender +Subject=Subject +Date=Date +From=From +ReplyTo=In reply to +index_text=Messages +index_subject=Subject lines +index_from=From fields -shortDescription=QQQThis is a collection of email messages from the Greenstone mailing list archives, from November/December, 2008.
+shortDescription=This is a collection of email messages from the Greenstone mailing list archives, from November/December, 2008.
-description1=QQQHow the collection works
The Greenstone Archives collection uses the Email 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 Email plugin splits these into individual documents, and produces Title, Subject, From, FromName, FromAddr, Date, DateText, InReplyTo, and optionally Headers, metadata.
+description1=How the collection works
The Greenstone Archives collection uses the Email 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 Email plugin splits these into individual documents, and produces Title, Subject, From, FromName, FromAddr, Date, DateText, InReplyTo, and optionally Headers, metadata.
-description2=QQQThe collection configuration file, etc/collectionConfig.xml specifies <importOption name="groupsize" value="200"/>. 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 Email plugin first splits the input files up into individual Emails, then groupsize groups them together again. This allows the collection designer to control what is going on.
+description2=The collection configuration file, etc/collectionConfig.xml specifies <importOption name="groupsize" value="200"/>. 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 Email plugin first splits the input files up into individual Emails, then groupsize groups them together again. This allows the collection designer to control what is going on.
-description3=QQQThe indexes line specifies 3 searchable indexes, which can be seen by clicking beside the word "Messages" on the search page to reveal a drop-down menu. The first (called Messages) is created from the document text, while the others are formed from From and Subject metadata.
+description3=The indexes line specifies 3 searchable indexes, which can be seen by clicking beside the word "Messages" on the search page to reveal a drop-down menu. The first (called Messages) is created from the document text, while the others are formed from From and Subject metadata.
-description4=QQQThere are three classifiers, based on Subject, FromName, and Date metadata. The AZCompactList classifier used for the first two is like AZList but generates a bookshelf for duplicate items, as illustrated with classifier browser CL1. 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 CL1Vlist, checks whether this item exists. If so the node must be an internal one, in which case it is labeled by its Title. Otherwise the node\'s label starts with the Subject which links to the document, then gives FromName metadata, with a link to "Search by Sender", followed by the DateText.
+description4=There are three classifiers, based on Subject, FromName, and Date metadata. The AZCompactList classifier used for the first two is like AZList but generates a bookshelf for duplicate items, as illustrated with classifier browser CL1. 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 CL1Vlist, checks whether this item exists. If so the node must be an internal one, in which case it is labeled by its Title. Otherwise the node\'s label starts with the Subject which links to the document, then gives FromName metadata, with a link to "Search by Sender", followed by the DateText.
-description5=QQQThe second classifier (CL2Vlist) is similar, but shows slightly different information -- the result can be seen with classifier browser CL2. For internal nodes, the actual number of leaf documents (numleafdocs) is given in parentheses after the Title. For document nodes the FromName, with a link to "Search By Sender", Subject (linked to the document), and DateText metadata is shown.
+description5=The second classifier (CL2Vlist) is similar, but shows slightly different information -- the result can be seen with classifier browser CL2. For internal nodes, the actual number of leaf documents (numleafdocs) is given in parentheses after the Title. For document nodes the FromName, with a link to "Search By Sender", Subject (linked to the document), and DateText metadata is shown.
-description6=QQQThe third classifier is a DateList, which allows selection by month and year.
+description6=The third classifier is a DateList, which allows selection by month and year.
-description7=QQQFinally, the documentHeading is overridden to show the header fields\: FromName, DateText, Subject, InReplyTo (as the default documentHeading would not show the InReplyTo Field, nor to label the fields). The default documentContent already displays the message text (with the call to <xsl\:call-template name="documentNodeText"/>). FromName is linked to a search on that name, while InReplyTo links to the email message that it refers to.
+description7=Finally, the documentHeading is overridden to show the header fields\: FromName, DateText, Subject, InReplyTo (as the default documentHeading would not show the InReplyTo Field, nor to label the fields). The default documentContent already displays the message text (with the call to <xsl\:call-template name="documentNodeText"/>). FromName is linked to a search on that name, while InReplyTo links to the email message that it refers to.
Index: /documented-examples/trunk/image-e/resources/collectionConfig.properties =================================================================== --- /documented-examples/trunk/image-e/resources/collectionConfig.properties (revision 36563) +++ /documented-examples/trunk/image-e/resources/collectionConfig.properties (revision 36564) @@ -1,29 +1,29 @@ -name=QQQSimple image collection -Height=QQQHeight -Size=QQQSize -Width=QQQWidth -ImageName=QQQImage Name -sampleoid=QQQD2 +name=Simple image collection +Height=Height +Size=Size +Width=Width +ImageName=Image Name +sampleoid=D2 -shortDescription=QQQThis 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.
+shortDescription=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.
-description1=QQQThe 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.
+description1=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.
-description2=QQQHow the collection works
Here is a sample document in the collection. The configuration file, collectionConfig.xml, specifies no indexes, so the search button is suppressed.
+description2=How the collection works
Here is a sample document in the collection. The configuration file, collectionConfig.xml, specifies no indexes, so the search button is suppressed.
-description3=QQQThere is only one plugin, ImagePlugin, aside from the others that are always present (crucially GreenstoneXMLPlugin, MetadataXMLPlugin, ArchivesInfPlugin, DirectoryPlugin). ImagePlugin relies on the existence of two programs from the ImageMagick suite (www.imagemagick.org)\: convert and identify. 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.
+description3=There is only one plugin, ImagePlugin, aside from the others that are always present (crucially GreenstoneXMLPlugin, MetadataXMLPlugin, ArchivesInfPlugin, DirectoryPlugin). ImagePlugin relies on the existence of two programs from the ImageMagick suite (www.imagemagick.org)\: convert and identify. 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.
-description4=QQQImagePlugin automatically creates a thumbnail and generates the following metadata for each image in the collection\:
+description4=
Image Name of file containing the image ImageWidth Width of image (in pixels) ImageHeight Height of image (in pixels) Thumb Name of gif file containing thumbnail of image ThumbWidth Width of thumbnail image (in pixels) ThumbHeight Height of thumbnail image (in pixels) thumbicon Full pathname specification of thumbnail image assocfilepath Pathname of image directory in the collection\'s assoc directory ImagePlugin automatically creates a thumbnail and generates the following metadata for each image in the collection\:
-description5=QQQ
Image Name of file containing the image ImageWidth Width of image (in pixels) ImageHeight Height of image (in pixels) Thumb Name of gif file containing thumbnail of image ThumbWidth Width of thumbnail image (in pixels) ThumbHeight Height of thumbnail image (in pixels) thumbicon Full pathname specification of thumbnail image assocfilepath Pathname of image directory in the collection\'s assoc directory The image is stored as an "associated file" in the assoc subdirectory of the collection\'s index directory. (Index 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 assocfilepath. The metadata element thumbicon is set to the full pathname specification of the thumbnail image, and can be used in the same way as srcicon (see the MSWord and PDF demonstration collection).
+description5=The image is stored as an "associated file" in the assoc subdirectory of the collection\'s index directory. (Index 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 assocfilepath. The metadata element thumbicon is set to the full pathname specification of the thumbnail image, and can be used in the same way as srcicon (see the MSWord and PDF demonstration collection).
-description6=QQQThe browse format statement in the collection configuration file, collectionConfig.xml, dictates how the document will appear, and this is the result. There is no document text (if there were, it would be producible by <gsf\:metadata name="rawtext"/> in format statements). What is shown is the image itself, along with some metadata extracted from it.
+description6=The browse format statement in the collection configuration file, collectionConfig.xml, dictates how the document will appear, and this is the result. There is no document text (if there were, it would be producible by <gsf\:metadata name="rawtext"/> in format statements). What is shown is the image itself, along with some metadata extracted from it.
-description7=QQQThe configuration file specifies one classifier, a List based on Image metadata, shown here. 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.)
+description7=The configuration file specifies one classifier, a List based on Image metadata, shown here. 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.)
-description8=QQQYou 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).
+description8=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).
-description9=QQQThe reason is to save communication bandwidth by not sending large images when small ones would do.
+description9=The reason is to save communication bandwidth by not sending large images when small ones would do.
-description10=QQQFor a more comprehensive image collection, see the kiwi aircraft images 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 HTMLPlugin also processes image files, but it does so in a different way from ImagePlugin (for example, it does not produce the metadata described above).
+description10=For a more comprehensive image collection, see the kiwi aircraft images 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 HTMLPlugin also processes image files, but it does so in a different way from ImagePlugin (for example, it does not produce the metadata described above).
Index: /documented-examples/trunk/isis-e/resources/collectionConfig.properties =================================================================== --- /documented-examples/trunk/isis-e/resources/collectionConfig.properties (revision 36563) +++ /documented-examples/trunk/isis-e/resources/collectionConfig.properties (revision 36564) @@ -1,47 +1,47 @@ -name=QQQCDS/ISIS example -Collation=QQQCollation -HideCDSrecord=QQQHide CDS/ISIS record -CorporateAuthors=QQQCorporate authors -ShowCDSrecord=QQQShow CDS/ISIS record -Series=QQQSeries -Authors=QQQAuthors -OtherLanguageTitles=QQQOther language titles -Imprint=QQQImprint -sampleoid=QQQD0s103 -Keywords=QQQKeywords -Title=QQQTitle -Conference=QQQConference -Notes=QQQNotes -CDSrecord=QQQCDS/ISIS record -AddedTitle=QQQAdded title -Edition=QQQEdition -Meetings=QQQMeetings +name=CDS/ISIS example +Collation=Collation +HideCDSrecord=Hide CDS/ISIS record +CorporateAuthors=Corporate authors +ShowCDSrecord=Show CDS/ISIS record +Series=Series +Authors=Authors +OtherLanguageTitles=Other language titles +Imprint=Imprint +sampleoid=D0s103 +Keywords=Keywords +Title=Title +Conference=Conference +Notes=Notes +CDSrecord=CDS/ISIS record +AddedTitle=Added title +Edition=Edition +Meetings=Meetings -Notes^all=QQQnotes -PersonalAuthors^all=QQQpersonal authors -AddedTitle^all=QQQadded title -Imprint^all=QQQimprint -ConferenceMainEntry^all=QQQconference main entry -CorporateBodies^all=QQQcorporate bodies -Series^all=QQQseries -OtherLanguageTitles^all=QQQother language titles -Keywords^all=QQQkeywords -Collation^all=QQQcollation -Title^all=QQQtitle -text=QQQraw record -Meetings^all=QQQmeetings -Edition^all=QQQedition +Notes^all=notes +PersonalAuthors^all=personal authors +AddedTitle^all=added title +Imprint^all=imprint +ConferenceMainEntry^all=conference main entry +CorporateBodies^all=corporate bodies +Series^all=series +OtherLanguageTitles^all=other language titles +Keywords^all=keywords +Collation^all=collation +Title^all=title +text=raw record +Meetings^all=meetings +Edition^all=edition -shortDescription=QQQThis collection shows a CDS/ISIS database of bibliography entries.
+shortDescription=This collection shows a CDS/ISIS database of bibliography entries.
-description1=QQQHow the collection works
The collection configuration file, etc/collectionConfig.xml 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 input_encoding 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 -OIDtype incremental 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.
+description1=How the collection works
The collection configuration file, etc/collectionConfig.xml 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 input_encoding 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 -OIDtype incremental 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.
-description2=QQQLike the bibliography collection, this collection incorporates a form-based search interface that allows fielded searching. This is specified by the line format SearchTypes "form,plain" in the configuration file; the plain argument ensures that there is a plain textual full-text search feature as well (which can be selected from the Preferences page). The <importOption name="groupsize" value="100"/> line in the collectionConfig.xml file puts documents together into groups of 100 (as explained in the bibliography collection).
+description2=Like the bibliography collection, this collection incorporates a form-based search interface that allows fielded searching. This is specified by the line format SearchTypes "form,plain" in the configuration file; the plain argument ensures that there is a plain textual full-text search feature as well (which can be selected from the Preferences page). The <importOption name="groupsize" value="100"/> line in the collectionConfig.xml file puts documents together into groups of 100 (as explained in the bibliography collection).
-description3=QQQSome fields in CDS/ISIS databases have subfields. For example, in this case the Imprint field has subfields Imprint.a for place, Imprint.b for publisher and Imprint.c for date. For each field and subfield, ISISPlugin generates a metadata element -- in this case there will be metadata called Imprint^a, Imprint^b and Imprint^c. (There could be a field called just Imprint, although in this case there is not.) ISISPlugin also generates a metadata element called Imprint^all that gives all subfields concatenated together, separated by the character string that was specified as a plugin argument (in this case ", ").
+description3=Some fields in CDS/ISIS databases have subfields. For example, in this case the Imprint field has subfields Imprint.a for place, Imprint.b for publisher and Imprint.c for date. For each field and subfield, ISISPlugin generates a metadata element -- in this case there will be metadata called Imprint^a, Imprint^b and Imprint^c. (There could be a field called just Imprint, although in this case there is not.) ISISPlugin also generates a metadata element called Imprint^all that gives all subfields concatenated together, separated by the character string that was specified as a plugin argument (in this case ", ").
-description4=QQQThe designer of this collection has decided to create searchable indexes on all the ^all metadata fields, as well as one on text 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.
+description4=The designer of this collection has decided to create searchable indexes on all the ^all metadata fields, as well as one on text 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.
-description5=QQQThere are two browsing classifiers, an AZList based on Title metadata and an AZCompactList based on Keyword metadata. Recall that the AZCompactList classifier is like AZList but generates a bookshelf for duplicate items. The VList format specification applies to both the search results list and the Title classifier, while the CL2VList puts the number of documents associated with each keyword as described in the MARC example collection. In Greenstone, and in CDS/ISIS, any metadata item can have several different values. The VList specification
+description5=sibling(All'; ') gathers together all the values, separated (in this case) by semicolon.There are two browsing classifiers, an AZList based on Title metadata and an AZCompactList based on Keyword metadata. Recall that the AZCompactList classifier is like AZList but generates a bookshelf for duplicate items. The VList format specification applies to both the search results list and the Title classifier, while the CL2VList puts the number of documents associated with each keyword as described in the MARC example collection. In Greenstone, and in CDS/ISIS, any metadata item can have several different values. The VList specification
-description6=QQQsibling(All'; ') gathers together all the values, separated (in this case) by semicolon.The DocumentContent format specification incorporates the same mechanism for hiding and showing raw records as explained for the Bibliography collection, using the DocumentHeading to show the formatted record and DocumentText to show (or hide) the original database entry.
+description6=The DocumentContent format specification incorporates the same mechanism for hiding and showing raw records as explained for the Bibliography collection, using the DocumentHeading to show the formatted record and DocumentText to show (or hide) the original database entry.
Index: /documented-examples/trunk/lomdemo-e/resources/collectionConfig.properties =================================================================== --- /documented-examples/trunk/lomdemo-e/resources/collectionConfig.properties (revision 36563) +++ /documented-examples/trunk/lomdemo-e/resources/collectionConfig.properties (revision 36564) @@ -1,25 +1,25 @@ -as=QQQall resources -sc=QQQscience resources -name=QQQLOM Demonstration -ar=QQQarts resources -general^title=QQQTitles -general^description=QQQDescriptions -general^keyword=QQQKeywords -text_and_rawtext=QQQAll text +as=all resources +sc=science resources +name=LOM Demonstration +ar=arts resources +general^title=Titles +general^description=Descriptions +general^keyword=Keywords +text_and_rawtext=All text -shortDescription=QQQThis 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 arts/657841.xml or record science/582041.xml.
+shortDescription=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 arts/657841.xml or record science/582041.xml.
-description1=QQQTraditional educational learning object repositories base searching and browsing around the provided metadata. This demonstration collection goes one step further and provides full-text indexing of the on-line resources, where possible.
+description1=Traditional educational learning object repositories base searching and browsing around the provided metadata. This demonstration collection goes one step further and provides full-text indexing of the on-line resources, where possible.
-description2=QQQBrowse 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.
+description2=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.
-description3=QQQHow the collection works
The records were exported from the Calgary Repository in LOM format. LOMPlugin is used to process the records. Using the -download_srcdocs option to the plugin will search for general^identifier^entry or technical^location, and attempt to download the source document into a _gsdldown.all folder (import/arts/_gsdldown.all) in the same folder as the LOM record.
+description3=How the collection works
The records were exported from the Calgary Repository in LOM format. LOMPlugin is used to process the records. Using the -download_srcdocs option to the plugin will search for general^identifier^entry or technical^location, and attempt to download the source document into a _gsdldown.all folder (import/arts/_gsdldown.all) in the same folder as the LOM record.
-description4=QQQIn porting the lomdemo-e collection from Greenstone 2 (GS2) to Greenstone 3, the predefined GS2 macros of _httpopenmdicon_ and httpclosemdicon_, used to show and hide sections of the tabular display of LOM metadata, needed to be defined in siteConfig.xml by inserting the following 2 lines into the file\: \ +description4=
In porting the lomdemo-e collection from Greenstone 2 (GS2) to Greenstone 3, the predefined GS2 macros of _httpopenmdicon_ and httpclosemdicon_, used to show and hide sections of the tabular display of LOM metadata, needed to be defined in siteConfig.xml by inserting the following 2 lines into the file\: \
\ -<replace macro=QQQ"_httpopenmdicon_" scope="metadata" text="sites/localsite/collect/lomdemo-e/images/open.gif" data-img-path="sites/localsite/collect/lomdemo-e/images/" resolve="false"/> \n\ -<replace macro=QQQ"_httpclosemdicon_" scope="metadata" text="sites/localsite/collect/lomdemo-e/images/close.gif" data-img-path="sites/localsite/collect/lomdemo-e/images/" resolve="false"/> \n\ +<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"/> \n\ +<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"/> \n\\n\ -description5=QQQThe open and close icon images themselves were then placed into the location indicated above\: lomdemo-e/images/ subfolder. The JavaScript to show and hide associated sections of LOM metadata when the close and open icons are clicked is defined in lomdemo-e/script/lomscript.js, and the CSS styling rules for the tabular display of the LOM metadata is in lomdemo-e/style/lom-style.css.
+description5=The open and close icon images themselves were then placed into the location indicated above\: lomdemo-e/images/ subfolder. The JavaScript to show and hide associated sections of LOM metadata when the close and open icons are clicked is defined in lomdemo-e/script/lomscript.js, and the CSS styling rules for the tabular display of the LOM metadata is in lomdemo-e/style/lom-style.css.
Index: /documented-examples/trunk/manifest-demo-e/resources/collectionConfig.properties =================================================================== --- /documented-examples/trunk/manifest-demo-e/resources/collectionConfig.properties (revision 36563) +++ /documented-examples/trunk/manifest-demo-e/resources/collectionConfig.properties (revision 36564) @@ -1,18 +1,18 @@ -name=QQQmanifest-demo-e -dls.Organization=QQQOrganizations -text=QQQText -section=QQQChapter -document=QQQBook -dls.Titles=QQQTitles -dls.Keyword=QQQHow to -dls.Subject=QQQSubjects +name=manifest-demo-e +dls.Organization=Organizations +text=Text +section=Chapter +document=Book +dls.Titles=Titles +dls.Keyword=How to +dls.Subject=Subjects -textdate=QQQpublication date\: -textnumpages=QQQno. of pages\: -textsource=QQQsource ref\: +textdate=publication date\: +textnumpages=no. of pages\: +textsource=source ref\: -shortDescription=QQQThis 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.
+shortDescription=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.
-description=QQQFeatures of this collection
\n\ +description=Features of this collection
\n\
0. Run setup/source setup.bash in top level before starting.
0. Run setup/source setup.bash in top level before starting.
1. Build the collection initially\:
\n\
+description1=
1. Build the collection initially\:
\n\
perl -S import.pl -site localsite documented-examples/manifest-demo-e \n\ perl -S buildcol.pl -site localsite -activate documented-examples/manifest-demo-e\n\ @@ -34,5 +34,5 @@ Preview the collection. Contains 8 documents, 5 from BOSTID and 3 from EC Courier.
2. Add some new documents into the collection.
\n\
+description2=
2. Add some new documents into the collection.
\n\
\n\
Copy the three folders fb33fe fb34fe wb34te from import.extra into import. \n\
@@ -43,5 +43,5 @@
Now there should be FAO Better Farming Documents, and one World Bank document.
3. Delete some documents from the collection.
\n\
+description3=
3. Delete some documents from the collection.
\n\
perl -S incremental-import.pl -site localsite -manifest manifests/delete-some-files.xml documented-examples/manifest-demo-e \n\ perl -S incremental-buildcol.pl -site localsite -activate documented-examples/manifest-demo-e\n\ @@ -50,5 +50,5 @@ Now the EC Courier documents should be gone.
4. Modify some metadata
\n\
+description4=
4. Modify some metadata
\n\
Copy import.extra/fb33fe-metadata.xml to import/fb33fe/metadata.xml \n\ Copy import.extra/fb34fe-metadata.xml to import/fb34fe/metadata.xml \n\ Index: /documented-examples/trunk/marc-e/resources/collectionConfig.properties =================================================================== --- /documented-examples/trunk/marc-e/resources/collectionConfig.properties (revision 36563) +++ /documented-examples/trunk/marc-e/resources/collectionConfig.properties (revision 36564) @@ -1,18 +1,18 @@ -name=QQQMARC example -index_text=QQQtext -index_Title=QQQTitle -sampleoid=QQQD0s156 +name=MARC example +index_text=text +index_Title=Title +sampleoid=D0s156 -shortDescription=QQQThis collection, which contains _about\:numdocs_ MARC entries, is based on the MARC records of working papers published by Computer Science Department at the University of Waikato. Here is a sample document in the collection.
+shortDescription=This collection, which contains _about\:numdocs_ MARC entries, is based on the MARC records of working papers published by Computer Science Department at the University of Waikato. Here is a sample document in the collection.
-description1=QQQHow the collection works
The configuration file, collectionConfig.xml, uses MARCPlugin to process the MARC records, as well as the standard plugins. There are three classifiers, based on dc.Title, dc.Creator, and dc.Subject metadata. The Title classifier uses AZList, while the other two use AZCompactList, which groups items with the same metadata into a bookshelf. The -removesuffix argument for the Title and Creator classifiers removes suffixes from the metadata string (dc.Title and dc.Creator respectively). This is specified as a PERL regular expression, and trims characters (such as trailing punctuation) from the strings for display.
+description1=How the collection works
The configuration file, collectionConfig.xml, uses MARCPlugin to process the MARC records, as well as the standard plugins. There are three classifiers, based on dc.Title, dc.Creator, and dc.Subject metadata. The Title classifier uses AZList, while the other two use AZCompactList, which groups items with the same metadata into a bookshelf. The -removesuffix argument for the Title and Creator classifiers removes suffixes from the metadata string (dc.Title and dc.Creator respectively). This is specified as a PERL regular expression, and trims characters (such as trailing punctuation) from the strings for display.
-description2=QQQThe VList 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, dc.Title is displayed, along with dc.Creator and dc.Publisher. [sibling\:dc.Creator] is used as dc.Creator has multiple values, and specifies that all values be output, not just the first one.
+description2=The VList 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, dc.Title is displayed, along with dc.Creator and dc.Publisher. [sibling\:dc.Creator] is used as dc.Creator has multiple values, and specifies that all values be output, not just the first one.
-description3=QQQThe MARC plugin uses a special file to map MARC field numbers to Greenstone-style metadata. This file resides in the greenstone3 installation folder\'s gs2build/etc directory, and is called marc2dc.txt. 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
<MARC field number> -> GreenstoneMetadataNameLines in the file that begin with "\#" are comments. +description3=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 gs2build/etc directory, and is called marc2dc.txt. 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
<MARC field number> -> GreenstoneMetadataNameLines in the file that begin with "\#" are comments. -description4=QQQThe standard version of this file is loosely based on the MARC to Dublin Core mapping found at http\://www.loc.gov/marc/marc2dc.html (which assumes USMARC/MARC21).
+description4=The standard version of this file is loosely based on the MARC to Dublin Core mapping found at http\://www.loc.gov/marc/marc2dc.html (which assumes USMARC/MARC21).
-description5=QQQMultiple 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 dc.Creator. Actual MARC records normally define only one of these fields, and anyway Greenstone allows multi-valued metadata.
+description5=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 dc.Creator. Actual MARC records normally define only one of these fields, and anyway Greenstone allows multi-valued metadata.
-description6=QQQSome 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 dc.Date, using the following mapping line\:
260$c$g -> dc.DateGreenstone also provides a file for mapping MARC to qualified dublin core\: in your Greenstone 3 installation folder\'s gs2build/etc/marc2qdc.txt. This can be used by the MARC plugin by setting the -metadata_mapping_file option to "marc2qdc.txt". +description6=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 dc.Date, using the following mapping line\:
260$c$g -> dc.DateGreenstone also provides a file for mapping MARC to qualified dublin core\: in your Greenstone 3 installation folder\'s gs2build/etc/marc2qdc.txt. This can be used by the MARC plugin by setting the -metadata_mapping_file option to "marc2qdc.txt". Index: /documented-examples/trunk/oai-e/resources/collectionConfig.properties =================================================================== --- /documented-examples/trunk/oai-e/resources/collectionConfig.properties (revision 36563) +++ /documented-examples/trunk/oai-e/resources/collectionConfig.properties (revision 36564) @@ -1,37 +1,37 @@ -name=QQQOAI demo -Rights=QQQRights -Caption=QQQCaption -Publisher=QQQPublisher -original=QQQoriginal -Subject=QQQSubject -available=QQQavailable -sampleoid=QQQ01dle6 -index_Description=QQQphoto captions -document=QQQDocument +name=OAI demo +Rights=Rights +Caption=Caption +Publisher=Publisher +original=original +Subject=Subject +available=available +sampleoid=01dle6 +index_Description=photo captions +document=Document -shortDescription=QQQThis collection demonstrates Greenstone\'s ImportFrom feature. Using the Open Archive Protocol (version 1.1), it retrieves metadata from rocky.dlib.vt.edu/~jcdlpix, a collection of photographs taken at the inaugural Joint Conference on Digital Libraries. 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.
+shortDescription=This collection demonstrates Greenstone\'s ImportFrom feature. Using the Open Archive Protocol (version 1.1), it retrieves metadata from rocky.dlib.vt.edu/~jcdlpix, a collection of photographs taken at the inaugural Joint Conference on Digital Libraries. 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.
-description1=QQQHow the collection works
The collection configuration file, collectionConfig.xml, includes an acquire line that is interpreted by a special program called importfrom.pl. Like other Greenstone programs, this takes as argument the name of the collection, and provides a summary of other arguments when invoked with argument -help. It reads the collection configuration file, finds the acquire line, and processes it. In this case, it is run with the command\:
importfrom.pl oai-e(the collection\'s name is oai-e). +description1=How the collection works
The collection configuration file, collectionConfig.xml, includes an acquire line that is interpreted by a special program called importfrom.pl. Like other Greenstone programs, this takes as argument the name of the collection, and provides a summary of other arguments when invoked with argument -help. It reads the collection configuration file, finds the acquire line, and processes it. In this case, it is run with the command\:
importfrom.pl oai-e(the collection\'s name is oai-e). -description2=QQQThe acquire line in the configuration file specifies the OAI protocol and gives the base URL of an OAI repository. The importfrom program downloads all the metadata in that repository into the collection\'s import directory. The getdoc argument instructs it to also download the collection\'s source documents, whose URLs are given in each document\'s Dublin Core Identifier field (this is a common convention). The metadata files, which each contain an XML record for one source document, are placed in the import file structure along with the documents themselves, and the document filename is the same as the filename in the URL. The Identifier field is overridden to give the local filename, and its original value is retained in a new field called OrigURL.
+description2=The acquire line in the configuration file specifies the OAI protocol and gives the base URL of an OAI repository. The importfrom program downloads all the metadata in that repository into the collection\'s import directory. The getdoc argument instructs it to also download the collection\'s source documents, whose URLs are given in each document\'s Dublin Core Identifier field (this is a common convention). The metadata files, which each contain an XML record for one source document, are placed in the import file structure along with the documents themselves, and the document filename is the same as the filename in the URL. The Identifier field is overridden to give the local filename, and its original value is retained in a new field called OrigURL.
-description3=QQQThis oai-e collection\'s own etc/oai.txt is an example of a downloaded metadata file.
+description3=This oai-e collection\'s own etc/oai.txt is an example of a downloaded metadata file.
-description4=QQQOnce 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 input_encoding argument because data in this archive contains extended characters. It also has a default_language 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 language 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 ImagePlugin. This plugin specifies the resolution for the screen versions of the images.
+description4=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 input_encoding argument because data in this archive contains extended characters. It also has a default_language 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 language 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 ImagePlugin. This plugin specifies the resolution for the screen versions of the images.
-description5=QQQExtracted 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.
+description5=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.
-description6=QQQThe collection configuration file, collectionConfig.xml, specifies a single full-text index containing dc.Description metadata and overrides Greenstone\'s custom gsf format templates DocumentHeading and DocumentContent (XSL). When a document is displayed, the DocumentHeading format statement puts out its dc.Subject. Then the DocumentContent statement follows this with screenicon, which is produced by ImagePlugin and gives a screen-resolution version of the image; it can be hyperlinked to the dc.OrigURL 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 dc.Description, also with a hyperlink; the image\'s size and type, again generated as metadata by ImagePlugin; and then dc.Subject, dc.Publisher, and dc.Rights metadata. This is the result.
+description6=The collection configuration file, collectionConfig.xml, specifies a single full-text index containing dc.Description metadata and overrides Greenstone\'s custom gsf format templates DocumentHeading and DocumentContent (XSL). When a document is displayed, the DocumentHeading format statement puts out its dc.Subject. Then the DocumentContent statement follows this with screenicon, which is produced by ImagePlugin and gives a screen-resolution version of the image; it can be hyperlinked to the dc.OrigURL 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 dc.Description, also with a hyperlink; the image\'s size and type, again generated as metadata by ImagePlugin; and then dc.Subject, dc.Publisher, and dc.Rights metadata. This is the result.
-description7=QQQThere are two browsing classifiers, one based on dc.Subject metadata and the other on dc.Description metadata (but with a button named "captions"). Recall that the AZCompactList classifier is like AZList but generates a bookshelf for duplicate items. In this collection there are a lot of images but only a few different values for dc.Subject metadata.
+description7=There are two browsing classifiers, one based on dc.Subject metadata and the other on dc.Description metadata (but with a button named "captions"). Recall that the AZCompactList classifier is like AZList but generates a bookshelf for duplicate items. In this collection there are a lot of images but only a few different values for dc.Subject metadata.
-description8=QQQIt\'s a little surprising that AZCompactList is used (instead of AZList) for the dc.Description index too, because dc.Description 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 AZList 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 (mincompact, maxcompact, mingroup, minnesting) to control the display -- e.g. groups (represented by bookshelves) are not formed unless they have at least 5 (mingroup) items. To find out the meaning of the other arguments for this classifier, execute the command classinfo.pl AZCompactList. The programs classinfo.pl (for classifiers) and pluginfo.pl (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.
+description8=It\'s a little surprising that AZCompactList is used (instead of AZList) for the dc.Description index too, because dc.Description 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 AZList 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 (mincompact, maxcompact, mingroup, minnesting) to control the display -- e.g. groups (represented by bookshelves) are not formed unless they have at least 5 (mingroup) items. To find out the meaning of the other arguments for this classifier, execute the command classinfo.pl AZCompactList. The programs classinfo.pl (for classifiers) and pluginfo.pl (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.
-description9=QQQThe VList format specification shows the image thumbnail, hyperlinked to the associated document, followed by dc.Description metadata; the result can be seen in the CL2 classifier browser. The Vlists for the classifiers use numleafdocs to switch between an icon representing several documents (which will appear as a bookshelf) and the thumbnail itself, if there is only one image.
+description9=The VList format specification shows the image thumbnail, hyperlinked to the associated document, followed by dc.Description metadata; the result can be seen in the CL2 classifier browser. The Vlists for the classifiers use numleafdocs to switch between an icon representing several documents (which will appear as a bookshelf) and the thumbnail itself, if there is only one image.
-description10=QQQThe Greenstone OAI server
Greenstone comes with a built-in OAI data provider. This runs as a CGI program called "oaiserver.cgi", and is installed in the Greenstone cgi-bin 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.
+description10=The Greenstone OAI server
Greenstone comes with a built-in OAI data provider. This runs as a CGI program called "oaiserver.cgi", and is installed in the Greenstone cgi-bin 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.
-description11=QQQConfiguration of the server is done via the oai.cfg file in the Greenstone etc 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 oaicollection list.
+description11=Configuration of the server is done via the oai.cfg file in the Greenstone etc 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 oaicollection list.
-description12=QQQGreenstone\'s OAI server currently supports Dublin Core, qualified Dublin Core and rfc1807 metadata sets. The oaimetadata 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 oai.cfg file for details.
+description12=Greenstone\'s OAI server currently supports Dublin Core, qualified Dublin Core and rfc1807 metadata sets. The oaimetadata 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 oai.cfg file for details.
Index: /documented-examples/trunk/pagedimg-e/resources/collectionConfig.properties =================================================================== --- /documented-examples/trunk/pagedimg-e/resources/collectionConfig.properties (revision 36563) +++ /documented-examples/trunk/pagedimg-e/resources/collectionConfig.properties (revision 36564) @@ -1,19 +1,19 @@ -name=QQQPaged Image example -section_text=QQQnewspaper pages +name=Paged Image example +section_text=newspaper pages -shortDescription=QQQThis collection contains a few newspapers from the Niupepa collection of Maori newspapers.
+shortDescription=This collection contains a few newspapers from the Niupepa collection of Maori newspapers.
-description1=QQQHow the collection works
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.
+description1=How the collection works
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.
-description2=QQQThere 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\: Te Waka o Te Iwi, Vol. 1, No. 1 (in import/09/09_1_1.item) and Te Whetu o Te Tau, Vol. 1, No. 3 (in import/10/10_1_3.item. This format allows specification of document level metadata, and a single list of pages.
+description2=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\: Te Waka o Te Iwi, Vol. 1, No. 1 (in import/09/09_1_1.item) and Te Whetu o Te Tau, Vol. 1, No. 3 (in import/10/10_1_3.item. This format allows specification of document level metadata, and a single list of pages.
-description3=QQQThe 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 Matariki 1881, No. 2 in import/xml/23/23__2.item. 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.
+description3=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 Matariki 1881, No. 2 in import/xml/23/23__2.item. 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.
-description4=QQQPaged documents can be presented with a hierarchical table of contents (e.g. 23__1.2.1), or with a single-depth structure (e.g. 10_1_2). This is specified by the -documenttype (hierarchy|paged) 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.
+description4=Paged documents can be presented with a hierarchical table of contents (e.g. 23__1.2.1), or with a single-depth structure (e.g. 10_1_2). This is specified by the -documenttype (hierarchy|paged) 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.
-description5=QQQplugin PagedImagePlugin -documenttype hierarchy -process_exp xml.*\.item$ ...
+description5=
plugin PagedImagePlugin -documenttype paged ...plugin PagedImagePlugin -documenttype hierarchy -process_exp xml.*\.item$ ...
-description6=QQQ
plugin PagedImagePlugin -documenttype paged ...XML based newpapers have been grouped into a folder called xml. This enables us to process these files differently, by utilising the process_exp 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.
+description6=XML based newpapers have been grouped into a folder called xml. This enables us to process these files differently, by utilising the process_exp 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.
-description7=QQQFormatting
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.
+description7=Formatting
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.
Index: /documented-examples/trunk/style-e/resources/collectionConfig.properties =================================================================== --- /documented-examples/trunk/style-e/resources/collectionConfig.properties (revision 36563) +++ /documented-examples/trunk/style-e/resources/collectionConfig.properties (revision 36564) @@ -1,50 +1,50 @@ -name=QQQCascading Style Sheets
Demo collection -textdate=QQQpublication date\: -textnumpages=QQQno. of pages\: -textsource=QQQsource ref\: -section_chapter=QQQchapter -document_book=QQQbook +name=Cascading Style Sheets
Demo collection +textdate=publication date\: +textnumpages=no. of pages\: +textsource=source ref\: +section_chapter=chapter +document_book=book -dls.Organization=QQQOrganizations -dls.Subject=QQQSubjects -index_text=QQQText -index_document=QQQBook -index_section=QQQChapter -dls.Titles=QQQTitles -dls.Keyword=QQQHow to -#depositormetadata=QQQ{"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"} +dls.Organization=Organizations +dls.Subject=Subjects +index_text=Text +index_document=Book +index_section=Chapter +dls.Titles=Titles +dls.Keyword=How to +#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"} -shortDescription=QQQThis 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.
+shortDescription=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.
-description1=QQQA combination of JavaScript and the overriding of GS3 XSL templates in Greenstone 3\'s global format statement is used by the collection to provide the stylesheet switching. As in some other Documented Example Collections, GLI\'s Format > Format Features > global can be used to define the additionalHeaderContent template. Doing so overrides the existing additionalHeaderContent template, and appends any specified HTML elements to the HTML header.
+description1=A combination of JavaScript and the overriding of GS3 XSL templates in Greenstone 3\'s global format statement is used by the collection to provide the stylesheet switching. As in some other Documented Example Collections, GLI\'s Format > Format Features > global can be used to define the additionalHeaderContent template. Doing so overrides the existing additionalHeaderContent template, and appends any specified HTML elements to the HTML header.
-description2=QQQIn this case, the additionalHeaderContent specifies the custom collection stylesheet currently active and the JavaScript to facilitate the stylesheet switching when a link is clicked. The create-banner XSL template in the global 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\ +description2=
In this case, the additionalHeaderContent specifies the custom collection stylesheet currently active and the JavaScript to facilitate the stylesheet switching when a link is clicked. The create-banner XSL template in the global 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\
\n\ - <xsl\:template name=QQQ"additionalHeaderContent"> \n\ - <xsl\:variable name=QQQ"httpCollection"> \n\ - <xsl\:value-of select=QQQ"/page/pageResponse/collection/metadataList/metadata[@name=\'httpPath\']"/> \n\ + <xsl\:template name="additionalHeaderContent"> \n\ + <xsl\:variable name="httpCollection"> \n\ + <xsl\:value-of select="/page/pageResponse/collection/metadataList/metadata[@name=\'httpPath\']"/> \n\ </xsl\:variable> \n\ - <link rel=QQQ"stylesheet" href="{$httpCollection}/style/gs3-style-default-extra.css" type="text/css" \n\ - title=QQQ"GS3 Style" id="custom-style" charset="UTF-8"/> \n\ - <script src=QQQ"{$httpCollection}/script/custom-script.js" type="text/javascript"> \n\ + <link rel="stylesheet" href="{$httpCollection}/style/gs3-style-default-extra.css" type="text/css" \n\ + title="GS3 Style" id="custom-style" charset="UTF-8"/> \n\ + <script src="{$httpCollection}/script/custom-script.js" type="text/javascript"> \n\ </script> \n\ </xsl\:template> \n\ \n\ - <xsl\:template name=QQQ"create-banner"> \n\ - <div class=QQQ"choose_style"> \n\ + <xsl\:template name="create-banner"> \n\ + <div class="choose_style"> \n\ Choose a style\: \n\ - <a href=QQQ"#" onclick="replaceStyle(\'gs3-style-default-extra\');return false;">Default Greenstone</a>, \n\ - <a href=QQQ"#" onclick="replaceStyle(\'gs3-style-blue\');return false;">Blue</a>, \n\ - <a href=QQQ"#" onclick="replaceStyle(\'gs3-style-olive-purple\');return false;">OlivePurple</a>, \n\ - <a href=QQQ"#" onclick="replaceStyle(\'');return false;">None</a> \n\ + <a href="#" onclick="replaceStyle(\'gs3-style-default-extra\');return false;">Default Greenstone</a>, \n\ + <a href="#" onclick="replaceStyle(\'gs3-style-blue\');return false;">Blue</a>, \n\ + <a href="#" onclick="replaceStyle(\'gs3-style-olive-purple\');return false;">OlivePurple</a>, \n\ + <a href="#" onclick="replaceStyle(\'');return false;">None</a> \n\ </div> \n\ - <div id=QQQ"gs_banner" class="ui-widget-header ui-corner-bottom"> \n\ - <div id=QQQ"titlesearchcontainer"> \n\ - <xsl\:call-template name=QQQ"page-title-area"/> \n\ - <xsl\:call-template name=QQQ"quick-search-area"/> \n\ - <div style=QQQ"clear\:both;"><xsl\:text> </xsl\:text></div> \n\ + <div id="gs_banner" class="ui-widget-header ui-corner-bottom"> \n\ + <div id="titlesearchcontainer"> \n\ + <xsl\:call-template name="page-title-area"/> \n\ + <xsl\:call-template name="quick-search-area"/> \n\ + <div style="clear\:both;"><xsl\:text> </xsl\:text></div> \n\ </div> \n\ - <xsl\:call-template name=QQQ"browsing-tabs"/> \n\ + <xsl\:call-template name="browsing-tabs"/> \n\ </div> \n\ </xsl\:template> \n\ @@ -52,22 +52,22 @@ -description3=QQQIf you want to download any of these stylesheets for your own collections, here are links to them\: \n\ +description3=
If you want to download any of these stylesheets for your own collections, here are links to them\: \n\
Using a downloaded stylesheet \n\ +description4=
Using a downloaded stylesheet \n\
<xsl\:template name=QQQ"additionalHeaderContent"> \n\ - <xsl\:variable name=QQQ"httpCollection"> \n\ - <xsl\:value-of select=QQQ"/page/pageResponse/collection/metadataList/metadata[@name=\'httpPath\']"/> \n\ +<xsl\:template name="additionalHeaderContent"> \n\ + <xsl\:variable name="httpCollection"> \n\ + <xsl\:value-of select="/page/pageResponse/collection/metadataList/metadata[@name=\'httpPath\']"/> \n\ </xsl\:variable> \n\ - <link href=QQQ"{$httpCollection}/style/stylesheet-name.css" rel="stylesheet" type="text/css"/> \n\ + <link href="{$httpCollection}/style/stylesheet-name.css" rel="stylesheet" type="text/css"/> \n\ </xsl\:template>\n\
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.
+shortDescription=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.
-description1=QQQThe collection configuration file, collectionConfig.xml, contains the plugins MediaWikiPlugin, ImagePlugin, ZipPlugin, PDFPlugin, PowerPointPlugin, WordPlugin (along with the standard plugins GreenstoneXMLPlugin, ArchivesInfPlugin and DirectoryPlugin). The MediaWikiPlugin handles the HTML pages downloaded from a MediaWiki website, while ImagePlugin, ZipPlugin, PDFPlugin, PowerPointPlugin and WordPlugin handle the image, zip, PDF, PowerPoint and Word files associated with the Greenstone Wiki.
+description1=The collection configuration file, collectionConfig.xml, contains the plugins MediaWikiPlugin, ImagePlugin, ZipPlugin, PDFPlugin, PowerPointPlugin, WordPlugin (along with the standard plugins GreenstoneXMLPlugin, ArchivesInfPlugin and DirectoryPlugin). The MediaWikiPlugin handles the HTML pages downloaded from a MediaWiki website, while ImagePlugin, ZipPlugin, PDFPlugin, PowerPointPlugin and WordPlugin handle the image, zip, PDF, PowerPoint and Word files associated with the Greenstone Wiki.
-description2=QQQTo build a collection from a MediaWiki website of your choice, you would first download the wiki files using the MediaWiki option on the Download panel of GLI. This download type works in a similar way to a the Web download, but is specially designed for crawling MediaWiki websites.
+description2=To build a collection from a MediaWiki website of your choice, you would first download the wiki files using the MediaWiki option on the Download panel of GLI. This download type works in a similar way to a the Web download, but is specially designed for crawling MediaWiki websites.
-description3=QQQOnce the files are downloaded, copy them into a collection using the Gather, dragging them from the Downloaded Files folder in the Workspace tree on the left-hand side.
+description3=Once the files are downloaded, copy them into a collection using the Gather, dragging them from the Downloaded Files folder in the Workspace tree on the left-hand side.
-description4=QQQIn the Document Plugins section of the Design panel, add MediaWikiPlugin. MediaWikiPlugin 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, collectionConfig.xml.
+description4=In the Document Plugins section of the Design panel, add MediaWikiPlugin. MediaWikiPlugin 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, collectionConfig.xml.
Index: /documented-examples/trunk/wrdpdf-e/resources/collectionConfig.properties =================================================================== --- /documented-examples/trunk/wrdpdf-e/resources/collectionConfig.properties (revision 36563) +++ /documented-examples/trunk/wrdpdf-e/resources/collectionConfig.properties (revision 36564) @@ -1,14 +1,14 @@ -name=QQQMSWord and PDF demonstration -document_text=QQQdocuments +name=MSWord and PDF demonstration +document_text=documents -shortDescription=QQQThis 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.
+shortDescription=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.
-description1=QQQThe 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.
+description1=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.
-description2=QQQThis collection\'s configuration file, collectionConfig.xml, contains the four plugins WordPlugin, RTFPlugin, PDFPlugin and PostScriptPlugin (along with the standard four, GreenstoneXMLPlugin, MetadataXMLPlugin, ArchivesInfPlugin and DirectoryPlugin). These four plugins all extract Title and Source (i.e. filename) metadata.
+description2=This collection\'s configuration file, collectionConfig.xml, contains the four plugins WordPlugin, RTFPlugin, PDFPlugin and PostScriptPlugin (along with the standard four, GreenstoneXMLPlugin, MetadataXMLPlugin, ArchivesInfPlugin and DirectoryPlugin). These four plugins all extract Title and Source (i.e. filename) metadata.
-description3=QQQGreenstone 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 images 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 Greenstone wiki. Alternatively, a new Greenstone 3 collection will add in a pre-configured UnknownConverterPlugin that will use apache tika 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 The UnknownConverterPlugin page on the Greenstone wiki.
+description3=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 images 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 Greenstone wiki. Alternatively, a new Greenstone 3 collection will add in a pre-configured UnknownConverterPlugin that will use apache tika 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 The UnknownConverterPlugin page on the Greenstone wiki.
-description4=QQQThe collection configuration file, collectionConfig.xml, includes a single index, based on document text, and one classifier, an AZList based on Title metadata, shown in CL1 (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\ +description4=
The collection configuration file, collectionConfig.xml, includes a single index, based on document text, and one classifier, an AZList based on Title metadata, shown in CL1 (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\
Here is a format statement that achieves exactly the same effect explicitly. It applies to all Vlists, and so controls both search results list and the alphabetic title browser. \n\ +description5=
Here is a format statement that achieves exactly the same effect explicitly. It applies to all Vlists, and so controls both search results list and the alphabetic title browser. \n\
\ <format> \n\ - <gsf\:template match=QQQ"documentNode"> \n\ - <gsf\:format-gs2><![CDATA[<td valign=QQQ"top">[link][icon][/link]</td> \n\ -<td valign=QQQ"top">[ex.srclink]{Or}{[ex.thumbicon],[ex.srcicon]}[ex./srclink]</td> \n\ -<td valign=QQQ"top">[highlight] {Or}{[dc.Title],[exp.Title],[ex.Title],Untitled} [/highlight]{If}{[ex.Source],<br><i>([ex.Source])</i>}</td>]]></gsf\:format-gs2> \n\ - <td valign=QQQ"top"> \n\ - <gsf\:link type=QQQ"document"> \n\ - <gsf\:icon type=QQQ"document"/> \n\ + <gsf\:template match="documentNode"> \n\ + <gsf\:format-gs2><![CDATA[<td valign="top">[link][icon][/link]</td> \n\ +<td valign="top">[ex.srclink]{Or}{[ex.thumbicon],[ex.srcicon]}[ex./srclink]</td> \n\ +<td valign="top">[highlight] {Or}{[dc.Title],[exp.Title],[ex.Title],Untitled} [/highlight]{If}{[ex.Source],<br><i>([ex.Source])</i>}</td>]]></gsf\:format-gs2> \n\ + <td valign="top"> \n\ + <gsf\:link type="document"> \n\ + <gsf\:icon type="document"/> \n\ </gsf\:link> \n\ </td> \n\ - <td valign=QQQ"top"> \n\ - <gsf\:link type=QQQ"source"> \n\ + <td valign="top"> \n\ + <gsf\:link type="source"> \n\ <gsf\:choose-metadata> \n\ - <gsf\:metadata name=QQQ"thumbicon"/> \n\ - <gsf\:metadata name=QQQ"srcicon"/> \n\ + <gsf\:metadata name="thumbicon"/> \n\ + <gsf\:metadata name="srcicon"/> \n\ </gsf\:choose-metadata> \n\ </gsf\:link> \n\ </td> \n\ - <td valign=QQQ"top"> \n\ - <span class=QQQ"highlight"> \n\ - <gsf\:choose-metadata><gsf\:metadata name=QQQ"dc.Title"/><gsf\:metadata name="exp.Title"/><gsf\:metadata name="Title"/>Untitled</gsf\:choose-metadata> \n\ + <td valign="top"> \n\ + <span class="highlight"> \n\ + <gsf\:choose-metadata><gsf\:metadata name="dc.Title"/><gsf\:metadata name="exp.Title"/><gsf\:metadata name="Title"/>Untitled</gsf\:choose-metadata> \n\ </span> \n\ <gsf\:switch> \n\ - <gsf\:metadata name=QQQ"Source"/> \n\ - <gsf\:when test=QQQ"exists"> \n\ + <gsf\:metadata name="Source"/> \n\ + <gsf\:when test="exists"> \n\ <br/> \n\ - <i>(<gsf\:metadata name=QQQ"Source"/>)</i> \n\ + <i>(<gsf\:metadata name="Source"/>)</i> \n\ </gsf\:when> \n\ </gsf\:switch> \n\