Changeset 9445

Timestamp:

2005-03-16T13:23:25+13:00 (19 years ago)

Author:

kjdon

Message:

small changes

Location:

trunk/gsdl3/docs/manual

Files:

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

trunk/gsdl3/docs/manual/manual.tex

@@ -687 +687 @@
 Appendix~\ref{app:gs2replace} gives some examples that have been used for Greenstone 2 collections.
 
-\subsection{buildConfig.xml}\label{sec:buildconfig}
+\subsubsection{buildConfig.xml}\label{sec:buildconfig}
 
 The file \gst{buildConfig.xml} is produced by the collection building process. Generally it is not necessary to look at this file, but it can be useful in determining what went wrong if the collection doesn't appear quite the way it was planned.
@@ -967 +967 @@
 
 Note, format templates are added into the XSLT files before transforming, while the options are added into the page source, and used in tests in the XSLT.
+\subsubsection{Changing the service text strings}
+
+Each collection has a set of services which are the access points for the information in the collection. Each service has a set of text strings which are used to display it. These include name, description, the text on the submit button, and names and descriptions of all the parameters to the service.
+
+These text strings are found in .properties files, in gsdl3/resources/java. The names of the files are based on class names. Subclasses can defined their own properties, or can use their parent class ones. For example, AbstractSearch defines strings for the TextQuery service, in AbstractSearch.properties. GS2MGSearch just uses these default ones, so doesn't need its own property file.
+
+A particular collection can override the properties for any service. For example, if a collection uses the GS2MGSearch service rack (look in the buildConfig.xml file for a list of service racks used), and the collection builder wants to change the text associated with this service, they can put a GS2MGSearch.properties file in the resources directory of the collection. 
+This will be used in preference to one in the default resources directory.
+Note that while changes in the default properties files seem to require a tomcat restart to take effect, changes in the colleciton specific properties files take effect immediately.
 
 \subsection{Customising the interface}\label{sec:interface-customise}
@@ -1611 +1620 @@
 \end{verbatim}\end{gsc}\end{quote}
 
-One or more parameters specifying metadata may be included in a request. Also, a value of \gst{all} will retrieve all the metadata for each document.
+One or more parameters specifying metadata may be included in a request. Also, ametadata  value of \gst{all} will retrieve all the metadata for each document.
 
 Any browse-type service must also implement a metadata retrieval service to provide metadata for the nodes in the classification hierarchy. The name of it is the browse service name plus \gst{MetadataRetrieve}. For example, the ClassifierBrowse service described in the previous section should also have a ClassifierBrowseMetadataRetrieve service. The request and response format is exactly the same as for the DocumentMetadataRetrieve service, except that \gst{<documentNode>} elements are replaced by \gst{<classifierNode>} elements (and the corresponding list element is also changed).
@@ -1674 +1683 @@
 \end{verbatim}\end{gsc}\end{quote}
 
-Structure is returned inside a \gst{<nodeStructure>} element, while structural info is returned in a \gst{<nodeStructureInfo>} element. Possible values for structure parameters are as for browse services: \gst{ancestors}, \gst{parent}, \gst{siblings}, \gst{children}, \gst{descendents}. Possible values for info parameters are \gst{numSiblings}, \gst{siblingPosition}, \gst{numChildren}. 
+Structure is returned inside a \gst{<nodeStructure>} element, while structural info is returned in a \gst{<nodeStructureInfo>} element. Possible values for structure parameters are as for browse services: \gst{ancestors}, \gst{parent}, \gst{siblings}, \gst{children}, \gst{descendents}, \gst{entire}. Possible values for info parameters are \gst{numSiblings}, \gst{siblingPosition}, \gst{numChildren}. 
 
 \subsubsection{'process'-type services}\label{sec:process}
@@ -2231 +2240 @@
 To startup or shutdown the library (includes the Tomcat server and MYSQL server), the commands are (run from the gsdl3 directory):
 \begin{quote}\begin{gsc}
-./gs3-launch.sh or gs3-launch
+./gs3-launch.sh or gs3-launch \\
 ./gs3-launch.sh -shutdown or close the window
 \end{gsc}\end{quote}
@@ -2320 +2329 @@
 \end{gsc}\end{quote}
 
-This creates a new SOAPServer class for the site (\gst{\$GSDL3HOME/src/java/org/greenstone/gsdl3/SOAPServer<sitename>.java}), creates a resource file for deployment (\gst{\$GSDL3HOME/resources/soap/<sitename>.xml}), and then tries to deploy the service. If the deployment doesn't work, you can run it from the command line like:
+This creates a new SOAPServer class for the site \\(\gst{\$GSDL3HOME/src/java/org/greenstone/gsdl3/SOAPServer<sitename>.java}), creates a resource file for deployment (\gst{\$GSDL3HOME/resources/soap/<sitename>.xml}), and then tries to deploy the service. If the deployment doesn't work, you can run it from the command line like:
 
 \begin{gsc}\begin{verbatim}
@@ -2420 +2429 @@
 Getting rid of silly backslashes:
 \begin{gsc}\begin{verbatim}
-<replace scope='text' macro="\backslash\backslash?\backslash\backslash\backslash(" text="\backslash("/>
+<replace scope='text' macro="\\?\\\(" text="\("/>
 \end{verbatim}\end{gsc}
 
 Macro resolving using resource bundles and metadata:
 \begin{gsc}\begin{verbatim}
-<replace scope='metadata' macro="_magazines_" bundle="NZDLMacros" key="Magazines"/>
+<replace scope='metadata' macro="_magazines_" bundle="NZDLMacros" 
+   key="Magazines"/>
 <replace scope='all' macro='_thisOID_' metadata='archivedir'/>
-<replace macro="_httpcollimg_" text="sites/localsite/collect/folktale/index/assoc"/>
+<replace macro="_httpcollimg_" 
+   text="sites/localsite/collect/folktale/index/assoc"/>
 \end{verbatim}\end{gsc}
 
 Fixing up broken external links:
 \begin{gsc}\begin{verbatim}
-<replace macro="_httpextlink_&amp;rl=1&amp;href=" text="?a=d&amp;c=folktale&amp;s0.ext=1&amp;d="/>
-<replace macro="_httpextlink_&amp;rl=0&amp;href=" text="?a=p&amp;sa=html&amp;c=folktale&amp;url="/>
-</replaceList>
+<replace macro="_httpextlink_&amp;rl=1&amp;href=" 
+   text="?a=d&amp;c=folktale&amp;s0.ext=1&amp;d="/>
+<replace macro="_httpextlink_&amp;rl=0&amp;href=" 
+   text="?a=p&amp;sa=html&amp;c=folktale&amp;url="/>
 \end{verbatim}\end{gsc}
 
@@ -2442 +2454 @@
 Sometimes we need to add in macros to be resolved in a second step:
 \begin{gsc}\begin{verbatim}
-<replace macro="_iconpdf_" scope="metadata" text="&lt;img border='0' height='26' width='26' alt='PDF' title='_texticonpdf_' src='interfaces/default/images/ipdf.gif'/&gt;"/>
-<replace macro="_texticonpdf_" scope="metadata" bundle="interface_classic" key="texticonpdf"/>
+<replace macro="_iconpdf_" scope="metadata" 
+   text="&lt;img title='_texticonpdf_' src='interfaces/default/images/ipdf.gif'/&gt;"/>
+<replace macro="_texticonpdf_" scope="metadata" bundle="interface_classic" 
+   key="texticonpdf"/>
 \end{verbatim}\end{gsc}