Changeset 16878

Show
Ignore:
Timestamp:
18.08.2008 12:49:24 (11 years ago)
Author:
kjdon
Message:

got rid of NZDLReceptionist, changed NZDLParams to GS2Params, updated manual accordingly

Location:
greenstone3/trunk/docs/manual
Files:
2 modified

Legend:

Unmodified
Added
Removed
  • greenstone3/trunk/docs/manual/manual.tex

    r16865 r16878  
    217217remote\_site\_address & http://www.greenstone.org/ greenstone3/services/ localsite & The address of the server \\ 
    218218default\_lang & en & the default language for the interface\\ 
    219 receptionist\_class & NZDLReceptionist & (optional) specifies an alternative Receptionist to use\\ 
    220 messagerouter\_class & NewMessageRouter & (optional) specifies an alternative MessageRouter to use\\ 
    221 params\_class & NZDLParams & (optional) specifies an alternative GSParams class to use \\ 
     219receptionist\_class & MyReceptionist & (optional) specifies an alternative Receptionist to use (default is DefaultReceptionist)\\ 
     220messagerouter\_class & NewMessageRouter & (optional) specifies an alternative MessageRouter to use (default is MessageRouter)\\ 
     221params\_class & GS2Params & (optional) specifies an alternative GSParams class to use \\ 
    222222\hline 
    223223\end{tabular}} 
     
    18811881DefaultReceptionist: This extends WebReceptionist, and is the default one for \gsiii\  servlets. Due to the page design, some extra information is needed for each page: some metadata about the current collection. The receptionist sends a describe request to the collection to get this, and appends it to the page before transformation using XSLT. 
    18821882 
    1883 NZDLReceptionist: (do we want to talk about this?) This is an example of a custom receptionist. For a look-alike nzdl.org system, even more information is needed for each page, namely the list of classifiers available from the ClassifierBrowse service.  
    1884  
    18851883By default, the LibraryServlet uses DefaultReceptionist. However, there is a servlet init-param called \gst{receptionist} which can be set to make the servlet use a different one. 
    18861884 
     
    21402138In many cases, creating a new interface just requires the new images and XSLT  to be added to the new directory(see Sections~\ref{sec:sites-and-ints} and \ref{sec:interface-customise}). This gs2 interface required a bit more customization. 
    21412139 
    2142 The standard \gsiii\  navigation bar lists all the services available for the collection. In \gsii\ , the navigation bar provides the search option, and the different classifiers. This is not service specific, but hard coded to the search and classifiers. The XSLT that produces the navigation bar needed to be altered to produce this. But also, a new Receptionist was needed.  
    2143 The standard receptionist (DefaultReceptionist) gathers a little bit of extra information for each page of XML before transforming it: this is the list of services for the collection and their display information, allowing the services to be listed along the navigation bar. This is information that is needed by every page (except for the library home page) and therefore is obtained by the receptionist instead of by each action. The nzdl interface needed a bit more information than this: for the ClassifierBrowse service, if there was one, the list of classifiers and their display elements must be obtained. So a new Receptionist (NZDLReceptionist) was written that inherited from DefaultReceptionist, and added this new info into the page. 
    2144  
    2145 One of the servlet initialization parameters is the receptionist class: this was added to the servlet definition in the web.xml file so that the LibraryServlet would load up the right receptionist class. 
    2146  
     2140The standard \gsiii\  navigation bar lists all the services available for the collection. In \gsii\ , the navigation bar provides the search option, and the different classifiers. This is not service specific, but hard coded to the search and classifiers. The XSLT that produces the navigation bar needed to be altered to produce this.  
     2141The standard receptionist (DefaultReceptionist) gathers a little bit of extra information for each page of XML before transforming it: this is the list of services for the collection and their display information, allowing the services to be listed along the navigation bar. This is information that is needed by every page (except for the library home page) and therefore is obtained by the receptionist instead of by each action. The nzdl interface uses the classifier list that comes in the ClassifierBrowse service description to display teh list of classifiers.  
     2142 
     2143The nzdl interface extends the gs2 interface to provide a different looking home page and an extra static 'gsdl' page. 
    21472144 
    21482145\newpage