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  <refentryinfo>
   9   <productname>Metaproxy</productname>
  10   <orgname>Index Data</orgname>
  11  </refentryinfo>
  12
  13  <refmeta>
  14   <refentrytitle>zeerex_explain</refentrytitle>
  15   <manvolnum>3mp</manvolnum>
  16   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
  17  </refmeta>
  18
  19  <refnamediv>
  20   <refname>zeerex_explain</refname>
  21   <refpurpose>Metaproxy Z39.50 ZeeReX Explain Module</refpurpose>
  22  </refnamediv>
  23
  24  <refsect1><title>DESCRIPTION</title>
  25   <para>
  26    The <literal>zeerex_explain</literal> Metaproxy filter
  27    answers valid Z30.50 explain requests, returning a
  28    static ZeeReX Explain XML record from the config section. All other
  29    packages are passed through.
  30   </para>
  31   <para>
  32    Multiple database elements defining the names of the accepted
  33    databases are allowed in the configuration file. Each
  34    of them must contain their own explain record. Notice that explain
  35    records come in SRU and Z39.50 flavours, and this filter requires
  36    the Z39.50 version. See the
  37    <ulink url="&url.zeerex.explain;">ZeeReX Explain</ulink>
  38    standard pages and the
  39    <ulink url="&url.sru.explain;">SRU Explain</ulink> pages
  40    for more information.
  41   </para>
  42     <warning>
  43      <para>
  44       This filter is not yet completed.
  45      </para>
  46     </warning>
  47  </refsect1>
  48
  49  <refsect1><title>EXAMPLES</title>
  50   <para>
  51    A typical configuration looks like this:
  52    <screen><![CDATA[
  53     <filter type="zeerex_explain">
  54       <database name="Default">
  55         <explain xmlns="http://explain.z3950.org/dtd/2.0/">
  56           ...
  57         </explain>
  58       </database>
  59     </filter>
  60 ]]>
  61    </screen>
  62   </para>
  63  </refsect1>
  64
  65  <refsect1><title>SEE ALSO</title>
  66   <para>
  67    <citerefentry>
  68     <refentrytitle>metaproxy</refentrytitle>
  69     <manvolnum>1</manvolnum>
  70    </citerefentry>
  71   </para>
  72   <para>
  73    <ulink url="&url.zeerex.explain;">ZeeReX 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: nxml
  83 nxml-child-indent: 1
  84 End:
  85 -->