doc/sru_z3950.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
   2     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
   3  <!ENTITY copyright SYSTEM "copyright.xml">
   4 ]>
   5 <!-- $Id: sru_z3950.xml,v 1.1 2006-10-12 11:31:11 marc Exp $ -->
   6 <refentry>
   7  <refmeta>
   8   <refentrytitle>sru_z3950</refentrytitle>
   9   <manvolnum>3mp</manvolnum>
  10   <refmiscinfo>Metaproxy Module</refmiscinfo>
  11  </refmeta>
  12
  13  <refnamediv>
  14   <refname>sru_z3950</refname>
  15   <refpurpose>transforming SRU webservice requests to Z3950 metaproxy packages</refpurpose>
  16  </refnamediv>
  17
  18  <refsect1><title>DESCRIPTION</title>
  19   <para>
  20    The <literal>sru_z3950</literal> metaproxy filter transforms valid
  21    SRU/GET or SRU/SOAP requests to Z3950 requests, and wraps the
  22    recieved hit counts and XML records into suitable SRU response messages.
  23   </para>
  24   <para>
  25    It supports only the SRU <literal>searchRetrieve</literal> operation, which
  26    is transformed into successive Z3950 <literal>init</literal>,
  27    <literal>search</literal> and <literal>present</literal> requests.
  28   </para>
  29   <para>
  30    The SRU <literal>scan</literal> operation is not supported.
  31    </para>
  32   <para>
  33    The SRU <literal>explain</literal> operation is not supported.
  34    A configuration for a full SRU server needs to prepend the
  35    <literal>zeerex_explain</literal> filter in front of this
  36    <literal>sru_z3950</literal> to serve explain requests. This filter
  37    still needs to be implemented.
  38    </para>
  39   <para>
  40    This filter does not handle CQL-to-PQF translations. In case that
  41    the backends do not understand CQL, you need to prepend the
  42    <literal>cql_pqf</literal> metaproxy filter. This filter
  43    still needs to be implemented.
  44    </para>
  45  </refsect1>
  46
  47  <refsect1><title>EXAMPLES</title>
  48   <para>
  49    A typical configuration looks like this:
  50    <screen><![CDATA[
  51     <filter type="sru_z3950"/>
  52 ]]>
  53    </screen>
  54   </para>
  55  </refsect1>
  56
  57  <refsect1><title>SEE ALSO</title>
  58   <para>
  59    <citerefentry>
  60     <refentrytitle>metaproxy</refentrytitle>
  61     <manvolnum>1</manvolnum>
  62    </citerefentry>
  63   </para>
  64  </refsect1>
  65
  66  &copyright;
  67 </refentry>
  68
  69 <!-- Keep this comment at the end of the file
  70 Local variables:
  71 mode: sgml
  72 sgml-omittag:t
  73 sgml-shorttag:t
  74 sgml-minimize-attributes:nil
  75 sgml-always-quote-attributes:t
  76 sgml-indent-step:1
  77 sgml-indent-data:t
  78 sgml-parent-document:nil
  79 sgml-local-catalogs: nil
  80 sgml-namecase-general:t
  81 End:
  82 -->