doc/zeerex_explain.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  <!ENTITY % common SYSTEM "common/common.ent">
   5      %common;
   6 ]>
   7 <!-- $Id: zeerex_explain.xml,v 1.1 2007-01-05 10:56:17 marc Exp $ -->
   8 <refentry>
   9  <refmeta>
  10   <refentrytitle>zeerex_explain</refentrytitle>
  11   <manvolnum>3mp</manvolnum>
  12   <refmiscinfo>Metaproxy Module</refmiscinfo>
  13  </refmeta>
  14
  15  <refnamediv>
  16   <refname>zeerex_explain</refname>
  17   <refpurpose>answering SRU web service explain requests</refpurpose>
  18  </refnamediv>
  19
  20  <refsect1><title>DESCRIPTION</title>
  21   <para>
  22    The <literal>zeerex_explain</literal> metaproxy filter
  23    answers valid SRU GET/POST/SOAP explain requests, returning a
  24    static ZeeReX Explain XML record from the config section. All other
  25    packages are passed through.
  26   </para>
  27   <para>
  28    Multiple database elements defining the names of the accepted
  29    databases are allowed in the configuration file. Each
  30    of them must contain their own explain record. Notice that explain
  31    records come in SRU and Z3950 flavours, and this filter requires
  32    the SRU version. See the
  33    <ulink url="&url.zeerex.explain;">ZeeReX Explain</ulink>
  34    standard pages and the
  35    <ulink url="&url.sru.explain;">SRU Explain</ulink> pages
  36    for more information.
  37   </para>
  38   <para>
  39    A configuration for a full SRU server needs to line up a
  40    <literal>zeerex_explain</literal> filter, a
  41    <literal>cql_pqf</literal> (not implemented yet) filter, and a
  42    <literal>sru_z3950</literal> after each other.
  43    </para>
  44  </refsect1>
  45
  46  <refsect1><title>EXAMPLES</title>
  47   <para>
  48    A typical configuration looks like this:
  49    <screen><![CDATA[
  50     <filter type="zeerex_explain">
  51       <database name="Default">
  52         <explain xmlns="http://explain.z3950.org/dtd/2.0/">
  53           ...
  54         </explain>
  55       </database>
  56     </filter>
  57 ]]>
  58    </screen>
  59   </para>
  60  </refsect1>
  61
  62  <refsect1><title>SEE ALSO</title>
  63   <para>
  64    <citerefentry>
  65     <refentrytitle>metaproxy</refentrytitle>
  66     <manvolnum>1</manvolnum>
  67    </citerefentry>
  68   </para>
  69   <para>
  70    <ulink url="&url.zeerex.explain;">ZeeReX Explain</ulink>
  71   </para>
  72   <para>
  73    <ulink url="&url.sru.explain;">SRU Explain</ulink>
  74    </para>
  75  </refsect1>
  76
  77  &copyright;
  78 </refentry>
  79
  80 <!-- Keep this comment at the end of the file
  81 Local variables:
  82 mode: sgml
  83 sgml-omittag:t
  84 sgml-shorttag:t
  85 sgml-minimize-attributes:nil
  86 sgml-always-quote-attributes:t
  87 sgml-indent-step:1
  88 sgml-indent-data:t
  89 sgml-parent-document:nil
  90 sgml-local-catalogs: nil
  91 sgml-namecase-general:t
  92 End:
  93 -->