added documentation for the sru_z3950 filter

[metaproxy-moved-to-github.git] / doc / sru_z3950.xml

diff --git a/doc/sru_z3950.xml b/doc/sru_z3950.xml
new file mode 100644 (file)
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:
+-->