From 3953421488cf82acb6553f51a049e82892c0277a Mon Sep 17 00:00:00 2001 From: Marc Cromme Date: Thu, 12 Oct 2006 11:52:24 +0000 Subject: [PATCH] removed Mike's brain-dead statements about C++ and LaTeX fixed typo's --- doc/book.xml | 58 ++++++++++++++++++++++++++-------------------------------- 1 file changed, 26 insertions(+), 32 deletions(-) diff --git a/doc/book.xml b/doc/book.xml index 03e08cf..2c96f95 100644 --- a/doc/book.xml +++ b/doc/book.xml @@ -17,7 +17,7 @@ --> ]> - + Metaproxy - User's Guide and Reference @@ -79,7 +79,7 @@ Metaproxy - is a standalone program that acts as a universal router, proxy and + is a stand alone program that acts as a universal router, proxy and encapsulated metasearcher for information retrieval protocols such as Z39.50, and in the future SRU and SRW. @@ -107,7 +107,7 @@ being more powerful, flexible, configurable and extensible. Among its many advantages over the older, more pedestrian work are support for multiplexing (encapsulated metasearching), routing by - database name, authentication and authorisation and serving local + database name, authentication and authorization and serving local files via HTTP. Equally significant, its modular architecture facilitites the creation of pluggable modules implementing further functionality. @@ -221,7 +221,7 @@ for more information. - We have succesfully built Metaproxy using the compilers + We have successfully built Metaproxy using the compilers GCC version 4.0 and Microsoft Visual Studio 2003/2005. @@ -378,7 +378,7 @@ \boost\lib, \boost\include. - For more informatation about installing Boost refer to the + For more information about installing Boost refer to the getting started pages. @@ -392,7 +392,7 @@ here. - Libxslt has other dependencies, but thes can all be downloaded + Libxslt has other dependencies, but these can all be downloaded from the same site. Get the following: iconv, zlib, libxml2, libxslt. @@ -424,7 +424,7 @@
Metaproxy - Metaproxy is shipped with NMAKE makfiles as well - similar + Metaproxy is shipped with NMAKE makefiles as well - similar to those found in the YAZ++/YAZ packages. Adjust this Makefile to point to the proper locations of Boost, Libxslt, Libxml2, zlib, iconv, yaz and yazpp. @@ -482,7 +482,7 @@ - After succesful compilation you'll find + After successful compilation you'll find metaproxy.exe in the bin directory. @@ -519,7 +519,7 @@ In general, packages are doctored as they pass through Metaproxy. For example, when the proxy performs authentication - and authorisation on a Z39.50 Init request, it removes the + and authorization on a Z39.50 Init request, it removes the authentication credentials from the package so that they are not passed onto the back-end server; and when search-response packages are obtained from multiple servers, they are merged @@ -651,7 +651,7 @@ We now briefly consider each of the types of filter supported by the core Metaproxy binary. This overview is intended to give a - flavour of the available functionality; more detailed information + flavor of the available functionality; more detailed information about each type of filter is included below in the reference guide to Metaproxy filters. @@ -696,7 +696,7 @@ Figure out what additional information we need in: <literal>auth_simple</literal> (mp::filter::AuthSimple) - Simple authentication and authorisation. The configuration + Simple authentication and authorization. The configuration specifies the name of a file that is the user register, which lists username:password pairs, one per line, colon separated. When a session begins, it @@ -747,7 +747,7 @@ Figure out what additional information we need in: A source that accepts Z39.50 connections from a port specified in the configuration, reads protocol units, and feeds them into the next filter in the route. When the result is - revceived, it is returned to the original origin. + received, it is returned to the original origin.
@@ -809,9 +809,9 @@ Figure out what additional information we need in: This filter acts only on Z3950 present requests, and let all other types of packages and requests pass untouched. It's use is twofold: blocking Z3950 present requests, which the backend - server does not understand and can not honour, and transforming + server does not understand and can not honor, and transforming the present syntax and elementset name according to the rules - specified, to fetch only exisitng record formats, and transform + specified, to fetch only existing record formats, and transform them on the fly to requested record syntaxes. @@ -840,7 +840,7 @@ Figure out what additional information we need in: This filter transforms valid SRU/GET or SRU/SOAP requests to Z3950 requests, and wraps the - recieved hit counts and XML records into suitable SRU response messages. + received hit counts and XML records into suitable SRU response messages. @@ -1084,7 +1084,7 @@ Figure out what additional information we need in: z3950_client filter, with the response data filled by the external Z39.50 server targeted. All non-Z39.50 packages are passed through to the - bounce filter, which defitely bounces + bounce filter, which definitely bounces everything, including fish, bananas, cold pyjamas, mutton, beef and trout packages. When the response arrives, it is handed @@ -1098,7 +1098,7 @@ Figure out what additional information we need in: The distribution contains RelaxNG Compact and XML syntax checking files, as well as XML Schema files. These are found in the - distribution pathes + distribution paths xml/schema/metaproxy.rnc xml/schema/metaproxy.rng @@ -1141,14 +1141,14 @@ Figure out what additional information we need in: The interaction between these two filters is necessarily complex: it reflects the real, irreducible complexity of multi-database searching in a protocol such - as Z39.50 that separates initialisation from searching, and in - which the database to be searched is not known at initialisation + as Z39.50 that separates initialization from searching, and in + which the database to be searched is not known at initialization time. It's possible to use these filters without understanding the details of their functioning and the interaction between them; the - next two sections of this chapter are ``HOWTO'' guides for doing + next two sections of this chapter are ``HOW-TO'' guides for doing just that. However, debugging complex configurations will require a deeper understanding, which the last two sections of this chapters attempt to provide. @@ -1345,7 +1345,7 @@ Z> can be inconvenient in deployment, when users typically don't want to be bothered with problems of this kind and prefer just to get the records from the databases that are available. To obtain this - latter behaviour add an empty + latter behavior add an empty <hideunavailable> element inside the multi filter: @@ -1480,9 +1480,8 @@ Z> [Here there should be a diagram showing the progress of packages through the filters during a simple virtual-database search and a multi-database search, but is seems that your - toolchain has not been able to include the diagram in this - document. This is because of LaTeX suckage. Time to move to - OpenOffice. Yes, really.] + tool chain has not been able to include the diagram in this + document.]