Ignore:
Timestamp:
2004-01-15T17:23:36+13:00 (20 years ago)
Author:
kjdon
Message:

* empty log message *

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r6511 r6518  
    5858\section{Greenstone installation and administration}\label{sec:install}
    5959
    60 This section covers where to get Greenstone 3 from, how to install it and how to run it. The standard method of running Greenstone is as a Java servlet. We provide the Tomcat servlet container to serve the servlet :-). Standard web servers may  be able to be configured to provide servlet support, and thereby remove the need to use Tomcat. Please see your web server documentation for this. This documentation assumes that you are using Tomcat. To access Greenstone, tomcat must be started up, and then it can be accessed via a web browser.
     60This section covers where to get Greenstone 3 from, how to install it and how to run it. The standard method of running Greenstone is as a Java servlet. We provide the Tomcat servlet container to serve the servlet :-). Standard web servers may  be able to be configured to provide servlet support, and thereby remove the need to use Tomcat. Please see your web server documentation for this. This documentation assumes that you are using Tomcat. To access Greenstone, Tomcat must be started up, and then it can be accessed via a web browser.
    6161
    6262
    6363\subsection{Get and install Greenstone}
    6464
    65 Greenstone is available from www.... There are currently two distributions: a self-installing tar for Linux, and a Windows executable.
     65Greenstone is available from \gst{http://www.greenstone.org/greensone3}. There are currently two distributions: a self-installing tar for Linux, and a Windows executable.
    6666
    6767Greenstone is also available through CVS (Concurrent Versioning System). This provides the absolute latest development version, and is not guaranteed to be stable. Appendix~\ref{app:cvs} describes how to download and install Greenstone from CVS.
    6868
    6969\subsubsection{Linux}
    70 ** add more once installer finished **
    71 
    72 Download the latest version of the self-installing tar file, gsdl3-x.xx-unix.sh, and run it in a shell (./gsdl3-x.xx-unix.sh). It will prompt you for where to install greenstone to, the name of your computer, what port to run tomcat on... Once Greenstone has been installed, you can start the library  by running ./gsdl3.sh, and opening up a browser pointing to localhost:8080/gsdl3 (or different computer name and port).
     70
     71Download the latest version of the self-installing tar file, gsdl3-x.xx-unix.sh, and run it in a shell (./gsdl3-x.xx-unix.sh). Greenstone will be installed into a directory called gsdl3 inside the current directory. The install script will prompt you for  the name of your computer and what port to run tomcat on (the defaults being localhost and 8080).  Once Greenstone has been installed, you can start the library  by running ./gsdl3/gs3-launch.sh, and opening up a browser pointing to localhost:8080/gsdl3 (or different computer name and port).
    7372
    7473\subsubsection{Windows}
    75 ** add more once installer finished **
    76 
    77 Download the latest Windows executable, gsdl3-x.xx-win32.exe, and double click it to start the installation. You will be prompted for ... Once Greenstone is installed, you can access the library by selecting Greenstone 3 Digital Library in the Start menu.
     74
     75Download the latest Windows executable, gsdl3-x.xx-win32.exe, and double click it to start the installation. You will be prompted for your computer name and port number to run Tomcat on (defaults are localhost and 8080). Once Greenstone is installed, you can access the library by selecting Greenstone 3 Digital Library in the Start menu.
    7876
    7977\subsubsection{Accessing the library in a browser}
    8078
    81 Once you have started up the library (see the previous sections for OS dependent instructions), you can access it in a browser at http://localhost:8080/gsdl3 (or http://your-computer-name/your-chosen-port/gsdl3). This gets you to a welcome page, with three links: one to run a test servlet (this allows you to check that tomcat is running properly), one to run the standard library servlet using localsite, and one to run a library servlet using the site soapsite. This site uses a SOAP connection to communicate with localsite, and demonstrates the library working in a distributed fashion. See Section~\ref{sec:distributed} for details about how to run Greenstone distributedly.
     79Once you have started up the library (see the previous sections for OS dependent instructions), you can access it in a browser at http://localhost:8080/gsdl3 (or http://your-computer-name:your-chosen-port/gsdl3). This gets you to a welcome page, with three links: one to run a test servlet (this allows you to check that Tomcat is running properly), one to run the standard library servlet using the site \gst{localsite}, and one to run a library servlet using the site \gst{soapsite}. This site uses a SOAP connection to communicate with localsite, and demonstrates the library working in a distributed fashion. See Section~\ref{sec:distributed} for details about how to run Greenstone distributedly.
    8280
    8381\subsection{How the library works}
    … …  
    396394To index only the title of each separate document in the collection:
    397395\begin{gsc}\begin{verbatim}
    398     <index name="dtt">
    399       <level>document</level>
    400       <field>dc:title</field>
    401       <displayItem name='name' lang="en">entire documents</displayItem>
    402       <displayItem name='name' lang="fr">documents entiers</displayItem>
    403       <displayItem name='name' lang="es">documentos enteros</displayItem>
    404     </index>
     396<index name="dtt">
     397  <level>document</level>
     398  <field>dc:title</field>
     399  <displayItem name='name' lang="en">entire documents</displayItem>
     400  <displayItem name='name' lang="fr">documents entiers</displayItem>
     401  <displayItem name='name' lang="es">documentos enteros</displayItem>
     402</index>
    405403\end{verbatim}\end{gsc}
    406404...in this case the \gst{<field>} tag refers to the ``title'' metadata item, found in the Dublin Core namespace.  The mg search engine would be used on this index.
    … …  
    408406Alternatively, to index the full document texts by section:
    409407\begin{gsc}\begin{verbatim}
    410     <index name="stx" type=''mgpp''>
    411       <level>section</level>
    412       <displayItem name='name' lang="en">entire documents</displayItem>
    413       <displayItem name='name' lang="fr">documents entiers</displayItem>
    414       <displayItem name='name' lang="es">documentos enteros</displayItem>     
    415     </index>
     408<index name="stx" type=''mgpp''>
     409  <level>section</level>
     410  <displayItem name='name' lang="en">entire documents</displayItem>
     411  <displayItem name='name' lang="fr">documents entiers</displayItem>
     412  <displayItem name='name' lang="es">documentos enteros</displayItem>     
     413</index>
    416414\end{verbatim}\end{gsc}
    417415...or...
    418416\begin{gsc}\begin{verbatim}
    419     <index name="stx" type=''mg''>
    420       <level>section</level>
    421       <field>text</field>
    422       <displayItem name='name' lang="en">entire documents</displayItem>
    423       <displayItem name='name' lang="fr">documents entiers</displayItem>
    424       <displayItem name='name' lang="es">documentos enteros</displayItem>
    425     </index>
     417<index name="stx" type=''mg''>
     418  <level>section</level>
     419  <field>text</field>
     420  <displayItem name='name' lang="en">entire documents</displayItem>
     421  <displayItem name='name' lang="fr">documents entiers</displayItem>
     422  <displayItem name='name' lang="es">documentos enteros</displayItem>
     423</index>
    426424\end{verbatim}\end{gsc}
    427 ...in the first example, the \gst{<field>} tag is not explicitly defined, and would default to 'text', whereas it is explicitly set to 'text' in the second example.  Note the different indexer selected for these two indexes.  As they are of the same name, they should not appear in the same \gsdt{collectionConfig.xml} file.
     425...in the first example, the \gst{<field>} tag is not explicitly defined, and would default to 'text', whereas it is explicitly set to 'text' in the second example.  Note the different indexer selected for these two indexes.  As they are of the same name, they should not appear in the same \gst{collectionConfig.xml} file.
    428426
    429427Moving onto \gst{<classifier>} items, the format is broadly similar to \gst{<index>} items, but with a couple of different choices.  Firstly, each classifier should have a ``name'' and ``type'' attribute as with \gst{<index>} tags.  In the case of \gst{<classifier>} items the ``type'' attribute identifies the type of classifier it is.  At present, this should either be ``Hierarchy'' or ``AZList''. 
    … …  
    431429The remaining choices for the classifier should follow as child elements of the \gst{<classifier>} element.  The \gst{<file>} element should contain the name of the file that describes the classifier as its ``URL'' attribute.  The format of this file will be described later - it will vary from classifier type to classifier type.  The \gst{<field>} element identifies the name of the field to index.  More than one \gst{<field>} element may appear if two or more metadata fields are to be used with the classifier.  Finally, the \gst{<sort>} item identifies another metadata field which the items within one classifier node are to be ordered.  Unlike the \gst{<index>} element, the \gst{<classifier>} element does not have default, assumed values for its children.
    432430
    433 Metadata for documents can be added using metadata.xml files.  These files have already been used in Greenstone 2, and the format is the same in Greenstone 3.  A metadata.xml file has a root element of <DirectoryMetadata>.  This encloses a series of <FileSet> items.  Neither of these tags has any attributes.  Each <FileSet> item includes two parts: firstly, one or more <FileName> tags, each of which encloses a regular expression to identify the files which are to be assigned the metadata.  Only files in the same directory as the metadata.xml, or in one of its child directories, file will be selected.  The filename tag encloses the regular expression as text, eg:
     431Metadata for documents can be added using metadata.xml files.  These files have already been used in Greenstone 2, and the format is the same in Greenstone 3.  A metadata.xml file has a root element of \gst{<DirectoryMetadata>}.  This encloses a series of \gst{<FileSet>} items.  Neither of these tags has any attributes.  Each \gst{<FileSet>} item includes two parts: firstly, one or more \gst{<FileName>} tags, each of which encloses a regular expression to identify the files which are to be assigned the metadata.  Only files in the same directory as the metadata.xml, or in one of its child directories, file will be selected.  The filename tag encloses the regular expression as text, eg:
    434432
    435433\begin{gsc}\begin{verbatim}
    … …  
    442440
    443441\begin{gsc}\begin{verbatim}
    444     <FileSet>
    445         <FileName>ec160e</FileName>
    446         <Description>
    447             <Metadata name="Title">The Courier - No.160 - Nov - Dec 1996 - Dossier Habitat - Country reports: Fiji , Tonga (ec160e)</Metadata>
    448             <Metadata mode="accumulate" name="Language">English</Metadata>
    449             <Metadata mode="accumulate" name="Subject">Settlements and housing: general works incl. low- cost housing, planning techniques, surveying, etc.</Metadata>
    450             <Metadata mode="accumulate" name="Subject">The Courier ACP 1990 - 1996 Africa-Caribbean-Pacific - European Union</Metadata>
    451             <Metadata mode="accumulate" name="Organization">EC Courier</Metadata>
    452             <Metadata mode="accumulate" name="AZList">T.1</Metadata>
    453         </Description>
    454     </FileSet>
     442<FileSet>
     443  <FileName>ec160e</FileName>
     444  <Description>
     445    <Metadata name="Title">The Courier - No.160 - Nov - Dec 1996 -
     446       Dossier Habitat - Country reports: Fiji , Tonga (ec160e)</Metadata>
     447    <Metadata mode="accumulate" name="Language">English</Metadata>
     448    <Metadata mode="accumulate" name="Subject">Settlements and housing:
     449      general works incl. low- cost housing, planning techniques, surveying,
     450      etc.</Metadata>
     451    <Metadata mode="accumulate" name="Subject">The Courier ACP 1990 - 1996
     452      Africa-Caribbean-Pacific - European Union</Metadata>
     453    <Metadata mode="accumulate" name="Organization">EC Courier</Metadata>
     454    <Metadata mode="accumulate" name="AZList">T.1</Metadata>
     455  </Description>
     456</FileSet>
    455457\end{verbatim}\end{gsc}
    456458
    457459Here, only one file pattern is found in the file set.  However, the \gst{Description} tag contains a number of separate metadata items.  Note that the \gst{Title} metadata does not have the accumulate metadata.  This means that when the title is assigned to a document, its existing \gst{Title} information will be lost.
    458460
    459 Whereever possible, the Greenstone 3 will import and use options from a Greenstone 2 \gst{collect.cfg} file.  However, it is strongly recommended that a proper collectionConfig.xml file is used wherever possible.
     461Whereever possible, the Greenstone 3 will import and use options from a Greenstone 2 \gst{collect.cfg} file.  However, it is strongly recommended that a proper \gst{collectionConfig.xml} file is used wherever possible.
    460462
    461463To build a collection execute \gst{gs3build.sh -collect collectionname}.  The process will run, placing the new indexes in the \gst{building} subdirectory of the collection's directory.
    462464
    463465[TODO: need to describe namespaces somewhere?]
    464 
    465 how to build a collection, but none of the mechanisms of building.
    466 talk a bit about configuration files? maybe just the parts that you use?? your changes should go into the next sections about configuration files, but they need to go here too.
    467466
    468467\subsubsection{Importing a greenstone 2 collection}
    … …  
    19201919
    19211920* should a metadata retrieval service advertise what metadata is available??
     1921
     1922standard service type vs new service type - standrad needs some xml response syntax.
     1923
    19221924\subsection{creating new actions/pages}\label{sec:new-pages}
    19231925
Note: See TracChangeset for help on using the changeset viewer.