Changeset 13920 for trunk/gsdl3/docs/manual/manual.tex

Timestamp:

2007-02-15T11:56:51+13:00 (17 years ago)

Author:

kjdon

Message:

removed old authors, changed greenstone 3 to greenstone3 and same for greenstone2

File:

• trunk/gsdl3/docs/manual/manual.tex (modified) (13 diffs)

trunk/gsdl3/docs/manual/manual.tex

@@ -9 +9 @@
 \newcommand{\gst}[1]{{\footnotesize \tt #1}}
 
-\newcommand{\gsii}{Greenstone 2}
-\newcommand{\gsiii}{Greenstone 3}
+\newcommand{\gsii}{Greenstone2}
+\newcommand{\gsiii}{Greenstone3}
 \newcommand{\gs}{Greenstone}
 
@@ -18 +18 @@
 
 % if you work on this manual, add your name here
-\author{Katherine Don, George Buchanan and Ian H. Witten \\[1ex]
+\author{Katherine Don \\[1ex]
         Department of Computer Science \\
         University of Waikato \\ Hamilton, New Zealand \\ }
@@ -71 +71 @@
  \gst{https://sourceforge.net/projects/greenstone3}. There are Windows, Linux, and source releases. The binary releases are self-installing executables: download and run the file to install. A series of prompts will guide you through the installation process. The source release is a gzip'd tar file. Unzip and untar this, check build.properties, then run \gst{'ant install'} to configure and compile the code.
 
-The Greenstone 3 library can be launched by running the server program. This is accessible from the Start menu on Windows, or by running the \gst{gs3-server.sh/bat} script in the top level \gst{greenstone3} directory. This program will start up the Tomcat web server and launch a browser.
+The \gsiii\  library can be launched by running the server program. This is accessible from the Start menu on Windows, or by running the \gst{gs3-server.sh/bat} script in the top level \gst{greenstone3} directory. This program will start up the Tomcat web server and launch a browser.
 
 Alternatively, you can start it up using Ant: run \gst{'ant start'}, which starts up Tomcat, then in a browser go to \gst{http://localhost:8080/greenstone3}\\
@@ -118 +118 @@
   & Source code lives here \\
 greenstone3/src/java/
-  & main greenstone 3 java source code \\
+  & main \gsiii\  java source code \\
 greenstone3/src/packages 
   & Imported source packages from other systems e.g. indexing packages may go here \\
@@ -124 +124 @@
   & Shared library files\\
 greenstone3/lib/java
-  & Java jar files not needed in the greenstone 3 runtime\\
+  & Java jar files not needed in the \gsiii\  runtime\\
 greenstone3/lib/jni
   & Jar files and shared library files (.so, .jnilib, .dll) needed for JNI components \\
@@ -418 +418 @@
 Collection building using the GLI will use the \gsii\ Perl scripts and plugins. At the conclusion of the \gsii\ build process, a conversion script will be run to create the \gsiii\  configuration files. This means that format statements are no longer 'live'---changing these will require changes to the \gsiii\ configuration files. Clicking the Preview Collection button will re-run the configuration file conversion script. If you change anything on the Format panel, you will need to click Preview Collection. Just reloading the collection via a browser will not be enough. 
  
-Detailed instructions about using the GLI can be found in Sections 3.1 and 3.2 of the Greenstone 2 User's Guide (\gst{GS2-User-en.pdf}). This can be found in  your \gsii\ installation, or in the \gst{\$GSDL3SRCHOME/docs/manual} directory if you have installed \gsiii\ from a distribution.
+Detailed instructions about using the GLI can be found in Sections 3.1 and 3.2 of the \gsii\  User's Guide (\gst{GS2-User-en.pdf}). This can be found in  your \gsii\ installation, or in the \gst{\$GSDL3SRCHOME/docs/manual} directory if you have installed \gsiii\ from a distribution.
 
 
@@ -636 +636 @@
 Format elements are described in Section~\ref{sec:formatstmt}.
 
-An optional \gst{<replaceList>} element can be included at the top level. This contains a list of strings and their replacements. This is particularly useful for Greenstone 2 collections that use macros. 
+An optional \gst{<replaceList>} element can be included at the top level. This contains a list of strings and their replacements. This is particularly useful for \gsii\  collections that use macros. 
 
 The format is like the following:
@@ -649 +649 @@
 Scope determines on what text the replacements are carried out: \gst{text}, \gst{metadata}, and \gst{all} (both text and metadata). An empty scope attribute is equivalent to scope=all. Each replace type can be used with all scope values. Replacing uses Java's 'String.replaceAll' functionality, so macro and replacement text are actually regular expressions. The first example is a straight textual replacement. The second example uses dictionary lookups. xxx will be replaced with the (language-dependent) value for key zzz in resource bundle yyy. The third example uses metadata: xxx will be replaced by the value of the yyy metadata for that document.
 
-Appendix~\ref{app:gs2replace} gives some examples that have been used for Greenstone 2 collections.
+Appendix~\ref{app:gs2replace} gives some examples that have been used for \gsii\  collections.
 
 \subsubsection{buildConfig.xml}\label{sec:buildconfig}
@@ -1947 +1947 @@
 \subsubsection{GS2Browse action}\label{sec:browseaction}
 
-GS2BrowseAction is for displaying Greenstone 2 style classifiers. 
+GS2BrowseAction is for displaying \gsii\  style classifiers. 
 \subsubsection{System action}\label{sec:systemaction}
 
@@ -2224 +2224 @@
 \section{Tomcat}\label{app:tomcat}
 
-Tomcat is a servlet container, and Greenstone 3 runs as a servlet inside it. 
+Tomcat is a servlet container, and \gsiii\  runs as a servlet inside it. 
 
 The file \gst{\$GSDL3SRCHOME/packages/tomcat/conf/server.xml} is the Tomcat configuration file. A context for \gsiii\  is given by the file\\ \gst{\$GSDL3SRCHOME/packages/tomcat/conf/Catalina/localhost/greenstone3.xml}. This tells Tomcat where to find the web.xml file, and what URL (\gst{/greenstone3}) to give it. Anything inside the context directory is accessible via Tomcat\footnote{can we use .htaccess files to restrict access??}. For example, the index.html file that lives in \gst{\$GSDL3HOME} can be accessed through the URL \gst{localhost:8080/greenstone3/index.html}. The gs2mgdemo collection's images can be accessed through \\
@@ -2304 +2304 @@
 
 \newpage
-\section{Tidying up the formatting for imported Greenstone 2 collections}\label{app:gs2tidy}
+\section{Tidying up the formatting for imported \gsii\  collections}\label{app:gs2tidy}
 
 \subsection{Format statements: \gsii\  vs \gsiii\ }\label{app:gs2format}
@@ -2351 +2351 @@
 \subsection{Cleaning up macros}\label{app:gs2replace}
 
-Here we show some of the replace items that have been used for Greenstone 2 collections.
+Here we show some of the replace items that have been used for \gsii\  collections.
 
 Getting rid of silly backslashes:
@@ -2375 +2375 @@
 \end{verbatim}\end{gsc}
 
-These two examples show how to deal with Greenstone 2's external link macros. The first one is for a 'relative' external link. In this case, the links are like URL's but they actually refer to Greenstone internal documents. So the Greenstone 3 link is to the document, but with parameter s0.ext signifying that the d argument will need translating before retrieving the content.
+These two examples show how to deal with \gsii's external link macros. The first one is for a 'relative' external link. In this case, the links are like URL's but they actually refer to Greenstone internal documents. So the \gsiii\  link is to the document, but with parameter s0.ext signifying that the d argument will need translating before retrieving the content.
 The second example is a truly external link. This is translated into a HTML type page action, where the URL is presented as a frame along with the collection header in a separate frame.