source: documented-examples/trunk/bibtex-e/resources/collectionConfig.properties@ 36558

name=Bibliography collection

ShowBibTeXrecord=Show BibTeX Record
HideBibTeXrecord=Hide BibTeX Record
Number=Number
AuthoredBy=Authored By
PaperTitle=Paper Title
DocType=DocType
BookJournalTitle=Book/Journal Title
BibTeXrecord=BibTeX Record
PublicationDate=Publication Date
Editors=Editor(s)
PublicationPlace=Publication Place
Annotations=Annotations
Abstract=Abstract
Pages=Pages
Keywords=Keywords
In=In
EditorRole=Editor Role
Vol=Vol.
MeetingPlace=Meeting Place
Publisher=Publisher
LocationURL=Location/URL
MeetingDate=Meeting Date

source_text=filenames
text_text=full records
Title_text=titles
sampleoid_text=13/2004

shortDescription=<p>This collection, which contains 135 BibTeX entries, is a collection of working papers published from 1997 to 2006 at <a href="http\://www.cs.waikato.ac.nz/">Department of Computer Science</a>, <a href="http\://www.waikato.ac.nz/">the University of Waikato</a>.</p>

description1=<h3>How the collection works</h3><p>The collection configuration file (the collection\'s <tt>etc/collectionConfig.xml</tt>) begins with the specification <i>groupsize 200</i>. This groups 200 documents together into a single archive file. Bibliography collections typically have many small documents, and grouping them together prevents Greenstone\'s internal file structures from becoming bloated and occupying more disk space than necessary.</p>

description2=<p>Apart from the standard plugins, this collection uses <i>BibTexPlugin</i>, which processes references in the BibTeX format (well known to computer scientists). Two options have been set for BibTexPlugin\: <i>-OIDtype assigned -OIDmetadata Number</i>. This means the metadata element "Number" will be used as the record identifier, instead of Greenstone\'s default hash identifiers. These options are available for all plugins.</p>

description3=<p>Fielded searching, with a form-based interface, is selected by <i>format SearchTypes "form,plain" </i> in the configuration file. In fact, a plain textual full-text search index is included in this collection as well (since <i>form</i> comes first, it is the default interface; you reach the <i>plain</i> search through the <i>Preferences</i> page).</p>

description4=<p>The <i>buildtype</i> option shows that the default search engine <i>mgpp</i> is used. The <i>indexes</i> line specifies indexes for "text", and "metadata". In this case, "text" will be the original BibTeX record. "metadata" is a special keyword signifying that an index should be built for any metadata item found in the collection. Thus when the "field" menus in the collection\'s <a href="library/collection/bibtex-e/search/FieldQuery">search page</a> are pulled down, they show <i>full records</i> followed by an entry for each metadata element. In the collection\'s <tt>resources/collectionConfig.properties</tt> file, collection-level metadata <i>collectionmeta</i> can be specified for any index to determine what it is called (except for <i>metadata</i>, which produces many menu items). In this case, the <i>collectionConfig.properties</i> file specifies that the <i>text</i> index (referred to by collection\'s configuration file, <tt>collectionConfig.xml</tt>) should be named "full records" because it contains the original bibliographic record.</p>

description5=<p>An additional keyword, "allfields", could also be used in the <i>indexes</i> line, specifying that combined searching over all indexes should be available.</p>

description6=<p>The <i>levels</i> lines specifies only document level, as bibliographic records don\'t have internal structure.</p>

description7=<p>This collection contains <i>Title, Author</i>, and <i>Date</i> browsers. The <i>AZCompactList</i> classifier used for the <i>Author</i> browser is like <i>AZList</i> but generates a bookshelf for duplicate items. The BibTeX plugin records each author as <i>Author</i> metadata; it also puts a list containing all authors into the <i>Creator</i> metadata element. Consequently the <i>AZCompactList</i> classifier is based on <i>Author</i>. However, Greenstone has a standard button reading <i>authors</i> whose name is (confusingly) "Creator", so this button name is specified for the classifier.</p>

description8=<p>The format statements for the search results list and the title browser are both determined by the <i>VList</i> specification. It gives a document icon that links to the document itself (which in this collection is the full reference); the title in bold; <i>Creator</i> metadata if there is any, otherwise <i>Editor</i> metadata; and <i>Month, Year</i> metadata if there is any. <a href="library/collection/bibtex-e/search/FieldQuery?a=q&sa=&rt=rd&s1.level=Doc&s1.case=1&s1.stem=0&s1.matchMode=some&s1.sortBy=1&s1.maxDocs=50&s1.fqv=Jain&s1.fqf=TX&s1.fqv=&s1.fqf=NU&s1.fqv=&s1.fqf=NU&s1.fqv=&s1.fqf=NU&s1.hitsPerPage=20">Here</a> is an example.</p>

description9=<p>The format statement for the author browser (<i>CL2VList</i>) is more complex. The <i>AZCompactList</i> classifier generates a tree whose nodes are either leaf nodes, representing documents, or internal nodes. A metadata item called <i>numleafdocs</i> gives the total number of documents below an internal node. This format statement checks whether numleafdocs exists. If so the node must be an internal node, in which case the node is labeled by its <i>Title</i>. But beware\: this classifier is generated on <i>Author</i> metadata, so its title -- the title of the classifier -- is actually the author\'s name! This means that the bookshelf nodes <a href="library/collection/bibtex-e/browse/CL2">here</a> are labeled by author\'s name. The leaf nodes, however, are labeled the same way as documents (i.e. references) are in the search results list.</p>

description10=<p>The documents themselves (here is an <a href="library/collection/bibtex-e/document/98_9">example</a>) are generated by two format statements, one (a long one) called <i>DocumentHeading</i>, and another called <i>DocumentContent</i>. The <i>DocumentHeading</i>, which is the top two-thirds of the page, contains the document\'s <i>Title</i> followed by a table that gives all the metadata elements that the BibTeX plugin can generate. The role of all the <i>gsf\:switch</i> statements in the collection cofiguration file, <tt>collectionConfig.xml</tt>, is to determine which elements are defined.</p>

description11=<p>The <i>DocumentContent</i> has been overridden. When the document is displayed initially, only a hyperlink reading <i>Show/Hide BibTex Record</i> appears -- clicking this invokes JavaScript to toggle the display of the raw BibTex record (showing the BibText version of the reference), which is hidden by default.</p>