Documentation for now based on Docbook XML/XSLT using xsltproc + Norman

Walsh's stylesheets. It means that the CVS version of Zebra is no longer
depending on jade/openjade or docbook-to-man scripts. PDF is no longer
part of the distribution - but can optionally be made using DSSSL/jadetex
or FOP.

diff --git a/buildconf.sh b/buildconf.sh
index 90cc825..21d46ef 100755 (executable)
--- a/buildconf.sh
+++ b/buildconf.sh
@@ -1,5 +1,5 @@
 #!/bin/sh
-# $Id: buildconf.sh,v 1.19 2006-05-05 17:19:38 adam Exp $
+# $Id: buildconf.sh,v 1.20 2006-05-24 19:12:46 adam Exp $
 if automake --version|head -1 |grep '1\.[4-7]'; then
     echo "automake 1.4-1.7 is active. You should use automake 1.8 or later"
     if test -f /etc/debian_version; then
@@ -69,10 +69,9 @@ Verify distribution tarball with
 Or just build the Debian packages without configuring
   dpkg-buildpackage -rfakeroot
 
-When building from a CVS checkout, you need these Debian tools:
-  docbook-utils, docbook, docbook-xml, docbook-dsssl,
-  docbook-defguide, docbook-website, docbook-xsl, jade, jadetex,
-  libyaz-dev, libexpat1-dev, libtcl8.3-dev, libbz2-dev
+When building from a CVS checkout, you need these Debian packages:
+  docbook, docbook-xml, docbook-xsl, xsltproc,
+  libyaz-dev, libexpat1-dev, tcl8.4-dev, libbz2-dev
 and if you want the Alvis/XSLT filter, you also need:
   libxslt1-dev
 

diff --git a/configure.ac b/configure.ac
index 732fc8b..d62c2f0 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -1,5 +1,5 @@
 dnl Zebra, Index Data ApS, 1995-2006
-dnl $Id: configure.ac,v 1.7 2006-05-23 10:04:43 marc Exp $
+dnl $Id: configure.ac,v 1.8 2006-05-24 19:12:46 adam Exp $
 dnl
 AC_PREREQ(2.59)
 AC_INIT([idzebra],[1.4.0],[adam@indexdata.dk])
@@ -354,6 +354,7 @@ AC_OUTPUT([
   doc/common/Makefile
   doc/common/html.dsl
   doc/common/html.xsl
+  doc/common/man.xsl
   doc/common/print.dsl
   doc/common/tkl.xsl
   test/Makefile test/gils/Makefile test/usmarc/Makefile test/api/Makefile

diff --git a/doc/Makefile.am b/doc/Makefile.am
index cf65b04..7925b6d 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,4 +1,4 @@
-## $Id: Makefile.am,v 1.44 2006-04-26 11:08:41 adam Exp $
+## $Id: Makefile.am,v 1.45 2006-05-24 19:12:46 adam Exp $
 docdir=$(datadir)/doc/@PACKAGE@
 
 SUBDIRS = common
@@ -23,7 +23,6 @@ XMLFILES =  zebra.xml.in \
    zebrasrv-synopsis.xml \
    zebrasrv-virtual.xml
 
-
 HTMLFILES =  \
    administration-cql-to-pqf.html \
    administration-extended-services.html \
@@ -64,7 +63,7 @@ HTMLFILES =  \
    shadow-registers.html \
    simple-indexing.html \
    support.html \
-   zebra.html \
+   index.html \
    zebraidx.html
 
 PNGFILES=zebra.png
@@ -72,30 +71,27 @@ EPSFILES=zebra.eps
 
 MANFILES=zebraidx.1 zebrasrv.8 idzebra-config.1
 
-REFFILES=zebraidx-man.sgml zebrasrv-man.sgml idzebra-config-man.sgml
+REFFILES=zebraidx-man.xml zebrasrv-man.xml idzebra-config-man.xml
 
-doc_DATA = $(HTMLFILES) zebra.pdf $(PNGFILES)
+doc_DATA = $(HTMLFILES) $(PNGFILES)
 man_MANS = $(MANFILES)
 
 EXTRA_DIST = $(XMLFILES) $(REFFILES) \
        $(doc_DATA) $(EPSFILES) $(man_MANS) $(REFFILES) \
-       zvrank.txt marc_indexing.xml
+       zvrank.txt marc_indexing.xml entities.ent
 
-zebraidx.1: zebraidx-man.sgml zebraidx-options.xml zebraidx-commands.xml
-       if test ! -f zebraidx-options.xml ; then ln -s $(srcdir)/zebraidx-options.xml .; fi
-       if test ! -f zebraidx-commands.xml ; then ln -s $(srcdir)/zebraidx-commands.xml .; fi
-       docbook2man $(srcdir)/zebraidx-man.sgml
+zebraidx.1: zebraidx-man.xml zebraidx-options.xml zebraidx-commands.xml
+       xsltproc common/man.xsl $(srcdir)/zebraidx-man.xml
 
-# zebrasrv-commands.xml
-zebrasrv.8: zebrasrv-man.sgml  zebrasrv-options.xml \
+zebrasrv.8: zebrasrv-man.xml  zebrasrv-options.xml \
             zebrasrv-synopsis.xml zebrasrv-virtual.xml
-       docbook2man $(srcdir)/zebrasrv-man.sgml
+       xsltproc common/man.xsl $(srcdir)/zebrasrv-man.xml
 
-idzebra-config.1: idzebra-config-man.sgml
-       docbook2man $(srcdir)/idzebra-config-man.sgml
+idzebra-config.1: idzebra-config-man.xml
+       xsltproc common/man.xsl $(srcdir)/idzebra-config-man.xml
 
 $(HTMLFILES): $(XMLFILES)
-       jade -E14 -D $(srcdir) -d common/html.dsl -t sgml $(srcdir)/common/xml.dcl zebra.xml
+       xsltproc common/html.xsl zebra.xml
 
 zebra.pdf: $(XMLFILES)
        for i in $(PNGFILES); do \
@@ -122,7 +118,7 @@ clean-data-hook:
        rm -f [0-9]* *.bak
 
 dist-hook:
-       for f in $(srcdir)/*.html; do \
+       for f in *.html; do \
                found=0; \
                b=`basename $$f`; \
                for h in $(HTMLFILES); do \

diff --git a/doc/entities.ent b/doc/entities.ent
new file mode 100644 (file)
index 0000000..a953715
--- /dev/null
+++ b/doc/entities.ent
@@ -0,0 +1,29 @@
+<!-- $Id: entities.ent,v 1.1 2006-05-24 19:12:46 adam Exp $ -->
+<!ENTITY chap-introduction SYSTEM "introduction.xml">
+<!ENTITY chap-installation SYSTEM "installation.xml">
+<!ENTITY chap-quickstart SYSTEM "quickstart.xml">
+<!ENTITY chap-examples SYSTEM "examples.xml">
+<!ENTITY chap-architecture SYSTEM "architecture.xml">
+<!ENTITY chap-administration SYSTEM "administration.xml">
+<!ENTITY chap-zebraidx SYSTEM "zebraidx.xml">
+<!ENTITY chap-server SYSTEM "server.xml">
+<!ENTITY chap-recordmodel-grs SYSTEM "recordmodel-grs.xml">
+<!ENTITY chap-recordmodel-alvisxslt SYSTEM "recordmodel-alvisxslt.xml">
+<!ENTITY app-license SYSTEM "license.xml">
+<!ENTITY app-indexdata SYSTEM "indexdata.xml">
+
+<!ENTITY zebraidx-options SYSTEM "zebraidx-options.xml">
+<!ENTITY zebraidx-commands SYSTEM "zebraidx-commands.xml">
+<!ENTITY zebrasrv-synopsis SYSTEM "zebrasrv-synopsis.xml">
+<!ENTITY zebrasrv-options SYSTEM "zebrasrv-options.xml">
+<!ENTITY zebrasrv-virtual SYSTEM "zebrasrv-virtual.xml">
+<!ENTITY gfs-synopsis-app "zebrasrv">
+
+<!ENTITY ref-architecture-representation '
+       <xref linkend="architecture-representation"/>'>
+<!ENTITY ref-record-types '
+       <xref linkend="record-types"/>'>
+<!ENTITY ref-configuration-file '
+       <xref linkend="configuration-file"/>'>
+<!ENTITY ref-shadow-registers '
+       <xref linkend="shadow-registers"/>'>

diff --git a/doc/idzebra-config-man.sgml b/doc/idzebra-config-man.sgml
deleted file mode 100644 (file)
index a84ff50..0000000
--- a/doc/idzebra-config-man.sgml
+++ /dev/null
@@ -1,129 +0,0 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
-<!-- $Id: idzebra-config-man.sgml,v 1.1 2004-09-28 20:38:25 adam Exp $ -->
-<refentry id="idzebra-config">
- 
- <refmeta>
-  <refentrytitle>idzebra-config</refentrytitle>
-  <manvolnum>1</manvolnum>
- </refmeta>
- 
- <refnamediv>
-  <refname>idzebra-config</refname>
-  <refpurpose>Script to get information about idzebra</refpurpose>
- </refnamediv>
- 
- <refsynopsisdiv>
-  <cmdsynopsis>
-   <command>idzebra-config</command>
-   <arg choice="opt"><option>--prefix[=<replaceable>DIR</replaceable>]</option></arg>
-   <arg choice="opt"><option>--version</option></arg>
-   <arg choice="opt"><option>--libs</option></arg>
-   <arg choice="opt"><option>--lalibs</option></arg>
-   <arg choice="opt"><option>--cflags</option></arg>
-   <arg choice="opt"><option>--tabs</option></arg>
-   <arg choice="opt" rep="repeat">libraries</arg>
-  </cmdsynopsis>
- </refsynopsisdiv>
- 
- <refsect1><title>DESCRIPTION</title>
-  <para>
-   <command>idzebra-config</command> is a script that returns information
-   that your own software should use to build software that uses idzebra.
-  </para>
-
-  <para>
-   The following libraries are supported:
-  </para>
-
-  <para>
-   None (yet)
-  </para>
-  
- </refsect1>
- 
- <refsect1><title>OPTIONS</title>
-  
-  <variablelist>
-   <varlistentry>
-    <term>--prefix[=<replaceable>DIR</replaceable>]</term>
-    <listitem><para>
-      Returns prefix of idzebra or assume a different one if DIR is
-      specified.
-     </para></listitem>
-   </varlistentry>
-
-   <varlistentry>
-    <term>--version</term>
-    <listitem><para>
-      Returns version of idzebra.
-     </para></listitem>
-   </varlistentry>
-
-   <varlistentry>
-    <term>--libs</term>
-    <listitem><para>
-      Library specification be used when linking with idzebra.
-     </para></listitem>
-   </varlistentry>
-
-   <varlistentry>
-    <term>--lalibs</term>
-    <listitem><para>
-      Return library specification.
-     </para></listitem>
-   </varlistentry>
-
-   <varlistentry>
-    <term>--cflags</term>
-    <listitem><para>
-      Return C Compiler flags.
-     </para></listitem>
-   </varlistentry>
-
-   <varlistentry>
-    <term>--tabs</term>
-    <listitem><para>
-      Return directory of idzebra tables.
-     </para></listitem>
-   </varlistentry>
-
-  </variablelist>
- </refsect1>
- 
- <refsect1><title>FILES</title>
-  <para>
-   <filename><replaceable>prefix</replaceable>/bin/idzebra-config</filename>
-  </para>
-  <para>
-   <filename><replaceable>prefix</replaceable>/lib/libidzebra*.a</filename>
-  </para>
-  <para>
-   <filename><replaceable>prefix</replaceable>/include/idzebra/*.h</filename>
-  </para>
- </refsect1>
- <!--
- <refsect1><title>SEE ALSO</title>
- <para>
- yaz(7)
-  </para>
- <para>
- Section "How to make apps using YAZ on UNIX" in the YAZ manual.
-  </para>
- </refsect1>
- -->
-</refentry>
-
-<!-- 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
-End:
--->

diff --git a/doc/idzebra-config-man.xml b/doc/idzebra-config-man.xml
new file mode 100644 (file)
index 0000000..69aa9fd
--- /dev/null
+++ b/doc/idzebra-config-man.xml
@@ -0,0 +1,131 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+[ ]>
+<!-- $Id: idzebra-config-man.xml,v 1.1 2006-05-24 19:12:46 adam Exp $ -->
+<refentry id="idzebra-config">
+ 
+ <refmeta>
+  <refentrytitle>idzebra-config</refentrytitle>
+  <manvolnum>1</manvolnum>
+ </refmeta>
+ 
+ <refnamediv>
+  <refname>idzebra-config</refname>
+  <refpurpose>Script to get information about idzebra</refpurpose>
+ </refnamediv>
+ 
+ <refsynopsisdiv>
+  <cmdsynopsis>
+   <command>idzebra-config</command>
+   <arg choice="opt"><option>--prefix[=<replaceable>DIR</replaceable>]</option></arg>
+   <arg choice="opt"><option>--version</option></arg>
+   <arg choice="opt"><option>--libs</option></arg>
+   <arg choice="opt"><option>--lalibs</option></arg>
+   <arg choice="opt"><option>--cflags</option></arg>
+   <arg choice="opt"><option>--tabs</option></arg>
+   <arg choice="opt" rep="repeat">libraries</arg>
+  </cmdsynopsis>
+ </refsynopsisdiv>
+ 
+ <refsect1><title>DESCRIPTION</title>
+  <para>
+   <command>idzebra-config</command> is a script that returns information
+   that your own software should use to build software that uses idzebra.
+  </para>
+
+  <para>
+   The following libraries are supported:
+  </para>
+
+  <para>
+   None (yet)
+  </para>
+  
+ </refsect1>
+ 
+ <refsect1><title>OPTIONS</title>
+  
+  <variablelist>
+   <varlistentry>
+    <term>--prefix[=<replaceable>DIR</replaceable>]</term>
+    <listitem><para>
+      Returns prefix of idzebra or assume a different one if DIR is
+      specified.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>--version</term>
+    <listitem><para>
+      Returns version of idzebra.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>--libs</term>
+    <listitem><para>
+      Library specification be used when linking with idzebra.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>--lalibs</term>
+    <listitem><para>
+      Return library specification.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>--cflags</term>
+    <listitem><para>
+      Return C Compiler flags.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>--tabs</term>
+    <listitem><para>
+      Return directory of idzebra tables.
+     </para></listitem>
+   </varlistentry>
+
+  </variablelist>
+ </refsect1>
+ 
+ <refsect1><title>FILES</title>
+  <para>
+   <filename><replaceable>prefix</replaceable>/bin/idzebra-config</filename>
+  </para>
+  <para>
+   <filename><replaceable>prefix</replaceable>/lib/libidzebra*.a</filename>
+  </para>
+  <para>
+   <filename><replaceable>prefix</replaceable>/include/idzebra/*.h</filename>
+  </para>
+ </refsect1>
+ <!--
+ <refsect1><title>SEE ALSO</title>
+ <para>
+ yaz(7)
+  </para>
+ <para>
+ Section "How to make apps using YAZ on UNIX" in the YAZ manual.
+  </para>
+ </refsect1>
+ -->
+</refentry>
+
+<!-- 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
+End:
+-->

diff --git a/doc/zebra.xml.in b/doc/zebra.xml.in
index 282205f..2ddc219 100644 (file)
--- a/doc/zebra.xml.in
+++ b/doc/zebra.xml.in
@@ -1,37 +1,13 @@
 <?xml version="1.0" standalone="no"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
-                    "@DTD_DIR@/docbookx.dtd" [
-        <!ENTITY oslash "&#x00F8;"> <!-- CIRCLED DIVISION SLASH -->
-        <!ENTITY chap-introduction SYSTEM "introduction.xml">
-        <!ENTITY chap-installation SYSTEM "installation.xml">
-        <!ENTITY chap-quickstart SYSTEM "quickstart.xml">
-        <!ENTITY chap-examples SYSTEM "examples.xml">
-        <!ENTITY chap-architecture SYSTEM "architecture.xml">
-        <!ENTITY chap-administration SYSTEM "administration.xml">
-        <!ENTITY chap-zebraidx SYSTEM "zebraidx.xml">
-        <!ENTITY chap-server SYSTEM "server.xml">
-        <!ENTITY chap-recordmodel-grs SYSTEM "recordmodel-grs.xml">
-        <!ENTITY chap-recordmodel-alvisxslt SYSTEM "recordmodel-alvisxslt.xml">
-        <!ENTITY app-license SYSTEM "license.xml">
-        <!ENTITY app-indexdata SYSTEM "indexdata.xml">
-
-        <!ENTITY zebraidx-options SYSTEM "zebraidx-options.xml">
-        <!ENTITY zebraidx-commands SYSTEM "zebraidx-commands.xml">
-        <!ENTITY zebrasrv-synopsis SYSTEM "zebrasrv-synopsis.xml">
-        <!ENTITY zebrasrv-options SYSTEM "zebrasrv-options.xml">
-        <!ENTITY zebrasrv-virtual SYSTEM "zebrasrv-virtual.xml">
-        <!ENTITY gfs-synopsis-app "zebrasrv">
-
-       <!ENTITY ref-architecture-representation '
-               <xref linkend="architecture-representation"/>'>
-       <!ENTITY ref-record-types '
-               <xref linkend="record-types"/>'>
-       <!ENTITY ref-configuration-file '
-               <xref linkend="configuration-file"/>'>
-       <!ENTITY ref-shadow-registers '
-               <xref linkend="shadow-registers"/>'>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+[
+     <!ENTITY % entities  SYSTEM "@srcdir@/entities.ent">
+     %entities;
+     <!ENTITY % common  SYSTEM "@srcdir@/common/common.ent">
+     %common;
 ]>
-<!-- $Id: zebra.xml.in,v 1.27 2006-04-25 12:26:27 marc Exp $ -->
+<!-- $Id: zebra.xml.in,v 1.28 2006-05-24 19:12:46 adam Exp $ -->
 <book id="zebra">
  <bookinfo>
   <title>Zebra - User's Guide and Reference</title>

diff --git a/doc/zebraidx-man.sgml b/doc/zebraidx-man.sgml
deleted file mode 100644 (file)
index d3e5216..0000000
--- a/doc/zebraidx-man.sgml
+++ /dev/null
@@ -1,100 +0,0 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
-     <!ENTITY zebraidx-options SYSTEM "zebraidx-options.xml">
-     <!ENTITY zebraidx-commands SYSTEM "zebraidx-commands.xml">
-     <!ENTITY % ref-head "the section entitled">
-     <!ENTITY % ref-tail "in <citetitle>Zebra - User's Guide
-       and Reference</citetitle>">
-     <!ENTITY ref-local-representation "
-       %ref-head; <citetitle>Local Representation</citetitle> %ref-tail;">
-     <!ENTITY ref-record-types "
-       %ref-head; <citetitle>Record Types</citetitle> %ref-tail;">
-     <!ENTITY ref-configuration-file "
-       %ref-head; <citetitle>The Zebra Configuration File</citetitle>
-       %ref-tail;">
-     <!ENTITY ref-shadow-registers "
-       %ref-head; <citetitle>Safe Updating - Using Shadow
-       Registers</citetitle> %ref-tail;">
-]>
-<!-- $Id: zebraidx-man.sgml,v 1.4 2003-09-05 10:50:33 adam Exp $ -->
-<refentry id="zebraidx">
- 
- <refmeta>
-  <refentrytitle>zebraidx</refentrytitle>
-  <manvolnum>1</manvolnum>
- </refmeta>
- 
- <refnamediv>
-  <refname>zebraidx</refname>
-  <refpurpose>Zebra Administrative Tool</refpurpose>
- </refnamediv>
- 
- <refsynopsisdiv>
-  <cmdsynopsis>
-   <command>zebraidx</command>
-   <arg choice="opt"><option>-t <replaceable>type</replaceable></option></arg>
-   <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
-   <arg choice="opt"><option>-g <replaceable>group</replaceable></option></arg>
-   <arg choice="opt"><option>-d <replaceable>database</replaceable></option></arg>
-   <arg choice="opt"><option>-m <replaceable>mbytes</replaceable></option></arg>
-   <arg choice="opt"><option>-n</option></arg>
-   <arg choice="opt"><option>-s</option></arg>
-   <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
-   <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
-   <arg choice="opt"><option>-L</option></arg>
-   <arg choice="opt"><option>-f <replaceable>number</replaceable></option></arg>
-   <arg choice="opt"><option>-v</option></arg>
-   <arg choice="req"><replaceable>command</replaceable></arg>
-   <arg choice="opt" rep="repeat"><replaceable>file</replaceable></arg>
-  </cmdsynopsis>
- </refsynopsisdiv>
- 
- <refsect1><title>DESCRIPTION</title>
-  <para>
-   <command>zebraidx</command> allows you to insert, delete or updates
-   records in Zebra. <command>zebraidx</command> accepts a set options
-   (see below) and exactly one command (mandatory).
-  </para>
- </refsect1>
- <refsect1>
-   <title>COMMANDS</title>
-  &zebraidx-commands;
- </refsect1>
- <refsect1>
-  <title>OPTIONS</title>
-  &zebraidx-options;
- </refsect1>
- <refsect1><title>FILES</title>
-  <para>
-   <filename>zebra.cfg</filename>
-  </para>
- </refsect1>
- <refsect1><title>SEE ALSO</title>
-  <para>
-   <citerefentry>
-    <refentrytitle>zebrasrv</refentrytitle>
-    <manvolnum>8</manvolnum>
-   </citerefentry>
-  </para>
-  <para id="shadow-registers">
-   See "shadow registers" in Zebra manual
-  </para>
-  <para id="administration">
-   See "administration" in Zebra manual
-  </para>
- </refsect1>
-</refentry>
-
-<!-- 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
-End:
--->

diff --git a/doc/zebraidx-man.xml b/doc/zebraidx-man.xml
new file mode 100644 (file)
index 0000000..f75cbd6
--- /dev/null
+++ b/doc/zebraidx-man.xml
@@ -0,0 +1,99 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" 
+ "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+[
+     <!ENTITY zebraidx-options SYSTEM "zebraidx-options.xml">
+     <!ENTITY zebraidx-commands SYSTEM "zebraidx-commands.xml">
+     <!ENTITY % ref-head "the section entitled">
+     <!ENTITY % ref-tail "in <citetitle>Zebra - User's Guide
+       and Reference</citetitle>">
+
+     <!ENTITY ref-architecture-representation "">
+     <!ENTITY ref-local-representation "<citetitle>Local Representation</citetitle>">
+     <!ENTITY ref-record-types "<citetitle>Record Types</citetitle>">
+     <!ENTITY ref-configuration-file "<citetitle>The Zebra Configuration File</citetitle>">
+     <!ENTITY ref-shadow-registers "<citetitle>Safe Updating - Using Shadow
+       Registers</citetitle>">
+]>
+<!-- $Id: zebraidx-man.xml,v 1.1 2006-05-24 19:12:46 adam Exp $ -->
+<refentry id="zebraidx">
+ 
+ <refmeta>
+  <refentrytitle>zebraidx</refentrytitle>
+  <manvolnum>1</manvolnum>
+ </refmeta>
+ 
+ <refnamediv>
+  <refname>zebraidx</refname>
+  <refpurpose>Zebra Administrative Tool</refpurpose>
+ </refnamediv>
+ 
+ <refsynopsisdiv>
+  <cmdsynopsis>
+   <command>zebraidx</command>
+   <arg choice="opt"><option>-t <replaceable>type</replaceable></option></arg>
+   <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
+   <arg choice="opt"><option>-g <replaceable>group</replaceable></option></arg>
+   <arg choice="opt"><option>-d <replaceable>database</replaceable></option></arg>
+   <arg choice="opt"><option>-m <replaceable>mbytes</replaceable></option></arg>
+   <arg choice="opt"><option>-n</option></arg>
+   <arg choice="opt"><option>-s</option></arg>
+   <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
+   <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
+   <arg choice="opt"><option>-L</option></arg>
+   <arg choice="opt"><option>-f <replaceable>number</replaceable></option></arg>
+   <arg choice="opt"><option>-v</option></arg>
+   <arg choice="req"><replaceable>command</replaceable></arg>
+   <arg choice="opt" rep="repeat"><replaceable>file</replaceable></arg>
+  </cmdsynopsis>
+ </refsynopsisdiv>
+ 
+ <refsect1><title>DESCRIPTION</title>
+  <para>
+   <command>zebraidx</command> allows you to insert, delete or updates
+   records in Zebra. <command>zebraidx</command> accepts a set options
+   (see below) and exactly one command (mandatory).
+  </para>
+ </refsect1>
+ <refsect1>
+   <title>COMMANDS</title>
+  &zebraidx-commands;
+ </refsect1>
+ <refsect1>
+  <title>OPTIONS</title>
+  &zebraidx-options;
+ </refsect1>
+ <refsect1><title>FILES</title>
+  <para>
+   <filename>zebra.cfg</filename>
+  </para>
+ </refsect1>
+ <refsect1><title>SEE ALSO</title>
+  <para>
+   <citerefentry>
+    <refentrytitle>zebrasrv</refentrytitle>
+    <manvolnum>8</manvolnum>
+   </citerefentry>
+  </para>
+  <para id="shadow-registers">
+   See "shadow registers" in Zebra manual
+  </para>
+  <para id="administration">
+   See "administration" in Zebra manual
+  </para>
+ </refsect1>
+</refentry>
+
+<!-- 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
+End:
+-->

diff --git a/doc/zebrasrv-man.sgml b/doc/zebrasrv-man.sgml
deleted file mode 100644 (file)
index 701ed74..0000000
--- a/doc/zebrasrv-man.sgml
+++ /dev/null
@@ -1,136 +0,0 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
-     <!ENTITY zebrasrv-synopsis SYSTEM "zebrasrv-synopsis.xml">
-     <!ENTITY zebrasrv-options SYSTEM "zebrasrv-options.xml">
-     <!ENTITY zebrasrv-virtual SYSTEM "zebrasrv-virtual.xml">
-     <!ENTITY gfs-synopsis-app "zebrasrv">
-     <!ENTITY reference-tools-cql-map 'section "Specifiction of CQL to RPN mappings"'>
-]>
-
-     <!-- <!ENTITY zebrasrv-commands SYSTEM "zebrasrv-commands.xml"> -->
-
-
-<!-- $Id: zebrasrv-man.sgml,v 1.5 2005-08-12 13:50:51 marc Exp $ -->
-<refentry id="zebrasrv">
- 
- <refmeta>
-  <refentrytitle>zebrasrv</refentrytitle>
-  <manvolnum>8</manvolnum>
- </refmeta>
- 
- <refnamediv>
-  <refname>zebrasrv</refname>
-  <refpurpose>Zebra Server</refpurpose>
- </refnamediv>
-  
- <refsynopsisdiv>
-  <!--
-  <cmdsynopsis>
-   <command>zebrasrv</command>
-   <arg choice="opt"><option>-a <replaceable>file</replaceable></option></arg>
-   <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
-   <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
-   <arg choice="opt"><option>-u <replaceable>uid</replaceable></option></arg>
-   <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
-   <arg choice="opt"><option>-t <replaceable>minutes</replaceable></option></arg>
-   <arg choice="opt"><option>-k <replaceable>kilobytes</replaceable></option></arg>
-   <arg choice="opt"><option>-d <replaceable>daemon</replaceable></option></arg>
-   <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
-   <arg choice="opt"><option>-ziST1</option></arg>
-   <arg choice="opt" rep="repeat">listener-spec</arg>
-  </cmdsynopsis>
-  -->
-  &zebrasrv-synopsis;
- </refsynopsisdiv>
-  <refsect1><title>DESCRIPTION</title>
-    <para>Zebra is a high-performance, general-purpose structured text indexing
-   and retrieval engine. It reads structured records in a variety of input
-   formats (eg. email, XML, MARC) and allows access to them through exact
-   boolean search expressions and relevance-ranked free-text queries. 
-   </para>
-   <para>
-    <command>zebrasrv</command> is the Z39.50 and SRW/U frontend
-    server for the <command>Zebra</command> indexer.
-   </para> 
-   <para> 
-    On Unix you can run the <command>zebrasrv</command>
-    server from the command line - and put it
-    in the background. It may also operate under the inet daemon.
-    On WIN32 you can run the server as a console application or
-    as a WIN32 Service.
-   </para>
-  </refsect1>
- <!--
- <refsect1>
-   <title>COMMANDS</title>
-  &zebrasrv-commands;
- </refsect1>
- -->
-  <refsect1>
-   <title>OPTIONS</title>
-    
-   <para>
-    The options for <command>zebrasrv</command> are the same
-    as those for YAZ' <command>yaz-ztest</command>.
-    Option <literal>-c</literal> specifies a Zebra configuration
-    file - if omitted <filename>zebra.cfg</filename> is read.
-   </para>
-   
-  &zebrasrv-options;
-  </refsect1>
-  <refsect1><title>VIRTUAL HOSTS</title>
-    <para>
-     <command>zebrasrv</command> uses the YAZ server
-    </para>
-    &zebrasrv-virtual;
-  </refsect1>
-  <refsect1><title>FILES</title>
-   <para>
-    <filename>zebra.cfg</filename>
-   </para>
-  </refsect1>
-  <refsect1><title>SEE ALSO</title>
-   <para>
-    <citerefentry>
-     <refentrytitle>zebraidx</refentrytitle>
-     <manvolnum>1</manvolnum>
-    </citerefentry>,
-    <citerefentry>
-     <refentrytitle>yaz-ztest</refentrytitle>
-     <manvolnum>8</manvolnum>
-    </citerefentry>
-   </para>
-   <para>
-    Section "The Z39.50 Server" in the Zebra manual.
-    <filename>http://www.indexdata.dk/zebra/doc/server.tkl</filename>
-   </para>
-   <para>
-    Section "Virtual Hosts" in the YAZ manual.
-    <filename>http://www.indexdata.dk/yaz/doc/server.vhosts.tkl</filename>
-   </para>
-   <para>
-    Section "Specification of CQL to RPN mappings" in the YAZ manual.
-    <filename>http://www.indexdata.dk/yaz/doc/tools.tkl#tools.cql.map</filename>
-   </para>
-   <para>
-    The Zebra software is Copyright <command>Index Data</command> 
-    <filename>http://www.indexdata.dk</filename>
-    and distributed under the
-    GPLv2 license.
-   </para> 
-  </refsect1>
-</refentry>
-
-<!-- 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
-End:
--->

diff --git a/doc/zebrasrv-man.xml b/doc/zebrasrv-man.xml
new file mode 100644 (file)
index 0000000..ae8ff7c
--- /dev/null
+++ b/doc/zebrasrv-man.xml
@@ -0,0 +1,138 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" 
+ "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+[
+     <!ENTITY zebrasrv-synopsis SYSTEM "zebrasrv-synopsis.xml">
+     <!ENTITY zebrasrv-options SYSTEM "zebrasrv-options.xml">
+     <!ENTITY zebrasrv-virtual SYSTEM "zebrasrv-virtual.xml">
+     <!ENTITY gfs-synopsis-app "zebrasrv">
+     <!ENTITY reference-tools-cql-map 'section "Specifiction of CQL to RPN mappings"'>
+]>
+
+     <!-- <!ENTITY zebrasrv-commands SYSTEM "zebrasrv-commands.xml"> -->
+
+
+<!-- $Id: zebrasrv-man.xml,v 1.1 2006-05-24 19:12:46 adam Exp $ -->
+<refentry id="zebrasrv">
+ 
+ <refmeta>
+  <refentrytitle>zebrasrv</refentrytitle>
+  <manvolnum>8</manvolnum>
+ </refmeta>
+ 
+ <refnamediv>
+  <refname>zebrasrv</refname>
+  <refpurpose>Zebra Server</refpurpose>
+ </refnamediv>
+  
+ <refsynopsisdiv>
+  <!--
+  <cmdsynopsis>
+   <command>zebrasrv</command>
+   <arg choice="opt"><option>-a <replaceable>file</replaceable></option></arg>
+   <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
+   <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
+   <arg choice="opt"><option>-u <replaceable>uid</replaceable></option></arg>
+   <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
+   <arg choice="opt"><option>-t <replaceable>minutes</replaceable></option></arg>
+   <arg choice="opt"><option>-k <replaceable>kilobytes</replaceable></option></arg>
+   <arg choice="opt"><option>-d <replaceable>daemon</replaceable></option></arg>
+   <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
+   <arg choice="opt"><option>-ziST1</option></arg>
+   <arg choice="opt" rep="repeat">listener-spec</arg>
+  </cmdsynopsis>
+  -->
+  &zebrasrv-synopsis;
+ </refsynopsisdiv>
+  <refsect1><title>DESCRIPTION</title>
+    <para>Zebra is a high-performance, general-purpose structured text indexing
+   and retrieval engine. It reads structured records in a variety of input
+   formats (eg. email, XML, MARC) and allows access to them through exact
+   boolean search expressions and relevance-ranked free-text queries. 
+   </para>
+   <para>
+    <command>zebrasrv</command> is the Z39.50 and SRW/U frontend
+    server for the <command>Zebra</command> indexer.
+   </para> 
+   <para> 
+    On Unix you can run the <command>zebrasrv</command>
+    server from the command line - and put it
+    in the background. It may also operate under the inet daemon.
+    On WIN32 you can run the server as a console application or
+    as a WIN32 Service.
+   </para>
+  </refsect1>
+ <!--
+ <refsect1>
+   <title>COMMANDS</title>
+  &zebrasrv-commands;
+ </refsect1>
+ -->
+  <refsect1>
+   <title>OPTIONS</title>
+    
+   <para>
+    The options for <command>zebrasrv</command> are the same
+    as those for YAZ' <command>yaz-ztest</command>.
+    Option <literal>-c</literal> specifies a Zebra configuration
+    file - if omitted <filename>zebra.cfg</filename> is read.
+   </para>
+   
+  &zebrasrv-options;
+  </refsect1>
+  <refsect1><title>VIRTUAL HOSTS</title>
+    <para>
+     <command>zebrasrv</command> uses the YAZ server
+    </para>
+    &zebrasrv-virtual;
+  </refsect1>
+  <refsect1><title>FILES</title>
+   <para>
+    <filename>zebra.cfg</filename>
+   </para>
+  </refsect1>
+  <refsect1><title>SEE ALSO</title>
+   <para>
+    <citerefentry>
+     <refentrytitle>zebraidx</refentrytitle>
+     <manvolnum>1</manvolnum>
+    </citerefentry>,
+    <citerefentry>
+     <refentrytitle>yaz-ztest</refentrytitle>
+     <manvolnum>8</manvolnum>
+    </citerefentry>
+   </para>
+   <para>
+    Section "The Z39.50 Server" in the Zebra manual.
+    <filename>http://www.indexdata.dk/zebra/doc/server.tkl</filename>
+   </para>
+   <para>
+    Section "Virtual Hosts" in the YAZ manual.
+    <filename>http://www.indexdata.dk/yaz/doc/server.vhosts.tkl</filename>
+   </para>
+   <para>
+    Section "Specification of CQL to RPN mappings" in the YAZ manual.
+    <filename>http://www.indexdata.dk/yaz/doc/tools.tkl#tools.cql.map</filename>
+   </para>
+   <para>
+    The Zebra software is Copyright <command>Index Data</command> 
+    <filename>http://www.indexdata.dk</filename>
+    and distributed under the
+    GPLv2 license.
+   </para> 
+  </refsect1>
+</refentry>
+
+<!-- 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
+End:
+-->

diff --git a/win/zebra.nsi b/win/zebra.nsi
index 2e6b190..059c9bb 100644 (file)
--- a/win/zebra.nsi
+++ b/win/zebra.nsi
@@ -1,4 +1,4 @@
-; $Id: zebra.nsi,v 1.27 2005-08-25 12:53:42 adam Exp $
+; $Id: zebra.nsi,v 1.28 2006-05-24 19:12:47 adam Exp $
 
 !define VERSION "1.4.0"
 !define VS_RUNTIME_LOCATION "c:\Program Files\Microsoft Visual Studio .NET 2003\SDK\v1.1\Bin"
@@ -93,15 +93,12 @@ Section "Zebra Documentation"
        SetOutPath $INSTDIR\doc
        File ..\doc\*.html
        File ..\doc\*.png
-       File ..\doc\*.pdf
        File ..\doc\*.xml
        File ..\doc\*.in
        File ..\doc\*.xsl
        SetOutPath "$SMPROGRAMS\Index Data\Zebra\"
        CreateShortCut "$SMPROGRAMS\Index Data\Zebra\HTML Documentation.lnk" \
-                 "$INSTDIR\doc\zebra.html"
-       CreateShortCut "$SMPROGRAMS\Index Data\Zebra\PDF Documentaion.lnk" \
-                 "$INSTDIR\doc\zebra.pdf"
+                 "$INSTDIR\doc\index.html"
 SectionEnd
 
 Section "Zebra Examples"