Fix query_rewrite config example
[metaproxy-moved-to-github.git] / doc / record_transform.xml
index 4a40d7c..e298a40 100644 (file)
  
  <refnamediv>
   <refname>record_transform</refname>
-  <refpurpose>Metaproxy Module that performs Z39.50 presentResponse record transformations</refpurpose>
+  <refpurpose>Metaproxy Module that performs record transformations</refpurpose>
  </refnamediv>
 
  <refsect1><title>DESCRIPTION</title>
   <para>
-   This filter acts only on Z3950 present requests, and let all
-   other types of packages and requests pass untouched. It's use is
-   twofold: blocking Z3950 present requests, which the backend
-   server does not understand and can not honor, and transforming
-   the present syntax and elementset name according to the rules
-   specified, to fetch only existing record formats, and transform
-   them on the fly to requested record syntaxes.
+   This filter acts on Z39.50 present requests and Z39.50 search requests,
+   and let all other types of packages and requests pass untouched. Its
+   use is twofold: blocking Z39.50 present/search requests that the backend
+   server does not understand or can not honor, and transforming the present
+   syntax and elementset name according to the rules specified, to fetch
+   only existing record formats, and transform them on the fly to requested
+   record syntaxes.
   </para> 
   <para>
    The allowed record present syntax and 
@@ -41,7 +41,7 @@
    may be omitted, in which case any 
    element name is accepted. An additional
    <literal>identifier</literal> attribute can be added to explicitly
-   describe the Z3950 identifier string.
+   describe the Z39.50 identifier string.
   </para>
   <para>
     The <literal>&lt;retrieval&gt;</literal> element and the content
   </para>
  </refsect1>
  
+ <refsect1><title>SCHEMA</title>
+   <literallayout><xi:include
+                    xi:href="../xml/schema/filter_record_transform.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:
 
 <!-- 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:
 -->