Changeset 9445 for trunk/gsdl3/docs/manual
- Timestamp:
- 2005-03-16T13:23:25+13:00 (19 years ago)
- Location:
- trunk/gsdl3/docs/manual
- Files:
-
- 2 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/gsdl3/docs/manual/manual.tex
r8757 r9445 687 687 Appendix~\ref{app:gs2replace} gives some examples that have been used for Greenstone 2 collections. 688 688 689 \subs ection{buildConfig.xml}\label{sec:buildconfig}689 \subsubsection{buildConfig.xml}\label{sec:buildconfig} 690 690 691 691 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 968 968 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. 969 \subsubsection{Changing the service text strings} 970 971 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. 972 973 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. 974 975 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. 976 This will be used in preference to one in the default resources directory. 977 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. 969 978 970 979 \subsection{Customising the interface}\label{sec:interface-customise} … … 1611 1620 \end{verbatim}\end{gsc}\end{quote} 1612 1621 1613 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.1622 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. 1614 1623 1615 1624 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} 1675 1684 1676 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}.1685 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}. 1677 1686 1678 1687 \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): 2232 2241 \begin{quote}\begin{gsc} 2233 ./gs3-launch.sh or gs3-launch 2242 ./gs3-launch.sh or gs3-launch \\ 2234 2243 ./gs3-launch.sh -shutdown or close the window 2235 2244 \end{gsc}\end{quote} … … 2320 2329 \end{gsc}\end{quote} 2321 2330 2322 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:2331 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: 2323 2332 2324 2333 \begin{gsc}\begin{verbatim} … … 2420 2429 Getting rid of silly backslashes: 2421 2430 \begin{gsc}\begin{verbatim} 2422 <replace scope='text' macro="\ backslash\backslash?\backslash\backslash\backslash(" text="\backslash("/>2431 <replace scope='text' macro="\\?\\\(" text="\("/> 2423 2432 \end{verbatim}\end{gsc} 2424 2433 2425 2434 Macro resolving using resource bundles and metadata: 2426 2435 \begin{gsc}\begin{verbatim} 2427 <replace scope='metadata' macro="_magazines_" bundle="NZDLMacros" key="Magazines"/> 2436 <replace scope='metadata' macro="_magazines_" bundle="NZDLMacros" 2437 key="Magazines"/> 2428 2438 <replace scope='all' macro='_thisOID_' metadata='archivedir'/> 2429 <replace macro="_httpcollimg_" text="sites/localsite/collect/folktale/index/assoc"/> 2439 <replace macro="_httpcollimg_" 2440 text="sites/localsite/collect/folktale/index/assoc"/> 2430 2441 \end{verbatim}\end{gsc} 2431 2442 2432 2443 Fixing up broken external links: 2433 2444 \begin{gsc}\begin{verbatim} 2434 <replace macro="_httpextlink_&rl=1&href=" text="?a=d&c=folktale&s0.ext=1&d="/> 2435 <replace macro="_httpextlink_&rl=0&href=" text="?a=p&sa=html&c=folktale&url="/> 2436 </replaceList> 2445 <replace macro="_httpextlink_&rl=1&href=" 2446 text="?a=d&c=folktale&s0.ext=1&d="/> 2447 <replace macro="_httpextlink_&rl=0&href=" 2448 text="?a=p&sa=html&c=folktale&url="/> 2437 2449 \end{verbatim}\end{gsc} 2438 2450 … … 2442 2454 Sometimes we need to add in macros to be resolved in a second step: 2443 2455 \begin{gsc}\begin{verbatim} 2444 <replace macro="_iconpdf_" scope="metadata" text="<img border='0' height='26' width='26' alt='PDF' title='_texticonpdf_' src='interfaces/default/images/ipdf.gif'/>"/> 2445 <replace macro="_texticonpdf_" scope="metadata" bundle="interface_classic" key="texticonpdf"/> 2456 <replace macro="_iconpdf_" scope="metadata" 2457 text="<img title='_texticonpdf_' src='interfaces/default/images/ipdf.gif'/>"/> 2458 <replace macro="_texticonpdf_" scope="metadata" bundle="interface_classic" 2459 key="texticonpdf"/> 2446 2460 \end{verbatim}\end{gsc} 2447 2461
Note:
See TracChangeset
for help on using the changeset viewer.