Changeset 36404
- Timestamp:
- 2022-08-20T17:57:50+12:00 (20 months ago)
- Location:
- documented-examples/trunk
- Files:
-
- 9 edited
-
authen-e/resources/collectionConfig.properties (modified) (1 diff)
-
dls-e/resources/collectionConfig.properties (modified) (3 diffs)
-
garish-e/resources/collectionConfig.properties (modified) (1 diff)
-
gsarch-e/resources/collectionConfig.properties (modified) (1 diff)
-
lomdemo-e/resources/collectionConfig.properties (modified) (2 diffs)
-
marc-e/resources/collectionConfig.properties (modified) (1 diff)
-
oai-e/resources/collectionConfig.properties (modified) (2 diffs)
-
style-e/resources/collectionConfig.properties (modified) (3 diffs)
-
wrdpdf-e/resources/collectionConfig.properties (modified) (1 diff)
Legend:
- Unmodified
- Added
- Removed
-
documented-examples/trunk/authen-e/resources/collectionConfig.properties
r36382 r36404 14 14 description3=<p>The authentication scheme controls access to the collection. It works in two steps. First it determines whether to restrict access to the collection as a whole or to individual documents in it, and in the latter case which documents those are (either by giving a list of private documents for which access is to be authenticated, or specifying that all documents are private except for a given list of public documents). Then for access-restricted documents it determines which user groups are to have access.</p> 15 15 16 description4=<p>Authentication is activated using the <i><security></i> XML element in the collectionConfig.xml file. In the example of the authen-e collection, all <i>document</i>s are set to <i>private</i> access by default, with the <i>exception</i> that they are accessible to logged in members of a <i>group</i> called <i> "demo"</i>. The <i>security</i> element further defines a set of documents (<i>documentSet</i>) called "always-public"which contains 2 documents denoted by their document identifiers/OIDs (fb33fe and fb34fe). This documentSet specifies an exceptional case: the documents in the documentSet are <i>not</i> private access like other documents in the collection are by default, but can instead be accessed by anyone in <i>any</i> group, as no group is specified for their access. \n\17 <pre><security default_access= "private" scope="document"> \n\16 description4=<p>Authentication is activated using the <i><security></i> XML element in the collectionConfig.xml file. In the example of the authen-e collection, all <i>document</i>s are set to <i>private</i> access by default, with the <i>exception</i> that they are accessible to logged in members of a <i>group</i> called <i>"demo"</i>. The <i>security</i> element further defines a set of documents (<i>documentSet</i>) called "always-public" which contains 2 documents denoted by their document identifiers/OIDs (fb33fe and fb34fe). This documentSet specifies an exceptional case: the documents in the documentSet are <i>not</i> private access like other documents in the collection are by default, but can instead be accessed by anyone in <i>any</i> group, as no group is specified for their access. \n\ 17 <pre><security default_access="private" scope="document"> \n\ 18 18 <exception> \n\ 19 <group name= "demo"/> \n\19 <group name="demo"/> \n\ 20 20 </exception> \n\ 21 21 <exception> \n\ 22 <documentSet name= "always-public"/> \n\23 <group name= ""/> \n\22 <documentSet name="always-public"/> \n\ 23 <group name=""/> \n\ 24 24 </exception> \n\ 25 <documentSet name= "always-public"> \n\25 <documentSet name="always-public"> \n\ 26 26 <match>fb33fe</match> \n\ 27 27 <match>fb34fe</match> \n\ -
documented-examples/trunk/dls-e/resources/collectionConfig.properties
r36385 r36404 11 11 description1=<h3>How the collection works</h3><p>The DLS collection is fairly complex. If you\'re just starting out you might prefer to look at some other collections first (e.g. <i>Word and PDF demonstration</i>, or the <i>Greenstone Archives</i>, or the <i>Simple Image collection</i>).</p> 12 12 13 description2=<p>The collection configuration file, <tt>collectionConfig.xml</i>, like all collection configuration files, begins with the <i>creator<i> metadata element that gives the email address of the collection\'s creator, and another metadata ( "public") that determines whether the collection will appear on the home page of the Greenstone installation. Note that setting "public" to "false"only removes it from the home page; it will still be accessible in the library to anyone that knows the URL to the collection.</p>13 description2=<p>The collection configuration file, <tt>collectionConfig.xml</i>, like all collection configuration files, begins with the <i>creator<i> metadata element that gives the email address of the collection\'s creator, and another metadata ("public") that determines whether the collection will appear on the home page of the Greenstone installation. Note that setting "public" to "false" only removes it from the home page; it will still be accessible in the library to anyone that knows the URL to the collection.</p> 14 14 15 description3=<p><b>Plugins</b>. The "plugin"lines in the collection configuration file give the plugins used by the collection. The documents in the DLS collection are in HTML, so <i>HTMLPlugin</i> must be included. The <i>description_tags</i> option processes tags in the text that define sections and section titles as described below.</p>15 description3=<p><b>Plugins</b>. The "plugin" lines in the collection configuration file give the plugins used by the collection. The documents in the DLS collection are in HTML, so <i>HTMLPlugin</i> must be included. The <i>description_tags</i> option processes tags in the text that define sections and section titles as described below.</p> 16 16 17 17 description4=<p>The other plugins, <i>GreenstoneXMLPlugin, MetadataXMLPlugin, ArchivesInfPlugin, and DirectoryPlugin</i>, are used by Greenstone for internal purposes and are standard in almost all collections.</p> 18 18 19 description5=<p><b>Searchable indexes</b>. The block of lines starting with <i>indexes</i> specifies what searchable indexes will be available. In this collection there are three: you can see them when you pull down the "Search for" menu on the collection\'s <tt>search page</tt>. The first index is called "chapters", the second "section titles", and the third "entire documents". The names of these three indexes are given by three properties (section_text, section_Title and document_text) in the translatable <tt>collectionConfig.properties</tt> file located in the collection\'s <tt>resources</tt> subfolder.</p>19 description5=<p><b>Searchable indexes</b>. The block of lines starting with <i>indexes</i> specifies what searchable indexes will be available. In this collection there are three: you can see them when you pull down the "Search for" menu on the collection\'s <tt>search page</tt>. The first index is called "chapters", the second "section titles", and the third "entire documents". The names of these three indexes are given by three properties (section_text, section_Title and document_text) in the translatable <tt>collectionConfig.properties</tt> file located in the collection\'s <tt>resources</tt> subfolder.</p> 20 20 21 21 description6=<p>The contents of the indexes -- that is, the specification of what it is that will be searched -- are defined by the <i>indexes</i> line at the beginning of this block. This specifies three indexes, two at the section level (beginning with <i>section:</i>) and one at the document level (beginning with <i>document:</i>). The difference is that a multi-word query will only match a section-level index if all query terms appear in the same section, whereas it will match a document-level index if the terms appear anywhere within the document (which typically comprises several sections). The first and third indexes are <i>section:text</i> and <i>document:text</i>, and the <i>:text</i> means that the full text of sections and documents respectively will be searched. The second is <i>section:Title</i>, which means that <i>Title</i> metadata will be searched -- in this case, section titles (rather than document titles). The three indexes appear in the order in which they are specified on the <i>indexes</i> line.</p> 22 22 23 description7=<p><b>Classifiers</b>. The block of lines labeled <i>classify</i> define the browsing indexes, called "classifiers"in Greenstone. There are four of them, corresponding to four buttons on the navigation bar at the top of each page in the collection (e.g. the <tt>search page</tt>): <i>subjects</i>, <i>titles</i>, <i>organisations</i>, and <i>howto</i> The <i>search</i> button comes first, then come the four classifiers, in order.</p>23 description7=<p><b>Classifiers</b>. The block of lines labeled <i>classify</i> define the browsing indexes, called "classifiers" in Greenstone. There are four of them, corresponding to four buttons on the navigation bar at the top of each page in the collection (e.g. the <tt>search page</tt>): <i>subjects</i>, <i>titles</i>, <i>organisations</i>, and <i>howto</i> The <i>search</i> button comes first, then come the four classifiers, in order.</p> 24 24 25 description8=<p>The first classifier provides access by subject. It is a <i>Hierarchy</i> classifier whose hierarchy is defined in the file <tt>dls.Subject.txt</tt> (the <i>hfile</i> argument); this file is discussed below. This classifier is based on <i>dls.Subject</i> metadata, and when several books appear at a leaf of the hierarchy they are sorted by <i>dls.Title</i> metadata (as you can see when you open classifier browser <tt>CL1.4.1</tt>). The second classifier provides access by title. It is also a <i>Hierarchy</i> classifier, this time based on <i>dls.AZList</i> metadata, whose hierarchy is defined in <tt>dls.AZList.txt</tt>. This file is discussed below. The third provides access by organization: it is a <i>List</i> classifier based on <i>dls.Organization</i> metadata. The <i>-bookshelf_type always</i> option creates a new bookshelf for each organization, even if only one document belongs to that category. The fourth provides access by "Howto"text: it is a <i>List</i> classifier based on <i>dls.Keyword</i> metadata. The <i>-bookshelf_type never</i> option prevents bookshelves being created even if two documents share the same keywords.</p>25 description8=<p>The first classifier provides access by subject. It is a <i>Hierarchy</i> classifier whose hierarchy is defined in the file <tt>dls.Subject.txt</tt> (the <i>hfile</i> argument); this file is discussed below. This classifier is based on <i>dls.Subject</i> metadata, and when several books appear at a leaf of the hierarchy they are sorted by <i>dls.Title</i> metadata (as you can see when you open classifier browser <tt>CL1.4.1</tt>). The second classifier provides access by title. It is also a <i>Hierarchy</i> classifier, this time based on <i>dls.AZList</i> metadata, whose hierarchy is defined in <tt>dls.AZList.txt</tt>. This file is discussed below. The third provides access by organization: it is a <i>List</i> classifier based on <i>dls.Organization</i> metadata. The <i>-bookshelf_type always</i> option creates a new bookshelf for each organization, even if only one document belongs to that category. The fourth provides access by "Howto" text: it is a <i>List</i> classifier based on <i>dls.Keyword</i> metadata. The <i>-bookshelf_type never</i> option prevents bookshelves being created even if two documents share the same keywords.</p> 26 26 27 27 description9=<p><b>Cover images</b>. Greenstone looks for a cover image for each document, whose name is the same as the document\'s but with a <i>.jpg</i> extension. This image is associated with the document, and may be displayed on the document page (see below). Cover images can be switched off by setting the -no_cover_image flag for each plugin.</p> 28 28 29 description10=<p><b>Format statements</b>. The <i>format</i> elements (<format;>, <browse>, <search> and <display> XML elements), called "format statements", govern how various parts of the collection should be displayed. The <i>VList</i> format statement applies to lists of items displayed vertically, such as the lists of titles, subjects and organisations, and the table of contents for the target documents. It is overridden for the search results list by the <i>SearchVList</i> format statement, and also for the <i>Howto</i> classifier by the <i>CL4VList</i> statement (CL4 specifies the fourth classifier).</p>29 description10=<p><b>Format statements</b>. The <i>format</i> elements (<format;>, <browse>, <search> and <display> XML elements), called "format statements", govern how various parts of the collection should be displayed. The <i>VList</i> format statement applies to lists of items displayed vertically, such as the lists of titles, subjects and organisations, and the table of contents for the target documents. It is overridden for the search results list by the <i>SearchVList</i> format statement, and also for the <i>Howto</i> classifier by the <i>CL4VList</i> statement (CL4 specifies the fourth classifier).</p> 30 30 31 31 description11=<p>The <i>DocumentText</i> statement governs how the document text is formatted, with <i>Title</i> metadata ([<i>Title</i>]) in HTML <i>heading</i> format followed by the text of the document [<i>Text</i>]. By default, cover images are shown with each document (<i>DocumentImages</i>), and the <i>DocumentButtons</i> are available: the <i>Expand Text, Expand Contents, Detach</i> and <i>Highlight</i> buttons are shown with each document.</p> … … 35 35 description13=<p><b>Collection-level metadata</b>. The <i><displayItem></i> elements under the top-level <i><displayItemList></i> in the configuration file are also standard in all Greenstone collections. They give general information about the collection, defining its name, and a description that appears on its home page. The description text (defined in the translatable <tt>resources/collectionConfig.properties</i> files) can be seen on the DLS collection\'s home page (this text is part of it).</p> 36 36 37 description14=<p><b>Language translations</b>. In the collection configuration file, lines that look like <tt><displayItem assigned= "true" dictionary="collectionConfig" key="..." name="..."/></tt> allow for translatable collection-level metadata, that are defined in the <tt>resources/collectionConfig.properties</tt> text files and can be translated in the same location such as by creating French and Spanish versions (in <tt>resources/collectionConfig_fr.properties</tt> and <tt>resources/collectionConfig_es.properties</tt>, respectively). Note that we advise translators to go through the GTI (Greenstone Translation Interface) system if they want to contribute translations to Greenstone as used by everyone, such as translations to Greenstone\'s demo collections and these documented example collections. The properties files allow for accented characters (e.g. French <i>é</i>). The files are in UTF-8, and these characters are represented by multi-byte sequences (<C3><A9> in this case). Alternatively they could be represented by their HTML entity names (like <i>&eacute</i>). It makes no difference for how they appear on the screen.</p>37 description14=<p><b>Language translations</b>. In the collection configuration file, lines that look like <tt><displayItem assigned="true" dictionary="collectionConfig" key="..." name="..."/></tt> allow for translatable collection-level metadata, that are defined in the <tt>resources/collectionConfig.properties</tt> text files and can be translated in the same location such as by creating French and Spanish versions (in <tt>resources/collectionConfig_fr.properties</tt> and <tt>resources/collectionConfig_es.properties</tt>, respectively). Note that we advise translators to go through the GTI (Greenstone Translation Interface) system if they want to contribute translations to Greenstone as used by everyone, such as translations to Greenstone\'s demo collections and these documented example collections. The properties files allow for accented characters (e.g. French <i>é</i>). The files are in UTF-8, and these characters are represented by multi-byte sequences (<C3><A9> in this case). Alternatively they could be represented by their HTML entity names (like <i>&eacute</i>). It makes no difference for how they appear on the screen.</p> 38 38 39 description15=<p><b>Description tags</b>. The description tags recognized by <i>HTMLPlugin</i> are inserted into the HTML source text of the documents to define where sections begin and end, and to specify section titles. They look like this: <pre> <!-- <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> --> </pre> The <!-- ... --> markers are used to ensure that these tags are marked as comments in HTML and therefore do not affect document formatting. In the <i>Description</i> part other kinds of metadata can be specified, but this is not done for the style of collection we are describing here. Exactly the same specification (including the <!-- ... --> markers) can be used in Word documents too.</p>39 description15=<p><b>Description tags</b>. The description tags recognized by <i>HTMLPlugin</i> are inserted into the HTML source text of the documents to define where sections begin and end, and to specify section titles. They look like this: <pre> <!-- <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> --> </pre> The <!-- ... --> markers are used to ensure that these tags are marked as comments in HTML and therefore do not affect document formatting. In the <i>Description</i> part other kinds of metadata can be specified, but this is not done for the style of collection we are describing here. Exactly the same specification (including the <!-- ... --> markers) can be used in Word documents too.</p> 40 40 41 41 description16=<p><b>Metadata Files</b>. Metadata for all documents in the DLS collection is provided in metadata.xml files, one per document folder. In this collection\'s <tt>import/r0087e</tt> is the <tt>metadata.xml</tt> file for one book -- <i>Income generation and money management: training women as entrepreneurs</i> -- which is a block of about ten lines encased in <<i>FileSet</i>> ... <<i>/FileSet</i>> tags. It defines <i>dls.Title</i>, <i>dls.Language</i>, <i>dls.Subject</i> and <i>dls.AZList</i> metadata. More than one value can be specified for any metadata item. For example, this book has two dls.Subject classifications. Both of these are stored as metadata values for this particular document (because <i>mode=accumulate</i> is specified; the alternative, and the default, is <i>mode=override</i>).</p> … … 44 44 45 45 description18=<p>For example, the following shows three lines from the subject hierarchy file <tt>dls.Subject.txt</tt>. \n\ 46 <pre> "Animal Husbandry and Animal Product Processing "\n\47 7 "Animal Husbandry and Animal Product Processing " "Animal Husbandry and Animal Product Processing|Cattle "\n\48 7.1 "Cattle " "Animal Husbandry and Animal Product Processing|Other animals (micro-livestock, little known animals, silkworms, reptiles, frogs, snails, game, etc.) "\n\49 7.2 "Other animals (micro-livestock, little known animals, silkworms, reptiles, frogs, snails, game, etc.) "\n\46 <pre> "Animal Husbandry and Animal Product Processing " \n\ 47 7 "Animal Husbandry and Animal Product Processing " "Animal Husbandry and Animal Product Processing|Cattle " \n\ 48 7.1 "Cattle " "Animal Husbandry and Animal Product Processing|Other animals (micro-livestock, little known animals, silkworms, reptiles, frogs, snails, game, etc.) " \n\ 49 7.2 "Other animals (micro-livestock, little known animals, silkworms, reptiles, frogs, snails, game, etc.) " \n\ 50 50 </pre> \n\ 51 51 </p> 52 52 53 description19=<p>These three lines define one top level bookshelf (at position 7), titled "Animal Husbandry and Animal Product Processing ", with two bookshelves underneath it, titled "Cattle " and "Other animals (micro-livestock, little known animals, silkworms, reptiles, frogs, snails, game, etc.) "respectively.</p>53 description19=<p>These three lines define one top level bookshelf (at position 7), titled "Animal Husbandry and Animal Product Processing ", with two bookshelves underneath it, titled "Cattle " and "Other animals (micro-livestock, little known animals, silkworms, reptiles, frogs, snails, game, etc.) " respectively.</p> 54 54 55 description20=<p>In this case, the first strings (and therefore the entries in metadata.xml files) contain the entire hierarchy values. Levels in the hierarchy are separated by "| ". They could be used directly by a <i>Hierarchy</i> classifier without the use of the hierarchy file. However, then the entries would be ordered alphabetically, not in the special order defined by the file.</p>55 description20=<p>In this case, the first strings (and therefore the entries in metadata.xml files) contain the entire hierarchy values. Levels in the hierarchy are separated by "| ". They could be used directly by a <i>Hierarchy</i> classifier without the use of the hierarchy file. However, then the entries would be ordered alphabetically, not in the special order defined by the file.</p> 56 56 57 57 description21=<p>The <tt>dls.AZList.txt</tt> hierarchy file used by the titles classifier contains a similar structure. Ordinarily, a titles browser would use a <i>List</i> (or <i>AZList</i>) classifier. In this case, we want to predefine the A-Z groupings, and include a separate entry for periodicals, as can be seen in classifier browser <tt>CL2.7</tt>.</p> -
documented-examples/trunk/garish-e/resources/collectionConfig.properties
r36376 r36404 14 14 15 15 description2=<h3>How the collection works</h3><p>The <b>global</b> format statement contains a link to the collection's custom stylesheet, which is located inside the collection:</p><pre>\ 16 <xsl:template name= "additionalHeaderContent"> \n\17 <xsl:variable name= "httpCollection"> \n\18 <xsl:value-of select= "/page/pageResponse/collection/metadataList/metadata[@name='httpPath']"/> \n\16 <xsl:template name="additionalHeaderContent"> \n\ 17 <xsl:variable name="httpCollection"> \n\ 18 <xsl:value-of select="/page/pageResponse/collection/metadataList/metadata[@name='httpPath']"/> \n\ 19 19 </xsl:variable> \n\ 20 <link href= "{$httpCollection}/style/style.css" rel="stylesheet" type="text/css"/> \n\20 <link href="{$httpCollection}/style/style.css" rel="stylesheet" type="text/css"/> \n\ 21 21 </xsl:template> \n\ 22 22 </pre> -
documented-examples/trunk/gsarch-e/resources/collectionConfig.properties
r36387 r36404 14 14 description2=<p>The collection configuration file, <tt>etc/collectionConfig.xml</tt>, begins with the specification <i>groupsize 200</i>. This groups documents together into groups of 200. Email collections typically have many small documents, and grouping them together prevents Greenstone's internal file structures from becoming bloated and occupying more disk space than necessary. Notice that the <i>Email</i> plugin first splits the input files up into individual Emails, then <i>groupsize</i> groups them together again. This allows the collection designer to control what is going on.</p> 15 15 16 description3=<p>The <i>indexes</i> line specifies 3 searchable indexes, which can be seen by clicking beside the word "Messages"on the <tt>search page</tt> to reveal a drop-down menu. The first (called <i>Messages</i>) is created from the document text, while the others are formed from <i>From</i> and <i>Subject</i> metadata.</p>16 description3=<p>The <i>indexes</i> line specifies 3 searchable indexes, which can be seen by clicking beside the word "Messages" on the <tt>search page</tt> to reveal a drop-down menu. The first (called <i>Messages</i>) is created from the document text, while the others are formed from <i>From</i> and <i>Subject</i> metadata.</p> 17 17 18 description4=<p>There are three classifiers, based on <i>Subject</i>, <i>FromName</i>, and <i>Date</i> metadata. The <i>AZCompactList</i> classifier used for the first two is like <i>AZList</i> but generates a bookshelf for duplicate items, as illustrated <tt>with classifier browser CL1</tt>. This is represented by a tree structure whose nodes are either leaf nodes, representing documents, or internal nodes. A metadata item called numleafdocs gives the total number of documents below an internal node. The format statement for the first classifier, called <i>CL1Vlist</i>, checks whether this item exists. If so the node must be an internal one, in which case it is labeled by its <i>Title</i>. Otherwise the node's label starts with the <i>Subject</i> which links to the document, then gives <i>FromName</i> metadata, with a link to "Search by Sender", followed by the <i>DateText</i>.</p>18 description4=<p>There are three classifiers, based on <i>Subject</i>, <i>FromName</i>, and <i>Date</i> metadata. The <i>AZCompactList</i> classifier used for the first two is like <i>AZList</i> but generates a bookshelf for duplicate items, as illustrated <tt>with classifier browser CL1</tt>. This is represented by a tree structure whose nodes are either leaf nodes, representing documents, or internal nodes. A metadata item called numleafdocs gives the total number of documents below an internal node. The format statement for the first classifier, called <i>CL1Vlist</i>, checks whether this item exists. If so the node must be an internal one, in which case it is labeled by its <i>Title</i>. Otherwise the node's label starts with the <i>Subject</i> which links to the document, then gives <i>FromName</i> metadata, with a link to "Search by Sender", followed by the <i>DateText</i>.</p> 19 19 20 description5=<p>The second classifier (<i>CL2Vlist</i>) is similar, but shows slightly different information -- the result can be seen <tt>with classifier browser CL2</tt>. For internal nodes, the actual number of leaf documents (<i>numleafdocs</i>) is given in parentheses after the <i>Title</i>. For document nodes the <i>FromName</i>, with a link to "Search By Sender", <i>Subject</i> (linked to the document), and <i>DateText</i> metadata is shown.</p>20 description5=<p>The second classifier (<i>CL2Vlist</i>) is similar, but shows slightly different information -- the result can be seen <tt>with classifier browser CL2</tt>. For internal nodes, the actual number of leaf documents (<i>numleafdocs</i>) is given in parentheses after the <i>Title</i>. For document nodes the <i>FromName</i>, with a link to "Search By Sender", <i>Subject</i> (linked to the document), and <i>DateText</i> metadata is shown.</p> 21 21 22 22 description6=<p>The third classifier is a <i>DateList</i>, which allows selection by month and year.</p> 23 23 24 description7=<p>Finally, the document text is formatted to show the header fields (<i>FromName</i>, <i>DateText</i>, <i>Subject</i>, <i>InReplyTo</i>), followed by the message text (written as <i>lt;gsf:metadata name= "rawtext"/></i> in the format statement). <i>FromName</i> is linked to a search on that name, while <i>InReplyTo</i> links to the email message that it refers to.</p>24 description7=<p>Finally, the document text is formatted to show the header fields (<i>FromName</i>, <i>DateText</i>, <i>Subject</i>, <i>InReplyTo</i>), followed by the message text (written as <i>lt;gsf:metadata name="rawtext"/></i> in the format statement). <i>FromName</i> is linked to a search on that name, while <i>InReplyTo</i> links to the email message that it refers to.</p> -
documented-examples/trunk/lomdemo-e/resources/collectionConfig.properties
r36397 r36404 12 12 description1=<p>Traditional educational learning object repositories base searching and browsing around the provided metadata. This demonstration collection goes one step further and provides <i>full-text</i> indexing of the on-line resources, where possible.</p> 13 13 14 description2=<p>Browse around the collection's items ordered by subject then title, or view the items chronologically. Alternatively search the text or titles of the items in the collection, optionally restricted to arts or science. When you view an item from the collection various views of it are available. You start by viewing its Learning Object Metadata (LOM) record in a tabulated form and divided into sections: these sections can be expanded or contracted to reveal more or less information as desired. Use the tabs at the top of the table to change the view of the learning object. There will always be a tab for "XML Record"which displays the metadata in its original IEEE LOM format. Depending on whether or not the learning object references an on-line resource that is available for indexing, a third tab may be present that displays the source document.</p>14 description2=<p>Browse around the collection's items ordered by subject then title, or view the items chronologically. Alternatively search the text or titles of the items in the collection, optionally restricted to arts or science. When you view an item from the collection various views of it are available. You start by viewing its Learning Object Metadata (LOM) record in a tabulated form and divided into sections: these sections can be expanded or contracted to reveal more or less information as desired. Use the tabs at the top of the table to change the view of the learning object. There will always be a tab for "XML Record" which displays the metadata in its original IEEE LOM format. Depending on whether or not the learning object references an on-line resource that is available for indexing, a third tab may be present that displays the source document.</p> 15 15 16 16 description3=<h3>How the collection works</h3><p>The records were exported from the Calgary Repository in LOM format. LOMPlugin is used to process the records. Using the <tt>-download_srcdocs</tt> option to the plugin will search for <tt>general^identifier^entry</tt> or <tt>technical^location</tt>, and attempt to download the source document into a <i>_gsdldown.all</i> folder (<tt>import/arts/_gsdldown.all</tt>) in the same folder as the LOM record.</p> … … 18 18 description4=<p>In porting the lomdemo-e collection from Greenstone 2 (GS2) to Greenstone 3, the predefined GS2 macros of <i>_httpopenmdicon_</i> and <i>httpclosemdicon_</i>, used to show and hide sections of the tabular display of LOM metadata, needed to be defined in <tt>siteConfig.xml</tt> by inserting the following 2 lines into the file: \n\ 19 19 <pre> \n\ 20 <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\20 <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\ 21 21 \n\ 22 <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"/>22 <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"/> 23 23 </pre> \n\ 24 24 </p> -
documented-examples/trunk/marc-e/resources/collectionConfig.properties
r36394 r36404 10 10 description2=<p>The <i>VList</i> format statement controls the display of search results and all classifiers. For bookshelves, the number of leaf documents is displayed on the right-hand side. For documents, <i>dc.Title</i> is displayed, along with <i>dc.Creator</i> and <i>dc.Publisher</i>. <i>[sibling:dc.Creator]</i> is used as dc.Creator has multiple values, and specifies that all values be output, not just the first one.</p> 11 11 12 description3=<p>The MARC plugin uses a special file to map MARC field numbers to Greenstone-style metadata. This file resides in the <i>greenstone/etc</i> directory, and is called <tt>marc2dc.txt</tt>. It lists the correspondences between MARC field numbers and Greenstone metadata. Any MARC fields that are not listed simply do not appear as metadata, though they are still present in the Greenstone document. Each line in the file has the format <blockquote> <MARC field number> -> GreenstoneMetadataName </blockquote> Lines in the file that begin with "\#"are comments.</p>12 description3=<p>The MARC plugin uses a special file to map MARC field numbers to Greenstone-style metadata. This file resides in the <i>greenstone/etc</i> directory, and is called <tt>marc2dc.txt</tt>. It lists the correspondences between MARC field numbers and Greenstone metadata. Any MARC fields that are not listed simply do not appear as metadata, though they are still present in the Greenstone document. Each line in the file has the format <blockquote> <MARC field number> -> GreenstoneMetadataName </blockquote> Lines in the file that begin with "\#" are comments.</p> 13 13 14 14 description4=<p>The standard version of this file is loosely based on the MARC to Dublin Core mapping found at <a href="http://www.loc.gov/marc/marc2dc.html">http://www.loc.gov/marc/marc2dc.html</a> (which assumes USMARC/MARC21).</p> 15 15 16 description5=<p>Multiple MARC fields may map to a single Dublin Core field. For example, fields 720 ( "Uncontrolled name"), 100 ("Personal name"), 110 ("Corporate name") and 111 ("Meeting name") all map to <i>dc.Creator</i>. Actual MARC records normally define only one of these fields, and anyway Greenstone allows multi-valued metadata.</p>16 description5=<p>Multiple MARC fields may map to a single Dublin Core field. For example, fields 720 ("Uncontrolled name"), 100 ("Personal name"), 110 ("Corporate name") and 111 ("Meeting name") all map to <i>dc.Creator</i>. Actual MARC records normally define only one of these fields, and anyway Greenstone allows multi-valued metadata.</p> 17 17 18 description6=<p>Some mappings are dependent on subfields. For example, MARC field 260 contains information about publication and distribution. Subfields "c" (Date of Publication) and "g" (Date of manufacture) are mapped to <i>dc.Date</i>, using the following mapping line: <blockquote> 260$c$g -> dc.Date </blockquote> Greenstone also provides a file for mapping MARC to <b>qualified</b> dublin core: <tt>greenstone/etc/marc2qdc.txt</tt>. This can be used by the MARC plugin by setting the <i>-metadata_mapping_file</i> option to "marc2qdc.txt".</p>18 description6=<p>Some mappings are dependent on subfields. For example, MARC field 260 contains information about publication and distribution. Subfields "c" (Date of Publication) and "g" (Date of manufacture) are mapped to <i>dc.Date</i>, using the following mapping line: <blockquote> 260$c$g -> dc.Date </blockquote> Greenstone also provides a file for mapping MARC to <b>qualified</b> dublin core: <tt>greenstone/etc/marc2qdc.txt</tt>. This can be used by the MARC plugin by setting the <i>-metadata_mapping_file</i> option to "marc2qdc.txt".</p> -
documented-examples/trunk/oai-e/resources/collectionConfig.properties
r36395 r36404 25 25 description6=<p>The collection configuration file, <tt>collectionConfig.xml</tt>, specifies a single full-text index containing <i>dc.Description</i> metadata and overrides Greenstone\'s custom <i>gsf</i> format templates <tt>DocumentHeading</tt> and <tt>DocumentContent</tt> (XSL). When a document is displayed, the <i>DocumentHeading</i> format statement puts out its <i>dc.Subject</i>. Then the <i>DocumentContent</i> statement follows this with <i>screenicon</i>, which is produced by <i>ImagePlugin</i> and gives a screen-resolution version of the image; it can be hyperlinked to the <i>dc.OrigURL</i> metadata -- that is, the original version of the image on the remote OAI site. Since this is no longer available on the web, it is now hyperlinked to the full version of the image file. This is followed by the image\'s <i>dc.Description</i>, also with a hyperlink; the image\'s size and type, again generated as metadata by <i>ImagePlugin</i>; and then <i>dc.Subject</i>, <i>dc.Publisher</i>, and <i>dc.Rights</i> metadata. <a href="_sampleoid_">This</a> is the result.</p> 26 26 27 description7=<p>There are two browsing classifiers, one based on <i>dc.Subject</i> metadata and the other on <i>dc.Description</i> metadata (but with a button named "captions"). Recall that the <i>AZCompactList</i> classifier is like <i>AZList</i> but generates a bookshelf for duplicate items. In this collection there are a lot of images but only a few different values for <i>dc.Subject</i> metadata.</p>27 description7=<p>There are two browsing classifiers, one based on <i>dc.Subject</i> metadata and the other on <i>dc.Description</i> metadata (but with a button named "captions"). Recall that the <i>AZCompactList</i> classifier is like <i>AZList</i> but generates a bookshelf for duplicate items. In this collection there are a lot of images but only a few different values for <i>dc.Subject</i> metadata.</p> 28 28 29 29 description8=<p>It\'s a little surprising that <i>AZCompactList</i> is used (instead of <i>AZList</i>) for the <i>dc.Description</i> index too, because <i>dc.Description</i> metadata is usually unique for each image. However, in this collection the same description has occasionally been given to several images, and some of the divisions in an <i>AZList</i> would contain a large number of images, slowing down transmission of that page. To avoid this, the compact version of the list is used with some arguments (<i>mincompact</i>, <i>maxcompact</i>, <i>mingroup</i>, <i>minnesting</i>) to control the display -- e.g. groups (represented by bookshelves) are not formed unless they have at least 5 (<i>mingroup</i>) items. To find out the meaning of the other arguments for this classifier, execute the command <i>classinfo.pl AZCompactList</i>. The programs <i>classinfo.pl</i> (for classifiers) and <i>pluginfo.pl</i> (for plugins) are useful tools for learning about the capabilities of Greenstone modules. Note incidentally the backslash in the configuration file, used to indicate a continuation of the previous line.</p> … … 31 31 description9=<p>The <i>VList</i> format specification shows the image thumbnail, hyperlinked to the associated document, followed by <i>dc.Description</i> metadata; the result can be seen in the <tt>CL2</tt> classifier browser. The <i>Vlists</i> for the classifiers use <i>numleafdocs</i> to switch between an icon representing several documents (which will appear as a bookshelf) and the thumbnail itself, if there is only one image.</p> 32 32 33 description10=<h3>The Greenstone OAI server</h3><p>Greenstone comes with a built-in OAI data provider. This runs as a CGI program called "oaiserver.cgi", and is installed in the Greenstone <i>cgi-bin</i> directory. It can be accessed via the same URL as the Greenstone library (replacing "library.cgi" with "oaiserver.cgi"). If you are using the Windows local library server, you must install a web server (such as Apache) to run the OAI server.</p>33 description10=<h3>The Greenstone OAI server</h3><p>Greenstone comes with a built-in OAI data provider. This runs as a CGI program called "oaiserver.cgi", and is installed in the Greenstone <i>cgi-bin</i> directory. It can be accessed via the same URL as the Greenstone library (replacing "library.cgi" with "oaiserver.cgi"). If you are using the Windows local library server, you must install a web server (such as Apache) to run the OAI server.</p> 34 34 35 35 description11=<p>Configuration of the server is done via the <i>oai.cfg</i> file in the Greenstone <i>etc</i> directory. This file specifies general information about the repository, and lists collections to be made accessible to OAI clients. By default, collections are not accessible. To enable a collection, add its name to the <i>oaicollection</i> list.</p> -
documented-examples/trunk/style-e/resources/collectionConfig.properties
r36392 r36404 17 17 description2=<p>In this case, the <b>additionalHeaderContent</b> specifies the custom collection stylesheet currently active and the JavaScript to facilitate the stylesheet switching when a link is clicked. The <b>create-banner</b> XSL template in the <i>global</i> format statement is also overridden to provide links to the multiple stylesheets within the existing GS3 banner section, and invoke the custom JavaScript when any link is clicked. \n\ 18 18 <pre> \n\ 19 <xsl\:template name= "additionalHeaderContent"> \n\20 <xsl\:variable name= "httpCollection"> \n\21 <xsl\:value-of select= "/page/pageResponse/collection/metadataList/metadata[@name='httpPath']"/> \n\19 <xsl\:template name="additionalHeaderContent"> \n\ 20 <xsl\:variable name="httpCollection"> \n\ 21 <xsl\:value-of select="/page/pageResponse/collection/metadataList/metadata[@name='httpPath']"/> \n\ 22 22 </xsl\:variable> \n\ 23 <link rel= "stylesheet" href="{$httpCollection}/style/gs3-style-default-extra.css" type="text/css"\n\24 title= "GS3 Style" id="custom-style" charset="UTF-8"/> \n\23 <link rel="stylesheet" href="{$httpCollection}/style/gs3-style-default-extra.css" type="text/css" \n\ 24 title="GS3 Style" id="custom-style" charset="UTF-8"/> \n\ 25 25 \n\ 26 <script src= "{$httpCollection}/script/custom-script.js" type="text/javascript"> \n\26 <script src="{$httpCollection}/script/custom-script.js" type="text/javascript"> \n\ 27 27 </script> \n\ 28 28 \n\ … … 30 30 \n\ 31 31 \n\ 32 <xsl\:template name= "create-banner"> \n\32 <xsl\:template name="create-banner"> \n\ 33 33 \n\ 34 <div class= "choose_style"> \n\34 <div class="choose_style"> \n\ 35 35 Choose a style\: \n\ 36 <a href= "#" onclick="replaceStyle('gs3-style-default-extra');return false;">Default Greenstone</a>, \n\37 <a href= "#" onclick="replaceStyle('gs3-style-blue');return false;">Blue</a>, \n\38 <a href= "#" onclick="replaceStyle('gs3-style-olive-purple');return false;">OlivePurple</a>, \n\39 <a href= "#" onclick="replaceStyle('');return false;">None</a> \n\36 <a href="#" onclick="replaceStyle('gs3-style-default-extra');return false;">Default Greenstone</a>, \n\ 37 <a href="#" onclick="replaceStyle('gs3-style-blue');return false;">Blue</a>, \n\ 38 <a href="#" onclick="replaceStyle('gs3-style-olive-purple');return false;">OlivePurple</a>, \n\ 39 <a href="#" onclick="replaceStyle('');return false;">None</a> \n\ 40 40 </div> \n\ 41 41 \n\ 42 <div id= "gs_banner" class="ui-widget-header ui-corner-bottom"> \n\43 <div id= "titlesearchcontainer"> \n\42 <div id="gs_banner" class="ui-widget-header ui-corner-bottom"> \n\ 43 <div id="titlesearchcontainer"> \n\ 44 44 \n\ 45 <xsl\:call-template name= "page-title-area"/> \n\46 <xsl\:call-template name= "quick-search-area"/> \n\47 <div style= "clear\:both;"><xsl\:text> </xsl\:text></div> \n\45 <xsl\:call-template name="page-title-area"/> \n\ 46 <xsl\:call-template name="quick-search-area"/> \n\ 47 <div style="clear\:both;"><xsl\:text> </xsl\:text></div> \n\ 48 48 </div> \n\ 49 <xsl\:call-template name= "browsing-tabs"/> \n\49 <xsl\:call-template name="browsing-tabs"/> \n\ 50 50 </div> \n\ 51 51 </xsl\:template> \n\ … … 66 66 <li>To use a stylesheet as the default, place it in greenstone/web/interfaces/default/style and rename it to <pre>style.css</pre>. This will affect all collections.</li> \n\ 67 67 <li>To use a stylesheet for a particular collection, place it in greenstone/web/sites/localsite/collect/<collection>/style then specify the stylesheet link in the <b>additionalHeaderContent</b> of GLI's <i>global</i> format statement (<pre>Format > Format Features > global</pre>) as follows: \n\ 68 <pre><xsl\:template name= "additionalHeaderContent"> \n\69 <xsl\:variable name= "httpCollection"> \n\70 <xsl\:value-of select= "/page/pageResponse/collection/metadataList/metadata[@name='httpPath']"/> \n\68 <pre><xsl\:template name="additionalHeaderContent"> \n\ 69 <xsl\:variable name="httpCollection"> \n\ 70 <xsl\:value-of select="/page/pageResponse/collection/metadataList/metadata[@name='httpPath']"/> \n\ 71 71 </xsl\:variable> \n\ 72 <link href= "{$httpCollection}/style/stylesheet-name.css" rel="stylesheet" type="text/css"/> \n\72 <link href="{$httpCollection}/style/stylesheet-name.css" rel="stylesheet" type="text/css"/> \n\ 73 73 </xsl\:template></pre> \n\ 74 74 </li> \n\ -
documented-examples/trunk/wrdpdf-e/resources/collectionConfig.properties
r36399 r36404 21 21 <pre> \n\ 22 22 <format> \n\ 23 <gsf:template match= "documentNode"> \n\24 <gsf:format-gs2><![CDATA[<td valign= "top">[link][icon][/link]</td> \n\25 <td valign= "top">[ex.srclink]{Or}{[ex.thumbicon],[ex.srcicon]}[ex./srclink]</td> \n\26 <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\27 <td valign= "top"> \n\28 <gsf:link type= "document"> \n\29 <gsf:icon type= "document"/> \n\23 <gsf:template match="documentNode"> \n\ 24 <gsf:format-gs2><![CDATA[<td valign="top">[link][icon][/link]</td> \n\ 25 <td valign="top">[ex.srclink]{Or}{[ex.thumbicon],[ex.srcicon]}[ex./srclink]</td> \n\ 26 <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\ 27 <td valign="top"> \n\ 28 <gsf:link type="document"> \n\ 29 <gsf:icon type="document"/> \n\ 30 30 </gsf:link> \n\ 31 31 </td> \n\ 32 <td valign= "top"> \n\33 <gsf:link type= "source"> \n\32 <td valign="top"> \n\ 33 <gsf:link type="source"> \n\ 34 34 <gsf:choose-metadata> \n\ 35 <gsf:metadata name= "thumbicon"/> \n\36 <gsf:metadata name= "srcicon"/> \n\35 <gsf:metadata name="thumbicon"/> \n\ 36 <gsf:metadata name="srcicon"/> \n\ 37 37 </gsf:choose-metadata> \n\ 38 38 </gsf:link> \n\ 39 39 </td> \n\ 40 <td valign= "top"> \n\41 <span class= "highlight"> \n\42 <gsf:choose-metadata><gsf:metadata name= "dc.Title"/><gsf:metadata name="exp.Title"/><gsf:metadata name="Title"/>Untitled</gsf:choose-metadata> \n\40 <td valign="top"> \n\ 41 <span class="highlight"> \n\ 42 <gsf:choose-metadata><gsf:metadata name="dc.Title"/><gsf:metadata name="exp.Title"/><gsf:metadata name="Title"/>Untitled</gsf:choose-metadata> \n\ 43 43 </span> \n\ 44 44 <gsf:switch> \n\ 45 <gsf:metadata name= "Source"/> \n\46 <gsf:when test= "exists"> \n\45 <gsf:metadata name="Source"/> \n\ 46 <gsf:when test="exists"> \n\ 47 47 <br/> \n\ 48 <i>(<gsf:metadata name= "Source"/>)</i> \n\48 <i>(<gsf:metadata name="Source"/>)</i> \n\ 49 49 </gsf:when> \n\ 50 50 </gsf:switch> \n\
Note:
See TracChangeset
for help on using the changeset viewer.
