Changeset 13281 for trunk

Timestamp:

2006-11-16T11:56:51+13:00 (18 years ago)

Author:

kjdon

Message:

some changes - not sure what they are

File:

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

trunk/gsdl3/docs/manual/manual.tex

@@ -208 +208 @@
 \bf name & \bf sample value & \bf description \\
 \hline
-site\_name & localsite & the name of the site to use \\
+library\_name & library & the web name of the servlet \\
 interface\_name & default & the name of the interface to use\\
-library\_name & library & the web name of the servlet \\
+site\_name & localsite & the name of the site to use (use either site\_name or the three remote\_site parameters)\\
+remote\_site\_name & org.greenstone.site1 & the name of a remote site (can be anything??) \\
+remote\_site\_type & soap & the type of server running on the site \\
+remote\_site\_address & http://www.greenstone.org/greenstone3/services/localsite & The address of the server \\
 default\_lang & en & the default language for the interface\\
 receptionist\_class & NZDLReceptionist & (optional) specifies an alternative Receptionist to use\\
@@ -974 +977 @@
 
 Note that you cannot include a file with the same name as the including file. For example query.xsl cannot include query.xsl (it is tempting to want to do this if you just want to change one template for a particular file, and then include the default. but you cant).
+
+You can add the argument o=xml to any URL and you wil be returned the XML before transformation by a stylesheet. This shows you the XML page source. It can be useful when you are trying to write some new XSLT statements.
 
 \subsubsection{Defining a new interface}
@@ -1909 +1914 @@
 and a list of services.
 
+To get an external html page embedded into a greenstone collection, i.e. a two frame page, with the top frame containing the collection header and navigation bar, and the second frame containg the external page, use subaction html.
+A url would look like
+a=p\&sa=html\&c=collname\&url=externalurl
 
 \subsubsection{Query action}\label{sec:queryaction}
@@ -2174 +2182 @@
 The ant target deploys the service for the site specified. A resource file (\gst{<sitename>.wsdd}) is created which is used to specify the service. It can be found in \gst{greenstone3/resources/soap}, and is generated from \gst{site.wsdd.template}.
 
-To get siteA to talk to siteB, you need to deploy a SOAP server on siteB, then add a \gst{<site>} element to the \gst{<siteList>} of siteA's \gst{siteConfig.xml} file (in \gst{greenstone3/web/sites/siteA/siteConfig.xml}).
+The address of the new SOAP service will be tomcatserver-address/greenstone3/services/sitename, for example, www.greenstone.org/greenstone3/services/localsite.
+
+\subsection{Connecting to a site web service}
+
+There are two ways to use a remote site. First, if you have a local site running, then the site can also connect to other remote sites. In the siteConfig.xml file, you need to add a site element into the siteList element.
+
+For example, to get siteA to talk to siteB, you need to deploy a SOAP server on siteB, then add a \gst{<site>} element to the \gst{<siteList>} of siteA's \gst{siteConfig.xml} file (in \gst{greenstone3/web/sites/siteA/siteConfig.xml}).
 
 In the \gst{<siteList>} element, add the following (substituting the chosen site uri for siteBuri):
@@ -2184 +2198 @@
 \end{verbatim}\end{gsc}
 
-(Note that localhost and 8080 should be changed to the values you entered when installing \gsiii).
-
-The servlet for siteA needs to be reconfigured \\
-(e.g. \gst{http://localhost:8080/greenstone3/library?a=s\&sa=c}).
+(Note that localhost and 8080 should be changed to the values you entered when installing \gsiii. Localhost will only work for servers on the smae machine.).
+
+If you have changed the siteConfig.xml file for a site that is running, it will need to be reconfigured. Either restart Tomcat, or reconfigure through a URL:
+e.g. \gst{http://localhost:8080/greenstone3/library?a=s\&sa=c}.
+Several sites can be connected to in this manner.
+
+The second option is if you have a receptionist set up on a machine where you have no site, and you only want to connect to a single remote site. Instead of using site\_name in the servlet initialisation parameters (in greenstone3/web/WEB-INF/web.xml), you can specify remote\_site\_name, remote\_site\_type and remote\_site\_address. A communicator object will be set up instead of a MessageRouter and the receptionist will talk to the communicator.
+
 \appendix
 
@@ -2278 +2296 @@
 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/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.
+\gst{\$GSDL3HOME/packages/tomcat/work/Catalina/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}