<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
"http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
<!ENTITY copyright SYSTEM "copyright.xml">
- <!ENTITY % common SYSTEM "common/common.ent">
- %common;
+ <!ENTITY % idcommon SYSTEM "common/common.ent">
+ %idcommon;
]>
-<!-- $Id: zeerex_explain.xml,v 1.1 2007-01-05 10:56:17 marc Exp $ -->
-<refentry>
+<refentry id="ref-zeerex_explain">
<refmeta>
<refentrytitle>zeerex_explain</refentrytitle>
<manvolnum>3mp</manvolnum>
<refnamediv>
<refname>zeerex_explain</refname>
- <refpurpose>answering SRU web service explain requests</refpurpose>
+ <refpurpose>Metaproxy Z39.50 ZeeReX Explain Module</refpurpose>
</refnamediv>
<refsect1><title>DESCRIPTION</title>
<para>
- The <literal>zeerex_explain</literal> metaproxy filter
- answers valid SRU GET/POST/SOAP explain requests, returning a
+ The <literal>zeerex_explain</literal> Metaproxy filter
+ answers valid Z30.50 explain requests, returning a
static ZeeReX Explain XML record from the config section. All other
packages are passed through.
</para>
Multiple database elements defining the names of the accepted
databases are allowed in the configuration file. Each
of them must contain their own explain record. Notice that explain
- records come in SRU and Z3950 flavours, and this filter requires
- the SRU version. See the
+ records come in SRU and Z39.50 flavours, and this filter requires
+ the Z39.50 version. See the
<ulink url="&url.zeerex.explain;">ZeeReX Explain</ulink>
standard pages and the
<ulink url="&url.sru.explain;">SRU Explain</ulink> pages
for more information.
</para>
- <para>
- A configuration for a full SRU server needs to line up a
- <literal>zeerex_explain</literal> filter, a
- <literal>cql_pqf</literal> (not implemented yet) filter, and a
- <literal>sru_z3950</literal> after each other.
- </para>
+ <warning>
+ <para>
+ This filter is not yet completed.
+ </para>
+ </warning>
</refsect1>
<refsect1><title>EXAMPLES</title>
<para>
<ulink url="&url.zeerex.explain;">ZeeReX Explain</ulink>
</para>
- <para>
- <ulink url="&url.sru.explain;">SRU Explain</ulink>
- </para>
</refsect1>
©right;