Changeset 10863
- Timestamp:
- 2005-11-07T17:02:29+13:00 (18 years ago)
- Location:
- trunk/gsdl3/docs/manual
- Files:
-
- 2 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/gsdl3/docs/manual/manual.tex
r10826 r10863 209 209 \bf name & \bf sample value & \bf description \\ 210 210 \hline 211 gsdl3\_home & /research/kjdon/greenstone3 & the base directory of the greenstone3 installation \\212 211 site\_name & localsite & the name of the site to use \\ 213 212 interface\_name & default & the name of the interface to use\\ … … 515 514 \begin{figure} 516 515 \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"> 519 518 <metadataList> 520 519 <metadata name="creator">[email protected]</metadata> 521 520 </metadataList> 522 521 <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> 534 527 </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"> 544 534 <field>text</field> 545 535 <level>section</level> 546 536 <displayItem name='name' lang="en">chapters</displayItem> 547 537 <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> 549 539 </index> 540 [ ... more indexes ...] 550 541 <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> 555 545 </format> 556 546 </search> 557 547 <browse> 558 <classifier name="CL 1" type="AZList" horizontalAtTop='true'>548 <classifier name="CLTit" type="AZList" horizontalAtTop='true'> 559 549 <field>Title</field> 560 550 <sort>Title</sort> 561 551 <displayItem name='name' lang='en'>Titles</displayItem> 562 552 </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 ...] 570 554 <classifier name="CLKeyword" type="Hierarchy"> 571 555 <field>Keyword</field> 572 556 <sort>Title</sort> 573 557 <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"/> 576 559 <format> 577 560 <gsf:template match="documentNode"> … … 581 564 </classifier> 582 565 </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> 584 572 </collectionConfig> 585 573 \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)} 588 575 \label{fig:collconfig} 589 576 \end{figure} … … 688 675 The 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. 689 676 690 It contains 691 be determined automatically, 677 It contains metadata and other information about the collection that can 678 be determined automatically, such as the number of 692 679 documents it contains. It also includes a list of ServiceRack classes that are 693 680 required to provide the services that have been built into the 694 681 collection. The serviceRack names are Java classes that are loaded 695 682 dynamically 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{GS2 MGPPRetrieve}, \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.683 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{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. 697 684 698 685 699 686 \begin{figure} 700 687 \begin{gsc}\begin{verbatim} 701 <buildConfig xmlns:gsf="http://www.greenstone.org/configformat">688 <buildConfig> 702 689 <metadataList> 703 690 <metadata name="numDocs">11</metadata> 691 <metadata name="buildType">mgpp</metadata> 704 692 </metadataList> 705 693 <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> 706 702 <serviceRack name="GS2MGPPRetrieve"> 707 703 <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>714 704 </serviceRack> 715 <serviceRack name="PhindPhraseBrowse" />716 705 <serviceRack name="GS2MGPPSearch"> 717 706 <defaultLevel name="Sec" /> 718 707 <levelList> 719 <level name="Doc" /> 720 <level name="Sec" /> 721 <level name="Para" /> 708 <level name="Sec" /> 709 <level name="Doc" /> 722 710 </levelList> 723 711 <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" /> 730 717 </fieldList> 731 718 <searchTypeList> 732 <searchType name="plain" />733 <searchType name="form" />719 <searchType name="form" /> 720 <searchType name="plain" /> 734 721 </searchTypeList> 735 722 <defaultIndex name="idx" /> 736 723 <indexList> 737 724 <index name="idx" /> 738 725 </indexList> 739 726 </serviceRack> 740 727 </serviceRackList> 741 </buildConfig>742 728 \end{verbatim}\end{gsc} 743 \caption{Sample buildConfig.xml file ( mgppdemo collection)}729 \caption{Sample buildConfig.xml file (gs2mgppdemo collection)} 744 730 \label{fig:buildconfig} 745 731 \end{figure} … … 2011 1997 \bf Utility class & \bf Description\\ 2012 1998 \hline 1999 CollectionClassLoader & ClassLoader that knows about a collection's resource directory \\ 2000 DBInfo & Class to hold info from GDBM database entry \\ 2013 2001 Dictionary & wrapper around a Resource Bundle, providing strings with parameters\\ 2002 GDBMWrapper & Wrapper for GDBM database. Uses JavaGDBM\\ 2014 2003 GSConstants & holds some constants used for servlet arguments and configuration variables\\ 2015 2004 GSEntityResolver & an EntityResolver which can be used to find resources such as DTDs\\ … … 2023 2012 GSXML & 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\ .\\ 2024 2013 GSXSLT & some manipulation functions for \gs\ XSLT\\ 2014 GlobalProperties & Holds the global properties (from global.properties) \\ 2015 MacroResolver & Used with replace elements in collection config files, replaces a macro or string with another string, metadata or text from a dictionary\\ 2016 GS2MacroResolver & MacroResolver for GS2 collections, that uses the GDBM database\\ 2025 2017 Misc & miscellaneous functions\\ 2018 MyNodeList & A simple implementation of an XML NodeList\\ 2026 2019 OID & class to handle \gs\ (2) OIDs\\ 2027 2020 GS3OID & subclass of OID to handle \gsiii\ OIDs\\ 2021 Processing & Runs an external process and prints the output from the process \\ 2028 2022 SQLQuery & 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.\\ 2029 2023 XMLConverter & 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.