metaproxy daemon: option -t tests configuration

[metaproxy-moved-to-github.git] / doc / zeerex_explain.xml

diff --git a/doc/zeerex_explain.xml b/doc/zeerex_explain.xml
index 58ea172..737b4f4 100644 (file)
--- a/doc/zeerex_explain.xml
+++ b/doc/zeerex_explain.xml
@@ -1,26 +1,30 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" 
-    "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 
+    "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [

  <!ENTITY copyright SYSTEM "copyright.xml">    
  <!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">
+ <refentryinfo>
+  <productname>Metaproxy</productname>
+  <info><orgname>Index Data</orgname></info>
+ </refentryinfo>
+

  <refmeta>
   <refentrytitle>zeerex_explain</refentrytitle>
   <manvolnum>3mp</manvolnum>
  <refmeta>
   <refentrytitle>zeerex_explain</refentrytitle>
   <manvolnum>3mp</manvolnum>

-  <refmiscinfo>Metaproxy Module</refmiscinfo>
+  <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>

  </refmeta>
  
  <refnamediv>
   <refname>zeerex_explain</refname>
  </refmeta>
  
  <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>
  </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>
    static ZeeReX Explain XML record from the config section. All other
    packages are passed through. 
   </para>

@@ -28,19 +32,18 @@
    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
    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>
    <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>
  </refsect1>
 
  <refsect1><title>EXAMPLES</title>

@@ -69,9 +72,6 @@
   <para> 
    <ulink url="&url.zeerex.explain;">ZeeReX Explain</ulink>
   </para>
   <para> 
    <ulink url="&url.zeerex.explain;">ZeeReX Explain</ulink>
   </para>

-  <para>   
-   <ulink url="&url.sru.explain;">SRU Explain</ulink> 
-   </para>

  </refsect1>
  
  &copyright;
  </refsect1>
  
  &copyright;