Document x-session-id, x-log-enable

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

diff --git a/doc/sru_z3950.xml b/doc/sru_z3950.xml
index 334b660..4599871 100644 (file)
--- a/doc/sru_z3950.xml
+++ b/doc/sru_z3950.xml
@@ -82,10 +82,41 @@
          </para>
        </listitem>
       </varlistentry>
+      <varlistentry>
+       <term>x-session-id</term>
+       <listitem>
+         <para>
+           Allow a user-defined session ID to be attached to filter
+           log that follows sru_z3950. The ID is present in the
+           log files and not available to the SRU webservice. In order
+           to log material out via SRU, the x-log-enable may be used
+           instead.
+         </para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
+       <term>x-log-enable</term>
+       <listitem>
+         <para>
+            Controls whether log is to be collected for filters that
+            sru_z3950. Log data is extra response data's log element.
+            A value of 1 enables logging; other value disables
+            logging (default).
+         </para>
+       </listitem>
+      </varlistentry>
     </variablelist>
   </para>
  </refsect1>
 
+ <refsect1><title>SCHEMA</title>
+   <literallayout><xi:include
+                    xi:href="../xml/schema/filter_sru_z3950.rnc"
+                    xi:parse="text"  
+                    xmlns:xi="http://www.w3.org/2001/XInclude" />
+   </literallayout>
+ </refsect1>
+ 
  <refsect1><title>EXAMPLES</title>
   <para>
    A typical configuration looks like this:
@@ -118,15 +149,7 @@
 
 <!-- Keep this comment at the end of the file
 Local variables:
-mode: sgml
-sgml-omittag:t
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-sgml-parent-document:nil
-sgml-local-catalogs: nil
-sgml-namecase-general:t
+mode: nxml
+nxml-child-indent: 1
 End:
 -->