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 % idcommon SYSTEM "common/common.ent">
7 <refentry id="ref-zeerex_explain">
9 <refentrytitle>zeerex_explain</refentrytitle>
10 <manvolnum>3mp</manvolnum>
11 <refmiscinfo>Metaproxy Module</refmiscinfo>
15 <refname>zeerex_explain</refname>
16 <refpurpose>Metaproxy Z39.50 ZeeReX Explain Module</refpurpose>
19 <refsect1><title>DESCRIPTION</title>
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.
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
39 This filter is not yet completed.
44 <refsect1><title>EXAMPLES</title>
46 A typical configuration looks like this:
48 <filter type="zeerex_explain">
49 <database name="Default">
50 <explain xmlns="http://explain.z3950.org/dtd/2.0/">
60 <refsect1><title>SEE ALSO</title>
63 <refentrytitle>metaproxy</refentrytitle>
64 <manvolnum>1</manvolnum>
68 <ulink url="&url.zeerex.explain;">ZeeReX Explain</ulink>
75 <!-- Keep this comment at the end of the file
80 sgml-minimize-attributes:nil
81 sgml-always-quote-attributes:t
84 sgml-parent-document:nil
85 sgml-local-catalogs: nil
86 sgml-namecase-general:t