Changeset 4190

Timestamp:

2003-04-17T15:29:10+12:00 (21 years ago)

Author:

kjdon

Message:

some more mods, still not finished

File:

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

trunk/gsdl3/docs/manual/manual.tex

@@ -318 +318 @@
 The startup configuration reads in teh various config files and loads up quite a lot of XML into memory. This avoids having to read in files all the time. However, this means that any changes to these files will have no effect in the system. So some run-time reconfiguration options are provided.
 
-Currently there are commands to reconfigure the entire site---i.e. the MessageRouter repeats the whole of its startup initialisation. 
+Currently there are commands to reconfigure the entire site, part of the site, single collections etc.
+The configure request messages are described in Section~\ref{sec:system}. A new action, SystemAction, is used to convert 'cgi'-arguments into system requests. Currently there is no configure web pages, but the arguments can be entered in the URL. The arguments and urls are described in Section~\ref{sec:system-action}.
+
 
 ***TODO***
@@ -386 +388 @@
 \begin{table}
 \center{\footnotesize
-\begin{tabular}{llll}
+\begin{tabular}{lll}
 \hline
 \bf Argument & \bf Meaning &\bf Typical values \\
@@ -586 +588 @@
 So far, we have only looked at ``describe'' requests. These can be asked of any module. Other requests are ``configure'' requests, and requests for services.
 
-\subsection{'system'-type messages}
+\subsection{'system'-type messages}\label{sec:system}
 ``System'' requests are used to tell the MessageRouter or a Collection or ServiceCluster to update its cached information and activate or deactivate other modules. For example, the MessageRouter has a set of Collection modules that it can talk to. It also holds some XML information about those collections---this is returned when a request for a collection list comes in. If a collection is deleted or modified, or a new one created, this information may need to change, and the list of available modules may also change.
 
@@ -982 +984 @@
 put a parameter called ``library'' into the applet data with a null value:
 \begin{quote}\begin{gsc}\begin{verbatim}
-<PARAM NAME='library' VALUE=''/>\/}
+<PARAM NAME='library' VALUE=''/>
 \end{verbatim}\end{gsc}\end{quote}
 When the Applet action encounters this parameter it inserts the name of the
@@ -993 +995 @@
 
 
+\subsection{System action}\label{sec:system-action}
+
+SystemAction allows for manual reconfiguration of various components at run-time. There is no interactive web-page displaying the options, it merely turns a set of cgi arguments into an xml system request. The response from a system request is a message which is displayed to the user.
+
+\begin{table}
+\caption{Configure cgi arguments}
+\label{tab:system-cgi}
+\begin{tabular}{ll}
+\hline
+\bf arg & \bf description\\
+a=s & system action\\
+sa=c|a|d & type of system request: c (configure), a (add/activate), \\
+& d (delete/deactivate) \\
+c=demo &  the request will go to this collection/servicecluster \\
+& instead of the message router\\
+ss=collectionList & subset for configure: only reconfigure this part.\\
+&  For the MessageRouter,  can be serviceClusterList, serviceList, \\
+& collectionList, siteList.\\
+&  For a collection/cluster, can be metadataList or serviceList.\\
+sn= & \\
+st & \\
+\hline
+\end{tabular}
+\end{table}
+
 
 \section{Collection formation}
 
-
-Greenstone 2 compatible building has been implemented in gsdl3. 
-
-Collection construction can be done through the web, using the build servicecluster in localsite. Just sequence through the steps needed. So far, addDocument does not work, so documents need to be manually added to teh import directory.
-
-You need to carry out the following services:
-NewCollection
-- add docs to import directory
-ImportCollection
-BuildCollection
-ActivateCollection
-
-If you want anything other than the default for the config file, you need to add it by hand - there is currently no ConfigureCollection service which would enable you to do this.
+So far, only Greenstone2 style building is available. This uses the import.pl and buildcol.pl perl scripts from Greenstone2. THese scripts and their needed perl modules have not been added to teh Greenstone3 system, so to do building, you need to have Greenstoen2 installed, and GSDLHOME, and GSDLOS set. (can do this by running 'source setup.bash' in the top level directory of gsdl.
+
+There are three ways of getting collections into greenstoen3. 
+
+\subsection{Importing gs2 collections}
+
+Collections built in a Greenstone2 system can be used in Greensotne3. Just copy across the collection's directory into the appropriate collect directory, and run \gst{convert\_coll\_from\_gs3.pl}. You need to specify the collect directory and the collection name. Eg.
+
+\gst{convert\_coll\_from\_gs2.pl -collectdir /research/kjdon/gsdl3/web/sites/localsite/collect demo}
+
+This creates the appropriate Greenstone3 XML configuration files. If you restart Tomcat, or give an add command (\gst{a=s\&sa=a\&st=collection\&sn=demo}), you should be able to see your new collection.
+
+
+\subsection{Building new collections through the web interface}
+
+Collection construction can be done through the web, using the build ServiceCluster in localsite. Just sequence through the steps needed. There is no automatic sequence taking you to the next page, you have to go back to teh build 'about' page, and select the next service manually. So far, AddDocument does not work, so documents need to be manually added to teh import directory. And there is no ConfigureCollection service yet, so if you want anything other than the default configuration, you need to edit the config files by hand. Editing collect.cfg will change the way building is done (by Greenstone2), and editing collectionConfig.xml will change the way the collection is used (by Greenstone3).
+
+You need to carry out the following steps:
+
+\begin{quote}
+NewCollection\\
+- add docs to import directory\\
+- optionally edit collect.cfg and/or collectionConfig.cfg\\
+ImportCollection\\
+BuildCollection\\
+ActivateCollection\\
+\end{quote}
+
+
+\subsection{Command line building}
+
 
 Collection building can also be done on the command line:
 
-\gst{ConstructCollection -site <site-path> -mode new|import|build|activate [options] <coll-name>}
+\begin{gsc}\begin{verbatim}
+ConstructCollection -site <site-path> 
+                    -mode new|import|build|activate 
+                    [options] <coll-name>
+\end{verbatim}\end{gsc}
 
 eg
 
-\gst{ConstructCollection -site /research/kjdon/home/gsdl3/sites/localsite -mode new -creator [email protected] testcol}
+\begin{gsc}\begin{verbatim}
+ConstructCollection -site /research/kjdon/gsdl3/web/sites/localsite 
+                    -mode new 
+                    -creator [email protected] testcol
+\end{verbatim}\end{gsc}
 
 the options get passed to the underlying script, - there is no good help message yet.