Changeset 10826

Timestamp:

2005-11-02T15:22:08+13:00 (18 years ago)

Author:

kjdon

Message:

fixed up paths etc for new layout

Location:

trunk/gsdl3/docs/manual

Files:

• manual.pdf (modified) ( previous)
• manual.tex (modified) (13 diffs)

trunk/gsdl3/docs/manual/manual.tex

@@ -93 +93 @@
 \begin{gsc}
 \item \gsdlhome/web/WEB-INF/web.xml
-\item \gsdlhome/comms/jakarta/tomcat/conf/server.xml
+\item \gsdlhome/packages/tomcat/conf/server.xml
 \end{gsc}
 \item any classes or jar files used by the servlets
 \end{bulletedlist}
 \noindent Note: stdout and stderr for the servlets (on Linux and Mac OS X) both go to\\
-\gst{\gsdlhome/comms/jakarta/tomcat/logs/catalina.out}
+\gst{\gsdlhome/packages/tomcat/logs/catalina.out}
 
 
@@ -121 +121 @@
   & Source code lives here \\
 greenstone3/src/java/
-  & java source code \\
-greenstone3/packages 
-  & Imported packages from other systems e.g. MG, MGPP \\
+  & main greenstone 3 java source code \\
+greenstone3/src/packages 
+  & Imported source packages from other systems e.g. MG, MGPP \\
+greenstone3/extensions
+  & Extensions to greenstone 3 core functionality, eg, Vishnu visualizer, Alerting service \\
 greenstone3/lib
   & Shared library files\\
 greenstone3/lib/java
-  & Java jar files\\
+  & Java jar files not needed in the greenstone 3 runtime\\
+greenstone3/lib/jni
+  & Jar files and shared library files (.so, .jnilib, .dll) needed for JNI components \\
 greenstone3/resources 
  & any resources that may be needed\\
-greenstone3/resources/java
- & properties files for java resource bundles - used to handle all the language specific text This directory is on the class path, so any other Java resources can be placed here \\
 greenstone3/resources/soap
  & soap service description files \\
-greenstone3/resources/dtd
- & \gsiii\  has trouble locating DTD files sometimes. They can go here\\
 greenstone3/bin
   & executable stuff lives here\\
 greenstone3/bin/script
   & some Perl and/or shell building scripts\\
-greenstone3/comms
-  & Communication packages: Tomcat and SOAP\\
+greenstone3/packages
+  & External packages that may be installed as part of greenstone, e.g. Tomcat, Mysql \\
 greenstone3/docs
   & Documentation\\
@@ -150 +150 @@
   & The web.xml file lives here (servlet configuration information for Tomcat)\\
 greenstone3/web/WEB-INF/classes
-  & Servlet classes go in here\\
+  & Individual class files needed by the servlet go in here, also properties files for java resource bundles - used to handle all the language specific text. This direcotry is on the servlet classpath\\
+greenstone3/web/WEB-INF/lib
+  & jar files needed by the servlets go here \\
 greenstone3/web/sites
   & Contains directories for different sites---a site is a set of collections and services served by a single MessageRouter (MR). The MR may have connections (e.g. soap) to other sites\\
@@ -169 +171 @@
 greenstone3/web/interfaces/default/transforms
   & The XSLT files for the default interface\\
+greenstone3/web/applet 
+  & jar files needed by applets can go here \\
 \hline
 \end{tabular}}
@@ -233 +237 @@
 Figure~\ref{fig:siteconfig} shows two example site configuration files. The first example is for a rudimentary site with no site-wide services,
 which does not connect to any external sites. The second example is for a site with one site-wide service cluster - a collection building cluster.  It also connects to the first site using SOAP.
-These two sites happen to be running on the same machine, which is why they can use \gst{localhost} in the address. For site \gst{gsdl1} to talk to site \gst{localsite}, a SOAP server must be run for \gst{localsite}. The address of the SOAP server, in this case, is \gst{http://localhost:8080/soap/servlet/rpcrouter}.
+These two sites happen to be running on the same machine, which is why they can use \gst{localhost} in the address. For site \gst{gsdl1} to talk to site \gst{localsite}, a SOAP server must be run for \gst{localsite}. The address of the SOAP server, in this case, is \gst{http://localhost:8080/greenstone3/services/localsite}.
 
 
@@ -265 +269 @@
   <siteList>
     <site name="org.greenstone.localsite"
-      address="http://localhost:8080/soap/servlet/rpcrouter"
+      address="http://localhost:8080/greenstone3/services/localsite"
       type="soap"/>
   </siteList>
@@ -1100 +1104 @@
   <siteList>
     <site name='org.greenstone.gsdl1'
-            address='http://localhost:8080/soap/servlet/rpcrouter'
+            address='http://localhost:8080/greenstone3/services/localsite'
             type='soap' />
   </siteList>
@@ -2213 +2217 @@
 Greenstone is built and installed using Ant (Apache's Java based build tool, 
 http://ant.apache.org). You will need a Java Development 
-Environment (1.4 or higher), and Ant installed to use Greenstone. You can download Ant from http://ant.apache.org/bindownload.cgi.
+Environment (1.4 or higher), and Ant installed to use Greenstone. You can download Ant from \\\gst{http://ant.apache.org/bindownload.cgi}.
 
 In the greenstone3 directory, you can run 'ant' which will give you a help message.
@@ -2228 +2232 @@
 ant -Dproperties.accepted=yes -logfile build.log install
 
-Under Linux, Java and C/C++ compilation is carried out. For windows, since Visual Studio is not a standard component, only Java compilation is carried out. Pre-compiled binaries are provided for the C/C++ components (packages and Greenstone 2 style building). If you have Visual Studio installed (version 6), you can run the compile-windows-c++ targets to compile the code locally. (Don't forget to setup the Visual Studio environment first, by running, e.g. C:/Program Files/Microsoft Visual Studio/VC98/Bin/VCVARS32.BAT or equivalent.)
+Under Linux, Java and C/C++ compilation is carried out. For windows, since Visual Studio is not a standard component, only Java compilation is carried out. Pre-compiled binaries are provided for the C/C++ components (source packages and Greenstone 2 style building). If you have Visual Studio installed (version 6), you can run the compile-windows-c++ targets to compile the code locally. (Don't forget to setup the Visual Studio environment first, by running, e.g. C:/Program Files/Microsoft Visual Studio/VC98/Bin/VCVARS32.BAT or equivalent.)
 
 
@@ -2247 +2251 @@
 Tomcat is a servlet container, and Greenstone 3 runs as a servlet inside it. 
 
-The file \gst{\gsdlhome/comms/jakarta/tomcat/conf/server.xml} is the Tomcat configuration file. The installation process adds a context for \gsiii\  servlets (\gst{\gsdlhome/web})---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{\gsdlhome/web} can be accessed through the URL \gst{localhost:8080/greenstone3/index.html}. The demo collection's images can be accessed through \\
+The file \gst{\gsdlhome/packages/tomcat/conf/server.xml} is the Tomcat configuration file. The installation process adds a context for \gsiii\  servlets (\gst{\gsdlhome/web})---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{\gsdlhome/web} can be accessed through the URL \gst{localhost:8080/greenstone3/index.html}. The demo collection's images can be accessed through \\
 \gst{localhost:8080/greenstone3/sites/localsite/collect/demo/images/}.
 
@@ -2257 +2261 @@
 \begin{gsc}
 \item \gsdlhome/web/WEB-INF/web.xml
-\item \gsdlhome/comms/jakarta/tomcat/conf/server.xml
+\item \gsdlhome/packages/tomcat/conf/server.xml
 \end{gsc}
 \item any classes or jar files used by the servlets
 \end{bulletedlist}
 \noindent Note: stdin and stdout for the servlets (on linux) both go to\\
-\gst{\gsdlhome/comms/jakarta/tomcat/logs/catalina.out}
+\gst{\gsdlhome/packages/tomcat/logs/catalina.out}
 
 On startup, the servlet loads in its collections and services. If the site or collection configuration files are changed, these changes will not take effect until the site/collection is reloaded. This can be done through the reconfiguration messages (see Section~\ref{sec:runtime-config}), or by restarting Tomcat.
 
-We have set up Tomcat to follow symlinks. To disable this feature, remove the \gst{<Resources>} element from the greenstone3 context in \\\gst{\$GSDL3HOME/comms/jakarta/tomcat/conf/server.xml}:
+We have set up Tomcat to follow symlinks. To disable this feature, remove the \gst{<Resources>} element from the greenstone3 context in \\\gst{\$GSDL3HOME/packages/tomcat/conf/server.xml}:
 
 \begin{quote}\begin{gsc}
@@ -2275 +2279 @@
 \end{gsc}\end{quote}
 
-By default, Tomcat allows directory listings. To disable this, change the 'listings' paramter to false in the default servlet definition, in Tomcat's web.xml file (\gst{\$GSDL3HOME/comms/jakarta/tomcat/conf/web.xml}):
+By default, Tomcat allows directory listings. To disable this, change the 'listings' paramter to false in the default servlet definition, in Tomcat's web.xml file (\gst{\$GSDL3HOME/packages/tomcat/conf/web.xml}):
 
 We have set the greenstone context to be reloadable. This means that if a class or resource file in web/WEB-INF/lib or web/WEB-INF/classes changes, the servlet will be reloaded. This is useful for development, but should be turned off for production mode (set the reloadable attribute to false).
 
 Tomcat uses a Manager to handle HTTP session information. This may be stored between restarts if possible. To use a persistent session handling manager, uncomment the \gst{<Manager>} element in \\
-\gst{\$GSDL3HOME/comms/jakarta/tomcat/conf/server.xml}. For the default manager, session information is stored in the work directory:\\
-\gst{\$GSDL3HOME/comms/jakarta/tomcat/work/Standalone/localhost/greenstone3/SESSIONS.ser}. Delete this file to clear the cached session info. Note that Tomcat needs to be shutdown to delete this file.
+\gst{\$GSDL3HOME/packages/tomcat/conf/server.xml}. For the default manager, session information is stored in the work directory:\\
+\gst{\$GSDL3HOME/packages/tomcat/work/Standalone/localhost/greenstone3/SESSIONS.ser}. Delete this file to clear the cached session info. Note that Tomcat needs to be shutdown to delete this file.
 
 \subsection{Proxying Tomcat with apache}
@@ -2322 +2326 @@
 To run it, type:
 
-\begin{quote}\gst{java -cp <path to greenstone3>/comms/soap/axis/lib/axis.jar \\
+\begin{quote}\gst{java -cp \$GSDL3HOME/web/WEB-INF/lib/axis.jar \\
 org.apache.axis.utils.tcpmon}
 \end{quote}