Index: /documented-examples/trunk/dls-e/resources/collectionConfig.properties =================================================================== --- /documented-examples/trunk/dls-e/resources/collectionConfig.properties (revision 36577) +++ /documented-examples/trunk/dls-e/resources/collectionConfig.properties (revision 36578) @@ -1,51 +1,51 @@ -name=QQQQDevelopment Library Subset collection -section_Title=QQQQsection titles -section_text=QQQQchapters -document_text=QQQQentire documents -document=QQQQDocument -textdate=QQQQpublication date\: -textnumpages=QQQQno. of pages\: -textsource=QQQQsource 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=QQQQ
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.
+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=QQQQThe 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=QQQQ
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=QQQQThe 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=QQQQPlugins. 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=QQQQThe 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=QQQQSearchable 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=QQQQThe 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=QQQQClassifiers. 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=QQQQThe 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=QQQQCover 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=QQQQFormat 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=QQQQThe 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=QQQQGreenstone 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=QQQQCollection-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=QQQQLanguage 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=QQQQDescription 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=QQQQ
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=QQQQHierarchy 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=QQQQFor 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=QQQQThese 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=QQQQIn 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=QQQQThe 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/oai-e/resources/collectionConfig.properties =================================================================== --- /documented-examples/trunk/oai-e/resources/collectionConfig.properties (revision 36577) +++ /documented-examples/trunk/oai-e/resources/collectionConfig.properties (revision 36578) @@ -1,37 +1,37 @@ -name=QQQQOAI demo -Rights=QQQQRights -Caption=QQQQCaption -Publisher=QQQQPublisher -original=QQQQoriginal -Subject=QQQQSubject -available=QQQQavailable -sampleoid=QQQQ01dle6 -index_Description=QQQQphoto captions -document=QQQQDocument +name=OAI demo +Rights=Rights +Caption=Caption +Publisher=Publisher +original=original +Subject=Subject +available=available +sampleoid=01dle6 +index_Description=photo captions +document=Document -shortDescription=QQQQThis 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=QQQQHow 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=QQQQThe 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=QQQQThis 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=QQQQOnce 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=QQQQExtracted 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=QQQQThe 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=QQQQThere 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=QQQQIt\'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=QQQQThe 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=QQQQThe 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=QQQQConfiguration 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=QQQQGreenstone\'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/wiki-e/resources/collectionConfig.properties =================================================================== --- /documented-examples/trunk/wiki-e/resources/collectionConfig.properties (revision 36577) +++ /documented-examples/trunk/wiki-e/resources/collectionConfig.properties (revision 36578) @@ -1,16 +1,16 @@ -name=QQQQMediaWiki collection -index_Title=QQQQTitles -index_text=QQQQText -index_Source=QQQQFilenames +name=MediaWiki collection +index_Title=Titles +index_text=Text +index_Source=Filenames -shortDescription=QQQQThis 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=QQQQHow the collection works
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.
+description1=How the collection works
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=QQQQTo 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=QQQQOnce 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=QQQQIn 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.