From: Marc Cromme <marc@indexdata.dk>
Date: Thu, 12 Oct 2006 11:31:11 +0000 (+0000)
Subject: added documentation for the sru_z3950 filter
X-Git-Tag: METAPROXY.1.0.7~16
X-Git-Url: http://git.indexdata.com/?a=commitdiff_plain;h=3c218907e35bbed20a7fb3d70b55468ab6d81234;p=metaproxy-moved-to-github.git

added documentation for the sru_z3950 filter
---

diff --git a/doc/Makefile.am b/doc/Makefile.am
index fb7e7ce..73d3934 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,4 +1,4 @@
-## $Id: Makefile.am,v 1.30 2006-10-12 08:27:35 marc Exp $
+## $Id: Makefile.am,v 1.31 2006-10-12 11:31:11 marc Exp $
 #docdir=$(datadir)/doc/@PACKAGE@
 
 SUBDIRS = common
@@ -14,12 +14,14 @@ XMLMAN = metaproxy.xml \
 	frontend_net.xml \
 	http_file.xml log.xml multi.xml query_rewrite.xml \
         record_transform.xml\
+        sru_z3950.xml\
 	session_shared.xml template.xml virt_db.xml z3950_client.xml
 
 MANFILES = auth_simple.3mp backend_test.3mp  bounce.3mp \
         frontend_net.3mp \
 	http_file.3mp log.3mp multi.3mp query_rewrite.3mp \
         record_transform.3mp\
+        sru_z3950.xml\
 	session_shared.3mp template.3mp virt_db.3mp z3950_client.3mp \
 	metaproxy.1
 
diff --git a/doc/book.xml b/doc/book.xml
index 099a0ba..e37ac3d 100644
--- a/doc/book.xml
+++ b/doc/book.xml
@@ -17,7 +17,7 @@
      -->
      <!NOTATION PDF SYSTEM "PDF">
 ]>
-<!-- $Id: book.xml,v 1.39 2006-10-12 08:27:35 marc Exp $ -->
+<!-- $Id: book.xml,v 1.40 2006-10-12 11:31:11 marc Exp $ -->
 <book id="metaproxy">
  <bookinfo>
   <title>Metaproxy - User's Guide and Reference</title>
@@ -639,6 +639,7 @@
     <literal>query_rewrite</literal>,
     <literal>record_transform</literal>,
     <literal>session_shared</literal>,
+    <literal>sru_z3950</literal>,
     <literal>template</literal>,
     <literal>virt_db</literal>).
    </para>
@@ -816,6 +817,16 @@ Figure out what additional information we need in:
    </section>
 
    <section>
+    <title><literal>sru_z3950</literal>
+    (mp::filter::SRUtoZ3950)</title>
+    <para>
+     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.
+    </para>
+   </section>
+
+   <section>
     <title><literal>session_shared</literal>
      (mp::filter::SessionShared)</title>
     <para>
diff --git a/doc/sru_z3950.xml b/doc/sru_z3950.xml
new file mode 100644
index 0000000..dbe6581
--- /dev/null
+++ b/doc/sru_z3950.xml
@@ -0,0 +1,82 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" 
+    "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
+ <!ENTITY copyright SYSTEM "copyright.xml">
+]>
+<!-- $Id: sru_z3950.xml,v 1.1 2006-10-12 11:31:11 marc Exp $ -->
+<refentry>
+ <refmeta>
+  <refentrytitle>sru_z3950</refentrytitle>
+  <manvolnum>3mp</manvolnum>
+  <refmiscinfo>Metaproxy Module</refmiscinfo>
+ </refmeta>
+ 
+ <refnamediv>
+  <refname>sru_z3950</refname>
+  <refpurpose>transforming SRU webservice requests to Z3950 metaproxy packages</refpurpose>
+ </refnamediv>
+ 
+ <refsect1><title>DESCRIPTION</title>
+  <para>
+   The <literal>sru_z3950</literal> metaproxy 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. 
+  </para>
+  <para>
+   It supports only the SRU <literal>searchRetrieve</literal> operation, which
+   is transformed into successive Z3950 <literal>init</literal>, 
+   <literal>search</literal> and <literal>present</literal> requests. 
+  </para>
+  <para>
+   The SRU <literal>scan</literal> operation is not supported.
+   </para>
+  <para>
+   The SRU <literal>explain</literal> operation is not supported. 
+   A configuration for a full SRU server needs to prepend the 
+   <literal>zeerex_explain</literal> filter in front of this 
+   <literal>sru_z3950</literal> to serve explain requests. This filter
+   still needs to be implemented.
+   </para>
+  <para>
+   This filter does not handle CQL-to-PQF translations. In case that
+   the backends do not understand CQL, you need to prepend the
+   <literal>cql_pqf</literal> metaproxy filter. This filter
+   still needs to be implemented.
+   </para>
+ </refsect1>
+
+ <refsect1><title>EXAMPLES</title>
+  <para>
+   A typical configuration looks like this:
+   <screen><![CDATA[
+    <filter type="sru_z3950"/>
+]]>
+   </screen>
+  </para>
+ </refsect1> 
+ 
+ <refsect1><title>SEE ALSO</title>
+  <para>
+   <citerefentry>
+    <refentrytitle>metaproxy</refentrytitle>
+    <manvolnum>1</manvolnum>
+   </citerefentry>
+  </para>
+ </refsect1>
+ 
+ &copyright;
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
+End:
+-->