From 88ae89d44e94fb935ec29b4755959332e9116aac Mon Sep 17 00:00:00 2001
From: Adam Dickmeiss <adam@indexdata.dk>
Date: Thu, 28 Feb 2013 16:11:00 +0100
Subject: [PATCH] Doc update for USEMARCON support

---
 doc/book.xml             |   27 ++++++++++++++++++++++++++-
 doc/record_transform.xml |   34 +++++++++++++++++++++++++++++-----
 2 files changed, 55 insertions(+), 6 deletions(-)

diff --git a/doc/book.xml b/doc/book.xml
index 3d1587b..8eaa1af 100644
--- a/doc/book.xml
+++ b/doc/book.xml
@@ -169,6 +169,11 @@
    <ulink url="&url.vstudio;">Microsoft Visual Studio</ulink> 2003/2005/2008.
   </para>
 
+  <para>
+   As an option, Metaproxy may also be compiled with
+   <ulink url="&url.usemarcon;">USEMARCON</ulink> support which allows for
+   MARC conversions for the <xref linkend="ref-record_transform"/> filter.
+  </para>
   <section id="installation.unix">
    <title>Installation on Unix (from Source)</title>
    <para>
@@ -178,6 +183,14 @@
     installed as development packages use those (and omit compilation).
    </para>
 
+   <note>
+    <para>
+     <ulink url="&url.usemarcon;">USEMARCON</ulink> is not available
+     as a package at the moment, so Metaproxy must be built from source
+     if that is to be used.
+    </para>
+   </note>
+
    <section id="libxml2.fromsource">
     <title>Libxml2/libxslt</title>
     <para>
@@ -200,6 +213,18 @@
      make install
     </screen>
    </section>
+   <section id="usemarcon">
+    <title>USEMARCON (optional)</title>
+    <screen>
+     gunzip -c usemarcon317.tar.gz|tar xf -
+     cd usemarcon317
+     ./configure
+     make
+     su
+     make install
+    </screen>
+   </section>
+
    <section id="yaz.fromsource">
     <title>YAZ/YAZ++</title>
     <screen>
@@ -276,7 +301,7 @@
    <para>
     All dependencies for Metaproxy are available as
     <ulink url="&url.debian;">Debian</ulink>
-    packages for the sarge (stable in 2005) and etch (testing in 2005)
+    packages for the squeeze (stable in 2012) and wheezy (testing in 2012)
     distributions.
    </para>
    <para>
diff --git a/doc/record_transform.xml b/doc/record_transform.xml
index 15e1055..c490d56 100644
--- a/doc/record_transform.xml
+++ b/doc/record_transform.xml
@@ -49,14 +49,33 @@
     <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><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><title>EXAMPLES</title>
@@ -84,6 +103,11 @@
           <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>
 ]]>
-- 
1.7.10.4