Changeset 4190 for trunk/gsdl3/docs/manual
- Timestamp:
- 2003-04-17T15:29:10+12:00 (21 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/gsdl3/docs/manual/manual.tex
r4162 r4190 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. 319 319 320 Currently there are commands to reconfigure the entire site---i.e. the MessageRouter repeats the whole of its startup initialisation. 320 Currently there are commands to reconfigure the entire site, part of the site, single collections etc. 321 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}. 322 321 323 322 324 ***TODO*** … … 386 388 \begin{table} 387 389 \center{\footnotesize 388 \begin{tabular}{lll l}390 \begin{tabular}{lll} 389 391 \hline 390 392 \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. 587 589 588 \subsection{'system'-type messages} 590 \subsection{'system'-type messages}\label{sec:system} 589 591 ``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. 590 592 … … 982 984 put a parameter called ``library'' into the applet data with a null value: 983 985 \begin{quote}\begin{gsc}\begin{verbatim} 984 <PARAM NAME='library' VALUE=''/> \/}986 <PARAM NAME='library' VALUE=''/> 985 987 \end{verbatim}\end{gsc}\end{quote} 986 988 When the Applet action encounters this parameter it inserts the name of the … … 993 995 994 996 997 \subsection{System action}\label{sec:system-action} 998 999 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. 1000 1001 \begin{table} 1002 \caption{Configure cgi arguments} 1003 \label{tab:system-cgi} 1004 \begin{tabular}{ll} 1005 \hline 1006 \bf arg & \bf description\\ 1007 a=s & system action\\ 1008 sa=c|a|d & type of system request: c (configure), a (add/activate), \\ 1009 & d (delete/deactivate) \\ 1010 c=demo & the request will go to this collection/servicecluster \\ 1011 & instead of the message router\\ 1012 ss=collectionList & subset for configure: only reconfigure this part.\\ 1013 & For the MessageRouter, can be serviceClusterList, serviceList, \\ 1014 & collectionList, siteList.\\ 1015 & For a collection/cluster, can be metadataList or serviceList.\\ 1016 sn= & \\ 1017 st & \\ 1018 \hline 1019 \end{tabular} 1020 \end{table} 1021 995 1022 996 1023 \section{Collection formation} 997 1024 998 999 Greenstone 2 compatible building has been implemented in gsdl3. 1000 1001 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. 1002 1003 You need to carry out the following services: 1004 NewCollection 1005 - add docs to import directory 1006 ImportCollection 1007 BuildCollection 1008 ActivateCollection 1009 1010 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. 1025 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. 1026 1027 There are three ways of getting collections into greenstoen3. 1028 1029 \subsection{Importing gs2 collections} 1030 1031 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. 1032 1033 \gst{convert\_coll\_from\_gs2.pl -collectdir /research/kjdon/gsdl3/web/sites/localsite/collect demo} 1034 1035 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. 1036 1037 1038 \subsection{Building new collections through the web interface} 1039 1040 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). 1041 1042 You need to carry out the following steps: 1043 1044 \begin{quote} 1045 NewCollection\\ 1046 - add docs to import directory\\ 1047 - optionally edit collect.cfg and/or collectionConfig.cfg\\ 1048 ImportCollection\\ 1049 BuildCollection\\ 1050 ActivateCollection\\ 1051 \end{quote} 1052 1053 1054 \subsection{Command line building} 1055 1011 1056 1012 1057 Collection building can also be done on the command line: 1013 1058 1014 \gst{ConstructCollection -site <site-path> -mode new|import|build|activate [options] <coll-name>} 1059 \begin{gsc}\begin{verbatim} 1060 ConstructCollection -site <site-path> 1061 -mode new|import|build|activate 1062 [options] <coll-name> 1063 \end{verbatim}\end{gsc} 1015 1064 1016 1065 eg 1017 1066 1018 \gst{ConstructCollection -site /research/kjdon/home/gsdl3/sites/localsite -mode new -creator [email protected] testcol} 1067 \begin{gsc}\begin{verbatim} 1068 ConstructCollection -site /research/kjdon/gsdl3/web/sites/localsite 1069 -mode new 1070 -creator [email protected] testcol 1071 \end{verbatim}\end{gsc} 1019 1072 1020 1073 the options get passed to the underlying script, - there is no good help message yet.
Note:
See TracChangeset
for help on using the changeset viewer.