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.4 2007-05-09 21:23:08 adam Exp $ -->
   8 <refentry id="ref-zeerex_explain">
   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>Metaproxy Z39.50 ZeeReX Explain Module</refpurpose>
  18  </refnamediv>
  19
  20  <refsect1><title>DESCRIPTION</title>
  21   <para>
  22    The <literal>zeerex_explain</literal> Metaproxy filter
  23    answers valid Z30.50 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 Z39.50 flavours, and this filter requires
  32    the Z39.50 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     <warning>
  39      <para>
  40       This filter is not yet completed.
  41      </para>
  42     </warning>
  43  </refsect1>
  44
  45  <refsect1><title>EXAMPLES</title>
  46   <para>
  47    A typical configuration looks like this:
  48    <screen><![CDATA[
  49     <filter type="zeerex_explain">
  50       <database name="Default">
  51         <explain xmlns="http://explain.z3950.org/dtd/2.0/">
  52           ...
  53         </explain>
  54       </database>
  55     </filter>
  56 ]]>
  57    </screen>
  58   </para>
  59  </refsect1>
  60
  61  <refsect1><title>SEE ALSO</title>
  62   <para>
  63    <citerefentry>
  64     <refentrytitle>metaproxy</refentrytitle>
  65     <manvolnum>1</manvolnum>
  66    </citerefentry>
  67   </para>
  68   <para>
  69    <ulink url="&url.zeerex.explain;">ZeeReX Explain</ulink>
  70   </para>
  71  </refsect1>
  72
  73  &copyright;
  74 </refentry>
  75
  76 <!-- Keep this comment at the end of the file
  77 Local variables:
  78 mode: sgml
  79 sgml-omittag:t
  80 sgml-shorttag:t
  81 sgml-minimize-attributes:nil
  82 sgml-always-quote-attributes:t
  83 sgml-indent-step:1
  84 sgml-indent-data:t
  85 sgml-parent-document:nil
  86 sgml-local-catalogs: nil
  87 sgml-namecase-general:t
  88 End:
  89 -->