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">
7 <refentry id="ref-zeerex_explain">
9 <productname>Metaproxy</productname>
10 <info><orgname>Index Data</orgname></info>
14 <refentrytitle>zeerex_explain</refentrytitle>
15 <manvolnum>3mp</manvolnum>
16 <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
20 <refname>zeerex_explain</refname>
21 <refpurpose>Metaproxy Z39.50 ZeeReX Explain Module</refpurpose>
24 <refsect1><title>DESCRIPTION</title>
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.
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
44 This filter is not yet completed.
49 <refsect1><title>EXAMPLES</title>
51 A typical configuration looks like this:
53 <filter type="zeerex_explain">
54 <database name="Default">
55 <explain xmlns="http://explain.z3950.org/dtd/2.0/">
65 <refsect1><title>SEE ALSO</title>
68 <refentrytitle>metaproxy</refentrytitle>
69 <manvolnum>1</manvolnum>
73 <ulink url="&url.zeerex.explain;">ZeeReX Explain</ulink>
80 <!-- Keep this comment at the end of the file