Version 1.7.1

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

diff --git a/doc/record_transform.xml b/doc/record_transform.xml
index e298a40..c490d56 100644 (file)
--- a/doc/record_transform.xml
+++ b/doc/record_transform.xml
@@ -1,4 +1,4 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 
+<!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 % idcommon SYSTEM "common/common.ent">
     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
  <!ENTITY % idcommon SYSTEM "common/common.ent">

@@ -15,7 +15,7 @@
   <manvolnum>3mp</manvolnum>
   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
  </refmeta>
   <manvolnum>3mp</manvolnum>
   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
  </refmeta>

- 
+

  <refnamediv>
   <refname>record_transform</refname>
   <refpurpose>Metaproxy Module that performs record transformations</refpurpose>
  <refnamediv>
   <refname>record_transform</refname>
   <refpurpose>Metaproxy Module that performs record transformations</refpurpose>

@@ -30,35 +30,54 @@
    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.
    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>

   <para>
   <para>

-   The allowed record present syntax and 
+   The allowed record present syntax and

    element name are described in multiple
    element name are described in multiple

-   <literal>&lt;retrieval&gt;</literal> elements inside the 
+   <literal>&lt;retrieval&gt;</literal> elements inside the

    <literal>&lt;retrievalinfo&gt;</literal>
    element. The <literal>syntax</literal> attribute is mandatory, but
    the <literal>name</literal> attribute
    <literal>&lt;retrievalinfo&gt;</literal>
    element. The <literal>syntax</literal> attribute is mandatory, but
    the <literal>name</literal> attribute

-   may be omitted, in which case any 
+   may be omitted, in which case any

    element name is accepted. An additional
    <literal>identifier</literal> attribute can be added to explicitly
    describe the Z39.50 identifier string.
   </para>
   <para>
     The <literal>&lt;retrieval&gt;</literal> element and the content
    element name is accepted. An additional
    <literal>identifier</literal> attribute can be added to explicitly
    describe the Z39.50 identifier string.
   </para>
   <para>
     The <literal>&lt;retrieval&gt;</literal> element and the content

-    is described in the 
+    is described in the

     <ulink url="&url.yaz.retrieval;">Retrieval Facility</ulink> section
     of the YAZ manual.
   </para>
     <ulink url="&url.yaz.retrieval;">Retrieval Facility</ulink> section
     of the YAZ manual.
   </para>

+  <para>
+   From Metaproxy version 1.3.26 and onwards the backend conversion ma
+   also use <ulink url="&url.usemarcon;">USEMARCON</ulink>.
+   If USEMARCON is enabled, the <literal>backend</literal> may include
+   a <literal>usemarcon</literal> element with two attributes:
+   <literal>stage1</literal> and <literal>stage2</literal> that points to
+   conversion files as interpreted by USEMARCON. One or both must be given.
+  </para>

  </refsect1>
  </refsect1>

- 
+

  <refsect1><title>SCHEMA</title>
  <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>
+ <para>
+  Schema is in two parts.. One for the filter itself and one for the
+  retrieval info.
+ </para>
+ <literallayout>
+  <xi:include
+      xi:href="../xml/schema/filter_record_transform.rnc"
+      xi:parse="text"
+      xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </literallayout>
+ <literallayout>
+  <xi:include
+      xi:href="../xml/schema/retrievalinfo.rnc"
+      xi:parse="text"
+      xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </literallayout>

  </refsect1>
  </refsect1>

- 
+

  <refsect1><title>EXAMPLES</title>
   <para>
    A typical configuration looks like this:
  <refsect1><title>EXAMPLES</title>
   <para>
    A typical configuration looks like this:

@@ -84,13 +103,18 @@
           <backend syntax="usmarc" name="F">
           </backend>
         </retrieval>
           <backend syntax="usmarc" name="F">
           </backend>
         </retrieval>

+        <retrieval syntax="usmarc" name="C">
+         <backend syntax="unimarc" name="F">
+            <usemarcon stage1="/etc/usemarcon/uni2us/uni2us.ini"/>
+          </backend>
+        </retrieval>

       </retrievalinfo>
     </filter>
 ]]>
    </screen>
   </para>
       </retrievalinfo>
     </filter>
 ]]>
    </screen>
   </para>

- </refsect1> 
- 
+ </refsect1>
+

  <refsect1><title>SEE ALSO</title>
   <para>
    <citerefentry>
  <refsect1><title>SEE ALSO</title>
   <para>
    <citerefentry>

@@ -99,7 +123,7 @@
    </citerefentry>
   </para>
  </refsect1>
    </citerefentry>
   </para>
  </refsect1>

- 
+

  &copyright;
 </refentry>
 
  &copyright;
 </refentry>