From e5901333c8011101505ee1a283df326663637a7e Mon Sep 17 00:00:00 2001 From: Marc Cromme Date: Fri, 5 Jan 2007 10:56:17 +0000 Subject: [PATCH] added documentation on zeerex_explain filter --- doc/Makefile.am | 30 +++++++++++----- doc/book.xml | 67 ++++++++++++++++++++++++---------- doc/copyright.xml | 4 +-- doc/sru_z3950.xml | 7 ++-- doc/zeerex_explain.xml | 93 ++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 168 insertions(+), 33 deletions(-) create mode 100644 doc/zeerex_explain.xml diff --git a/doc/Makefile.am b/doc/Makefile.am index 67b7226..e0eadb3 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -## $Id: Makefile.am,v 1.33 2007-01-03 15:34:50 marc Exp $ +## $Id: Makefile.am,v 1.34 2007-01-05 10:56:17 marc Exp $ docdir=$(datadir)/doc/@PACKAGE@ SUBDIRS = common @@ -10,26 +10,40 @@ XMLFILES = book.xml manref.xml copyright.xml MAINXML = $(srcdir)/book.xml XMLMAN = metaproxy.xml \ - auth_simple.xml backend_test.xml bounce.xml \ + auth_simple.xml \ + backend_test.xml \ + bounce.xml \ frontend_net.xml \ http_file.xml \ load_balance.xml \ log.xml \ - multi.xml query_rewrite.xml \ + multi.xml \ + query_rewrite.xml \ record_transform.xml\ + session_shared.xml \ sru_z3950.xml\ - session_shared.xml template.xml virt_db.xml z3950_client.xml - -MANFILES = auth_simple.3mp backend_test.3mp bounce.3mp \ + template.xml \ + virt_db.xml \ + z3950_client.xml \ + zeerex_explain.xml + +MANFILES = metaproxy.1 \ + auth_simple.3mp \ + backend_test.3mp \ + bounce.3mp \ frontend_net.3mp \ http_file.3mp \ load_balance.3mp \ log.3mp \ multi.3mp query_rewrite.3mp \ record_transform.3mp\ + session_shared.3mp \ sru_z3950.xml\ - session_shared.3mp template.3mp virt_db.3mp z3950_client.3mp \ - metaproxy.1 + template.3mp \ + virt_db.3mp \ + z3950_client.3mp \ + zeerex_explain.3mp + HTMLFILES = index.html diff --git a/doc/book.xml b/doc/book.xml index 430b27b..a191019 100644 --- a/doc/book.xml +++ b/doc/book.xml @@ -17,7 +17,7 @@ --> ]> - + Metaproxy - User's Guide and Reference @@ -31,7 +31,7 @@ MikeTaylor - 2006 + 2005-2007 Index Data ApS @@ -155,7 +155,7 @@ You may modify your copy of the software (fix bugs, add features) if you need to. We encourage you to send your changes back to us for integration into the master copy, but you are not obliged to do so. You - may NOT pass your changes on to any other party. + may NOT pass your changes on to any other party. @@ -627,10 +627,10 @@ packages (frontend_net); others are sinks: they consume packages and return a result - (z3950_client, - backend_test, + (backend_test, bounce, - http_file); + http_file, + z3950_client); the others are true filters, that read, process and pass on the packages they are fed (auth_simple, @@ -768,16 +768,6 @@ Figure out what additional information we need in:
- <literal>log</literal> - (mp::filter::Log) - - Writes logging information to standard output, and passes on - the package unchanged. A log file name can be specified, as well - as multiple different logging formats. - -
- -
<literal>load_balance</literal> (mp::filter::LoadBalance) @@ -790,7 +780,17 @@ Figure out what additional information we need in: with least load cost for a new session.
- + +
+ <literal>log</literal> + (mp::filter::Log) + + Writes logging information to standard output, and passes on + the package unchanged. A log file name can be specified, as well + as multiple different logging formats. + +
+
<literal>multi</literal> (mp::filter::Multi) @@ -853,8 +853,16 @@ Figure out what additional information we need in: (mp::filter::SRUtoZ3950) This filter transforms valid - SRU/GET or SRU/SOAP requests to Z3950 requests, and wraps the - received hit counts and XML records into suitable SRU response messages. + SRU GET/POST/SOAP searchRetrieve requests to Z3950 init, search, + 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.
@@ -902,6 +910,27 @@ Figure out what additional information we need in: are passed untouched. + + +
+ <literal>zeerex_explain</literal> + (mp::filter::ZeerexExplain) + + This filter acts as a sink for + SRU GET/POST/SOAP 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. + See the + ZeeReX Explain + standard pages and the + SRU Explain pages + for more information on the correct explain syntax. + +
+ + diff --git a/doc/copyright.xml b/doc/copyright.xml index a006371..c89779f 100644 --- a/doc/copyright.xml +++ b/doc/copyright.xml @@ -1,6 +1,6 @@ - + COPYRIGHT - Copyright (c) 2005-2006, Index Data ApS + Copyright (c) 2005-2007, Index Data ApS diff --git a/doc/sru_z3950.xml b/doc/sru_z3950.xml index 8c23ff1..16cf570 100644 --- a/doc/sru_z3950.xml +++ b/doc/sru_z3950.xml @@ -2,7 +2,7 @@ "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [ ]> - + sru_z3950 @@ -18,7 +18,7 @@ DESCRIPTION The sru_z3950 metaproxy filter transforms valid - SRU/GET or SRU/SOAP requests to Z3950 requests, and wraps the + SRU GET/POST/SOAP requests to Z3950 requests, and wraps the received hit counts and XML records into suitable SRU response messages. @@ -33,8 +33,7 @@ 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 - still needs to be implemented. + sru_z3950 to serve explain requests. This filter does not handle CQL-to-PQF translations. In case that diff --git a/doc/zeerex_explain.xml b/doc/zeerex_explain.xml new file mode 100644 index 0000000..58ea172 --- /dev/null +++ b/doc/zeerex_explain.xml @@ -0,0 +1,93 @@ + + + %common; +]> + + + + zeerex_explain + 3mp + Metaproxy Module + + + + zeerex_explain + answering SRU web service explain requests + + + DESCRIPTION + + The zeerex_explain metaproxy filter + answers valid SRU GET/POST/SOAP explain requests, returning a + static ZeeReX Explain XML record from the config section. All other + packages are passed through. + + + 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 + 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 + + A typical configuration looks like this: + + + + ... + + + +]]> + + + + + SEE ALSO + + + metaproxy + 1 + + + + ZeeReX Explain + + + SRU Explain + + + + ©right; + + + -- 1.7.10.4