From 5753479ffa8e178463d65fb549f405dd71baa9bd Mon Sep 17 00:00:00 2001 From: Marc Cromme Date: Mon, 8 Jan 2007 12:27:27 +0000 Subject: [PATCH] updates zeerex_explain and sru_z3950 filter docs to reflect the move of SRU explain functionality to the later --- doc/book.xml | 45 +++++++++++++++++++++++++------------------ doc/sru_z3950.xml | 50 ++++++++++++++++++++++++++++++++++++------------ doc/zeerex_explain.xml | 21 ++++++-------------- 3 files changed, 70 insertions(+), 46 deletions(-) diff --git a/doc/book.xml b/doc/book.xml index a191019..4a95995 100644 --- a/doc/book.xml +++ b/doc/book.xml @@ -17,7 +17,7 @@ --> ]> - + Metaproxy - User's Guide and Reference @@ -778,6 +778,12 @@ Figure out what additional information we need in: load_balance filter is assuming that all backend targets have equal content, and chooses the backend with least load cost for a new session. + + + This filter is experimental and yet not mature for heavy load + production sites. + + @@ -857,12 +863,16 @@ Figure out what additional information we need in: and present requests, and wraps the received hit counts and XML records into suitable SRU response messages. - The sru_z3950 filter does only process SRU - GET/POST/SOAP explain requests in a very crude fashion, returning - the absolute minimum required by the standard. Full ZeeReX - explain support is added by including the - zeerex_explain filter before the - sru_z3950 filter. + The sru_z3950 filter processes also SRU + GET/POST/SOAP explain requests, returning + either the absolute minimum required by the standard, or a full + pre-defined ZeeReX explain record. + See the + ZeeReX Explain + standard pages and the + SRU Explain pages + for more information on the correct explain syntax. + SRU scan requests are not supported yet. @@ -917,17 +927,19 @@ Figure out what additional information we need in: (mp::filter::ZeerexExplain) This filter acts as a sink for - SRU GET/POST/SOAP explain requests, returning a static ZeeReX + Z39.50 explain requests, returning a static ZeeReX Explain XML record from the config section. All other packages - are passed through, including SRU GET/POST/SOAP searchRetrieve - requests, which are handled by a following - sru_z3950 filter. + are passed through. See the ZeeReX Explain - standard pages and the - SRU Explain pages + standard pages for more information on the correct explain syntax. + + + This filter is not yet completed. + + @@ -983,17 +995,12 @@ Figure out what additional information we need in: If Metaproxy is an interpreter providing operations on packages, then its configuration file can be thought of as a program for that - interpreter. Configuration is by means of a single file, the name + interpreter. Configuration is by means of a single XML file, the name of which is supplied as the sole command-line argument to the metaproxy program. (See the reference guide below for more information on invoking Metaproxy.) - - The configuration files are written in XML. (But that's just an - implementation detail - they could just as well have been written - in YAML or Lisp-like S-expressions, or in a custom syntax.) -
diff --git a/doc/sru_z3950.xml b/doc/sru_z3950.xml index 16cf570..37d7e60 100644 --- a/doc/sru_z3950.xml +++ b/doc/sru_z3950.xml @@ -1,8 +1,10 @@ + + %common; ]> - + sru_z3950 @@ -12,17 +14,39 @@ sru_z3950 - transforming SRU web service requests to Z3950 metaproxy packages + transforming SRU web service requests to Z3950 Metaproxy packages DESCRIPTION - The sru_z3950 metaproxy filter transforms valid + The sru_z3950 Metaproxy filter transforms valid SRU GET/POST/SOAP requests to Z3950 requests, and wraps the received hit counts and XML records into suitable SRU response messages. - It supports only the SRU searchRetrieve operation, which + Multiple database elements defining the names of the accepted + databases are allowed in the configuration file. Each + of them must contain their own explain record, or must be empty. + Notice that explain + records come in SRU and Z39.50 flavors, and this filter requires + the SRU version. See the + ZeeReX Explain + standard pages and the + SRU Explain pages + for more information. + + + All Z39.50 packages and all HTTP packages that do not resolve to + one configured database name are passed unaltered to the next + filters on the route. + + + The SRU explain operation is supported, + returning either the absolute minimum required by the standard, or + a full pre-defined ZeeReX explain record. + + + It supports the SRU searchRetrieve operation, which is transformed into successive Z3950 init, search and present requests. @@ -30,14 +54,8 @@ The SRU scan operation is not supported. - The SRU explain operation is not supported. - A configuration for a full SRU server needs to prepend the - zeerex_explain filter in front of this - sru_z3950 to serve explain requests. - - This filter does not handle CQL-to-PQF translations. In case that - the backends do not understand CQL, you need to prepend the + the backends do not understand CQL, you need to append the cql_pqf metaproxy filter. This filter still needs to be implemented. @@ -47,7 +65,15 @@ A typical configuration looks like this: + + + + ... + + + + + ]]> diff --git a/doc/zeerex_explain.xml b/doc/zeerex_explain.xml index 58ea172..b4b3552 100644 --- a/doc/zeerex_explain.xml +++ b/doc/zeerex_explain.xml @@ -4,7 +4,7 @@ %common; ]> - + zeerex_explain @@ -14,13 +14,13 @@ zeerex_explain - answering SRU web service explain requests + answering Z39.50 ZeeReX explain requests DESCRIPTION - The zeerex_explain metaproxy filter - answers valid SRU GET/POST/SOAP explain requests, returning a + The zeerex_explain Metaproxy filter + answers valid Z30.50 explain requests, returning a static ZeeReX Explain XML record from the config section. All other packages are passed through. @@ -28,19 +28,13 @@ Multiple database elements defining the names of the accepted databases are allowed in the configuration file. Each of them must contain their own explain record. Notice that explain - records come in SRU and Z3950 flavours, and this filter requires - the SRU version. See the + records come in SRU and Z39.50 flavours, and this filter requires + the Z39.50 version. See the ZeeReX Explain standard pages and the SRU Explain pages for more information. - - A configuration for a full SRU server needs to line up a - zeerex_explain filter, a - cql_pqf (not implemented yet) filter, and a - sru_z3950 after each other. - EXAMPLES @@ -69,9 +63,6 @@ ZeeReX Explain - - SRU Explain - ©right; -- 1.7.10.4