Ignore:
Timestamp:
2005-11-07T17:02:29+13:00 (18 years ago)
Author:
kjdon
Message:

small changes

Location:
trunk/gsdl3/docs/manual
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/gsdl3/docs/manual/manual.tex

    r10826 r10863  
    209209\bf name & \bf sample value & \bf description \\
    210210\hline
    211 gsdl3\_home & /research/kjdon/greenstone3 & the base directory of the greenstone3 installation \\
    212211site\_name & localsite & the name of the site to use \\
    213212interface\_name & default & the name of the interface to use\\
    … …  
    515514\begin{figure}
    516515\begin{gsc}\begin{verbatim}
    517 <collectionConfig xmlns:gsf="http://www.greenstone.org/configformat"
    518   xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
     516<collectionConfig xmlns:gsf="http://www.greenstone.org/greenstone3/
     517  schema/ConfigFormat" xmlns:xslt="http://www.w3.org/1999/XSL/Transform">
    519518  <metadataList>
    520519    <metadata name="creator">[email protected]</metadata>
    521520  </metadataList>
    522521  <displayItemList>
    523     <displayItem name="name" lang="en">Greenstone 3 demo</displayItem>
    524     <displayItem name="icon" lang="en">gs3demo.gif</displayItem>
    525     <displayItem name="smallicon" lang="en">gs3demosm.gif</displayItem>
    526     <displayItem name="description" lang="fr">Il s'agit d'une collection
    527       de démonstration pour le logiciel Greenstone. Elle contient
    528       seulement un petit échantillon des Bibliothèques humanitaires
    529       pour le Développement (11 documents).</displayItem>
    530     <displayItem name="description" lang="en">This is a demonstration
    531       collection for the Greenstone digital library software. It contains
    532       a small subset (11 books) of the Humanity Development Library. It
    533       is built with mg using Greenstone 3 native building.</displayItem>
     522    <displayItem name='name' lang='en'>Greenstone3 MG demo collection</displayItem>
     523    <displayItem name='description' lang='en'>This is a demonstration
     524      collection for the Greenstone3 digital library software.</displayItem>
     525    <displayItem name='icon' lang='en'>gs3mgdemo.gif</displayItem>
     526    <displayItem name='smallicon' lang='en'>gs3mgdemo_sm.gif</displayItem>
    534527  </displayItemList>
    535   <search type='mg'>
    536     <index name="i1">
    537       <field>text</field>
    538       <level>document</level>
    539       <displayItem name='name' lang="en">entire documents</displayItem>
    540       <displayItem name='name' lang="fr">documents entiers</displayItem>
    541       <displayItem name='name' lang="es">documentos enteros</displayItem>
    542     </index>
    543     <index name="i2">
     528  <recognise>
     529      <docType name="HTML"/><docType name="Text"/>
     530      <docType name="Metadata"/><docType name="JPEG"/>
     531  </recognise>         
     532  <search type="mg" name="mgsearch">
     533    <index name="sectext">
    544534      <field>text</field>
    545535      <level>section</level>
    546536      <displayItem name='name' lang="en">chapters</displayItem>
    547537      <displayItem name='name' lang="fr">chapitres</displayItem>
    548       <displayItem name='name' lang="es">capítulos</displayItem>
     538      <displayItem name='name' lang="es">capítulos</displayItem>
    549539    </index>
     540    [ ... more indexes ...]
    550541    <format>
    551       <gsf:template match="documentNode">
    552         <td valign='top'><gsf:link><gsf:icon/></gsf:link></td>
    553         <td><gsf:metadata name='Title' /></td>
    554       </gsf:template>
     542      <gsf:template match="documentNode"><td valign='top'>
     543       <gsf:link><gsf:icon/></gsf:link></td><td><gsf:metadata name='Title'/>
     544      </td></gsf:template>
    555545    </format>
    556546  </search>
    557547  <browse>
    558     <classifier name="CL1" type="AZList" horizontalAtTop='true'>
     548    <classifier name="CLTit" type="AZList" horizontalAtTop='true'>
    559549      <field>Title</field>
    560550      <sort>Title</sort>
    561551      <displayItem name='name' lang='en'>Titles</displayItem>
    562552    </classifier>
    563     <classifier name="CL2" type="Hierarchy">
    564       <field>Organization</field>
    565       <sort>Title</sort>
    566       <displayItem name='name' lang='en'>Organizations</displayItem>
    567       <file URL="/research/kjdon/home/greenstone3/web/sites/localsite/collect/
    568          gs3test/etc/org.xml"/>
    569     </classifier>
     553    [... more classifiers ...]
    570554    <classifier name="CLKeyword" type="Hierarchy">
    571555      <field>Keyword</field>
    572556      <sort>Title</sort>
    573557      <displayItem name='name' lang='en'>HowTo</displayItem>
    574       <file URL="/research/kjdon/home/greenstone3/web/sites/localsite/collect/
    575          gs3test/etc/keyword.xml"/>
     558      <file URL="keyword.xml"/>
    576559      <format>
    577560        <gsf:template match="documentNode">
    … …  
    581564    </classifier>
    582565  </browse>
    583   <display/>   
     566  <display>
     567    <format>
     568      <gsf:option name="coverImages" value="false"/>
     569      <!--<gsf:option name="documentTOC" value="false"/>-->
     570    </format>
     571  </display>
    584572</collectionConfig>
    585573\end{verbatim}\end{gsc}
    586 [TODO: add in building instructions for the classifiers]
    587 \caption{Sample collectionConfig.xml file (gs3demo collection)}
     574\caption{Sample collectionConfig.xml file (gs3mgdemo collection)}
    588575\label{fig:collconfig}
    589576\end{figure}
    … …  
    688675The file \gst{buildConfig.xml} is produced by the collection building process. Generally it is not necessary to look at this file, but it can be useful in determining what went wrong if the collection doesn't appear quite the way it was planned.
    689676
    690 It contains  metadata and other information about the collection that can
    691 be determined automatically,  such as the number of
     677It contains metadata and other information about the collection that can
     678be determined automatically, such as the number of
    692679documents it contains.  It also includes a list of ServiceRack classes that are
    693680required to provide the services that have been built into the
    694681collection.  The serviceRack names are Java classes that are loaded
    695682dynamically at runtime. Any information inside the serviceRack element is
    696 specific to that service---there is no set format. Figure~\ref{fig:buildconfig} shows an example. This configuration file specifies that the collection should load up 3 ServiceRacks: \gst{GS2MGPPRetrieve},  \gst{GS2MGPPSearch}, and \gst{PhindPhraseBrowse}. The contents of each \gst{<serviceRack>} element are passed to the appropriate ServiceRack objects for configuration. The \gst{collectionConfig.xml} file content is also passed to the ServiceRack objects at configure time---the \gst{format} and \gst{displayItem} information is used directly from the \gst{collectionConfig.xml} file rather than added into \gst{buildConfig.xml} during building. This enables formatting and metadata changes in \gst{collectionConfig.xml} to take effect in the collection without rebuilding being necessary. However, as these files are cached, the collection needs to be reloaded for the changes to appear in the library.
     683specific to that service---there is no set format. Figure~\ref{fig:buildconfig} shows an example. This configuration file specifies that the collection should load up 3 ServiceRacks: \gst{GS2Browse}, \gst{GS2MGPPRetrieve} and \gst{GS2MGPPSearch}. The contents of each \gst{<serviceRack>} element are passed to the appropriate ServiceRack objects for configuration. The \gst{collectionConfig.xml} file content is also passed to the ServiceRack objects at configure time---the \gst{format} and \gst{displayItem} information is used directly from the \gst{collectionConfig.xml} file rather than added into \gst{buildConfig.xml} during building. This enables formatting and metadata changes in \gst{collectionConfig.xml} to take effect in the collection without rebuilding being necessary. However, as these files are cached, the collection needs to be reloaded for the changes to appear in the library.
    697684
    698685
    699686\begin{figure}
    700687\begin{gsc}\begin{verbatim}
    701 <buildConfig xmlns:gsf="http://www.greenstone.org/configformat">
     688<buildConfig>
    702689  <metadataList>
    703690    <metadata name="numDocs">11</metadata>
     691    <metadata name="buildType">mgpp</metadata>
    704692  </metadataList>
    705693  <serviceRackList>
     694    <serviceRack name="GS2Browse">
     695      <classifierList>
     696        <classifier name="CL1" content="Title"/>
     697        <classifier name="CL2" content="Subject" />
     698        <classifier name="CL3" content="Organization" />
     699        <classifier name="CL4" content="Howto" />
     700      </classifierList>
     701    </serviceRack>
    706702    <serviceRack name="GS2MGPPRetrieve">
    707703      <defaultLevel name="Sec" />
    708       <classifierList>
    709     <classifier name="CL1" content="Subject" />
    710     <classifier name="CL2" content="Title" horizontalAtTop="true" />
    711     <classifier name="CL3" content="Organization" />
    712     <classifier name="CL4" content="Keyword" />
    713       </classifierList>
    714704    </serviceRack>
    715     <serviceRack name="PhindPhraseBrowse" />
    716705    <serviceRack name="GS2MGPPSearch">
    717706      <defaultLevel name="Sec" />
    718707      <levelList>
    719     <level name="Doc" />
    720     <level name="Sec" />
    721     <level name="Para" />
     708        <level name="Sec" />
     709        <level name="Doc" />
    722710      </levelList>
    723711      <fieldList>
    724     <field shortname="ZZ" name="allfields" />
    725     <field shortname="TX" name="text" />
    726     <field shortname="TI" name="Title" />
    727     <field shortname="SU" name="Subject" />
    728     <field shortname="ORG" name="Organization" />
    729     <field shortname="SO" name="Source" />
     712        <field shortname="ZZ" name="allfields" />
     713        <field shortname="TX" name="text" />
     714        <field shortname="DL" name="dls.Title" />
     715        <field shortname="DS" name="dls.Subject" />
     716        <field shortname="DO" name="dls.Organization" />
    730717      </fieldList>
    731718      <searchTypeList>
    732     <searchType name="plain" />
    733     <searchType name="form" />
     719        <searchType name="form" />
     720        <searchType name="plain" />
    734721      </searchTypeList>
    735722      <defaultIndex name="idx" />
    736723      <indexList>
    737     <index name="idx" />
     724        <index name="idx" />
    738725      </indexList>
    739726    </serviceRack>
    740727  </serviceRackList>
    741 </buildConfig>
    742728\end{verbatim}\end{gsc}
    743 \caption{Sample buildConfig.xml file (mgppdemo collection)}
     729\caption{Sample buildConfig.xml file (gs2mgppdemo collection)}
    744730\label{fig:buildconfig}
    745731\end{figure}
    … …  
    20111997\bf Utility class & \bf Description\\
    20121998\hline
     1999CollectionClassLoader & ClassLoader that knows about a collection's resource directory \\
     2000DBInfo & Class to hold info from GDBM database entry \\
    20132001Dictionary & wrapper around a Resource Bundle, providing strings with parameters\\
     2002GDBMWrapper & Wrapper for GDBM database. Uses JavaGDBM\\
    20142003GSConstants & holds some constants used for servlet arguments and configuration variables\\
    20152004GSEntityResolver & an EntityResolver which can be used to find resources such as DTDs\\
    … …  
    20232012GSXML & lots of methods for extracting information out of \gs\  XML, and creating some common types of elements. Also has static Strings for element and attribute names used by \gs\ .\\
    20242013GSXSLT & some manipulation functions for \gs\  XSLT\\
     2014GlobalProperties & Holds the global properties (from global.properties) \\
     2015MacroResolver & Used with replace elements in collection config files, replaces a macro or string with another string, metadata or text from a dictionary\\
     2016GS2MacroResolver & MacroResolver for GS2 collections, that uses the GDBM database\\
    20252017Misc & miscellaneous functions\\
     2018MyNodeList & A simple implementation of an XML NodeList\\
    20262019OID & class to handle \gs\  (2) OIDs\\
    20272020GS3OID & subclass of OID to handle \gsiii\ OIDs\\
     2021Processing & Runs an external process and prints the output from the process \\
    20282022SQLQuery & contains a connection to a SQL database, along with some methods for accessing the data, such as converting MG numbers to and from Greenstone OIDs.\\
    20292023XMLConverter & provides methods to create new Documents, parse Strings or Files into Documents, and convert Nodes to Strings\\
Note: See TracChangeset for help on using the changeset viewer.