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">
7 <!-- $Id: zeerex_explain.xml,v 1.1 2007-01-05 10:56:17 marc Exp $ -->
10 <refentrytitle>zeerex_explain</refentrytitle>
11 <manvolnum>3mp</manvolnum>
12 <refmiscinfo>Metaproxy Module</refmiscinfo>
16 <refname>zeerex_explain</refname>
17 <refpurpose>answering SRU web service explain requests</refpurpose>
20 <refsect1><title>DESCRIPTION</title>
22 The <literal>zeerex_explain</literal> metaproxy filter
23 answers valid SRU GET/POST/SOAP explain requests, returning a
24 static ZeeReX Explain XML record from the config section. All other
25 packages are passed through.
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 Z3950 flavours, and this filter requires
32 the SRU 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
39 A configuration for a full SRU server needs to line up a
40 <literal>zeerex_explain</literal> filter, a
41 <literal>cql_pqf</literal> (not implemented yet) filter, and a
42 <literal>sru_z3950</literal> after each other.
46 <refsect1><title>EXAMPLES</title>
48 A typical configuration looks like this:
50 <filter type="zeerex_explain">
51 <database name="Default">
52 <explain xmlns="http://explain.z3950.org/dtd/2.0/">
62 <refsect1><title>SEE ALSO</title>
65 <refentrytitle>metaproxy</refentrytitle>
66 <manvolnum>1</manvolnum>
70 <ulink url="&url.zeerex.explain;">ZeeReX Explain</ulink>
73 <ulink url="&url.sru.explain;">SRU Explain</ulink>
80 <!-- Keep this comment at the end of the file
85 sgml-minimize-attributes:nil
86 sgml-always-quote-attributes:t
89 sgml-parent-document:nil
90 sgml-local-catalogs: nil
91 sgml-namecase-general:t