doc/zeerex_explain.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
   2     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
   3  <!ENTITY copyright SYSTEM "copyright.xml">
   4  <!ENTITY % idcommon SYSTEM "common/common.ent">
   5      %idcommon;
   6 ]>
   7 <refentry id="ref-zeerex_explain">
   8  <refmeta>
   9   <refentrytitle>zeerex_explain</refentrytitle>
  10   <manvolnum>3mp</manvolnum>
  11   <refmiscinfo>Metaproxy Module</refmiscinfo>
  12  </refmeta>
  13
  14  <refnamediv>
  15   <refname>zeerex_explain</refname>
  16   <refpurpose>Metaproxy Z39.50 ZeeReX Explain Module</refpurpose>
  17  </refnamediv>
  18
  19  <refsect1><title>DESCRIPTION</title>
  20   <para>
  21    The <literal>zeerex_explain</literal> Metaproxy filter
  22    answers valid Z30.50 explain requests, returning a
  23    static ZeeReX Explain XML record from the config section. All other
  24    packages are passed through.
  25   </para>
  26   <para>
  27    Multiple database elements defining the names of the accepted
  28    databases are allowed in the configuration file. Each
  29    of them must contain their own explain record. Notice that explain
  30    records come in SRU and Z39.50 flavours, and this filter requires
  31    the Z39.50 version. See the
  32    <ulink url="&url.zeerex.explain;">ZeeReX Explain</ulink>
  33    standard pages and the
  34    <ulink url="&url.sru.explain;">SRU Explain</ulink> pages
  35    for more information.
  36   </para>
  37     <warning>
  38      <para>
  39       This filter is not yet completed.
  40      </para>
  41     </warning>
  42  </refsect1>
  43
  44  <refsect1><title>EXAMPLES</title>
  45   <para>
  46    A typical configuration looks like this:
  47    <screen><![CDATA[
  48     <filter type="zeerex_explain">
  49       <database name="Default">
  50         <explain xmlns="http://explain.z3950.org/dtd/2.0/">
  51           ...
  52         </explain>
  53       </database>
  54     </filter>
  55 ]]>
  56    </screen>
  57   </para>
  58  </refsect1>
  59
  60  <refsect1><title>SEE ALSO</title>
  61   <para>
  62    <citerefentry>
  63     <refentrytitle>metaproxy</refentrytitle>
  64     <manvolnum>1</manvolnum>
  65    </citerefentry>
  66   </para>
  67   <para>
  68    <ulink url="&url.zeerex.explain;">ZeeReX Explain</ulink>
  69   </para>
  70  </refsect1>
  71
  72  &copyright;
  73 </refentry>
  74
  75 <!-- Keep this comment at the end of the file
  76 Local variables:
  77 mode: sgml
  78 sgml-omittag:t
  79 sgml-shorttag:t
  80 sgml-minimize-attributes:nil
  81 sgml-always-quote-attributes:t
  82 sgml-indent-step:1
  83 sgml-indent-data:t
  84 sgml-parent-document:nil
  85 sgml-local-catalogs: nil
  86 sgml-namecase-general:t
  87 End:
  88 -->