document another upgrade snatch

[idzebra-moved-to-github.git] / doc / installation.xml

diff --git a/doc/installation.xml b/doc/installation.xml
index 29708bf..5af2531 100644 (file)
--- a/doc/installation.xml
+++ b/doc/installation.xml
@@ -1,4 +1,4 @@
-<!-- $Id: installation.xml,v 1.20 2006-06-25 21:04:49 marc Exp $ -->
+<!-- $Id: installation.xml,v 1.23 2006-06-27 12:37:43 marc Exp $ -->
  <chapter id="installation">
   <title>Installation</title>
   <para>
@@ -204,9 +204,10 @@
   </sect1>
 
   <sect1 id="installation.debian"><title>GNU/Debian</title>
-   <sect2 id="installation.debianlinux"><title>GNU/Debian Linux</title>
+   <sect2 id="installation.debianlinux"><title>GNU/Debian Linux on
+   i686 Platform</title>
     <para>
-     Index Data provides pre-compiled <literal>GNU/Debian
+     Index Data provides pre-compiled <literal>GNU/Debian i686
       Linux</literal> packages at our Debian package archive, both for
      the <literal>Sarge</literal> and the <literal>Etch</literal> release. 
     </para>
@@ -415,6 +416,61 @@
    </para>
   </sect1>
 
+
+  <sect1 id="installation-upgrade">
+   <title>Upgrading from Zebra version 1.3.x</title>
+   <para>
+    Zebra's installation directories have changed a bit. In addition,
+    the new loadable modules must be defined in the 
+    master <filename>zebra.cfg</filename> configuration file. The old
+    version 1.3.x configuration options
+    <screen>
+     # profilePath - where to look for config files
+     profilePath: some/local/path:/usr/share/idzebra/tab
+    </screen>
+    must be changed to 
+    <screen>
+     # profilePath - where to look for config files
+     profilePath: some/local/path:/usr/share/idzebra2.0/tab
+
+     # modulePath - where to look for loadable zebra modules
+     modulePath: /usr/lib/idzebra2.0/
+    </screen>
+   </para>
+   <para>
+    The internal binary register structures have changed; all Zebra
+    databases must be re-indexed after upgrade.
+   </para>
+   <para>
+    The attribute set defintion files may no longer contain
+    redirection to other fields. 
+    For example the following snippet of
+    a custom <filename>custom/bib1.att</filename> 
+    <literal>Bib-1</literal> attribute set definition file is no
+    longer supported:
+    <screen>
+     att 1016            Any           1016,4,1005,62
+    </screen>
+    and should be changed to 
+    <screen>
+     att 1016            Any
+    </screen>
+    Similar behaviour can be expressed in the new release by defining
+    a new index <literal>Any:w</literal> in all GRS
+    <filename>*.abs</filename> record indexing configuration files.
+    The above example configuration needs to make the changes
+    from version 1.3.x indexing instructions
+    <screen>
+     xelm /*/alternative  Body-of-text:w,Title:s,Title:w
+     xelm /*/title        Body-of-text:w,Title:s,Title:w
+    </screen>
+    to version 2.0.0 indexing instructions
+    <screen>
+     xelm /*/alternative  Any:w,Body-of-text:w,Title:s,Title:w
+     xelm /*/title        Any:w,Body-of-text:w,Title:s,Title:w
+    </screen>
+   </para>
+  </sect1>
   
  </chapter>
  <!-- Keep this comment at the end of the file