Added Docbook stuff for doc. Moved pazpar2-man.xml to doc/pazpar2.xml.

Started skeleton User guide and reference (book.xml).

diff --git a/Makefile.am b/Makefile.am
index f0647d2..eb2fc40 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,7 +1,7 @@
 AUTOMAKE_OPTIONS = foreign
 ACLOCAL_AMFLAGS = -I m4
 
-SUBDIRS = src 
+SUBDIRS = src doc
 
 EXTRA_DIST = README PROTOCOL m4/yaz.m4 
 

diff --git a/configure.ac b/configure.ac
index 45b5f22..d801361 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -26,6 +26,11 @@ YAZ_DOC
 AC_CONFIG_FILES([
        Makefile
        src/Makefile
+       doc/Makefile
+       doc/local.ent
+       doc/common/Makefile
+       doc/common/print.dsl
+
 ])
 
 AC_OUTPUT

diff --git a/doc/.cvsignore b/doc/.cvsignore
new file mode 100644 (file)
index 0000000..9be605d
--- /dev/null
+++ b/doc/.cvsignore
@@ -0,0 +1,16 @@
+Makefile
+Makefile.in
+*.html
+pazpar2.tex
+pazpar2.aux
+pazpar2.log
+pazpar2.out
+pazpar2.pdf
+*.tkl
+manpage.links
+manpage.refs
+pazpar2.1
+local.ent
+htmlhelp.hhp
+toc.hhc
+manref.xml

diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644 (file)
index 0000000..f483918
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,68 @@
+## $Id: Makefile.am,v 1.1 2007-01-10 09:44:20 adam Exp $
+docdir=$(datadir)/doc/@PACKAGE@
+
+SUBDIRS = common
+
+SUFFIXES=.3 .1 .pdf .tkl .esp .xml 
+
+XMLFILES = book.xml manref.xml
+
+MAINXML = $(srcdir)/book.xml
+
+XMLMAN = pazpar2.xml
+
+SUPPORTFILES = entities.ent local.ent.in
+
+MANFILES = pazpar2.1
+
+HTMLFILES = index.html
+
+PNGFILES =
+
+doc_DATA = $(HTMLFILES) $(PNGFILES)
+man_MANS = $(MANFILES)
+
+EXTRA_DIST = $(XMLFILES) $(XMLMAN) $(doc_DATA) $(man_MANS)
+
+$(HTMLFILES): $(XMLFILES) $(PNGFILES)
+       rm -f *.html
+       $(HTML_COMPILE) $(MAINXML)
+
+.xml.1:
+       $(MAN_COMPILE) $<
+
+index.tkl: $(XMLFILES)
+       $(TKL_COMPILE) $(MAINXML)
+
+pazpar2.pdf: $(XMLFILES)
+       jade -E14 -D $(srcdir) -d common/print.dsl -t tex $(srcdir)/common/xml.dcl $(MAINXML)
+       rm -f pazpar2.tex
+       mv book.tex pazpar2.tex
+       pdfjadetex pazpar2.tex >/dev/null
+       pdfjadetex pazpar2.tex >/dev/null
+       pdfjadetex pazpar2.tex >/dev/null
+
+manref.xml: $(XMLMAN) $(srcdir)/common/stripref.xsl
+       rm -f manref.xml
+       for i in $(XMLMAN); do \
+               xsltproc $(srcdir)/common/stripref.xsl $(srcdir)/$$i | sed 1d >> manref.xml; \
+       done
+
+clean-data-hook:
+       rm -f [0-9]* *.bak
+
+dist-hook:
+       if test -f index.html; then d=.; else d="$(srcdir)"; fi; \
+       for p in $$d/*.html; do \
+               cp $$p $(distdir); \
+       done
+
+install-data-hook:
+       if test -f index.html; then d=.; else d="$(srcdir)"; fi; \
+       for p in $$d/*.html; do \
+               $(docDATA_INSTALL) $$p $(DESTDIR)/$(docdir); \
+       done
+
+uninstall-hook:
+       rm -r $(DESTDIR)/$(docdir)
+

diff --git a/doc/book.xml b/doc/book.xml
new file mode 100644 (file)
index 0000000..27256cd
--- /dev/null
+++ b/doc/book.xml
@@ -0,0 +1,147 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1//EN"
+    "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" 
+[
+     <!ENTITY % local SYSTEM "local.ent">
+     %local;
+     <!ENTITY % entities SYSTEM "entities.ent">
+     %entities;
+     <!ENTITY % common SYSTEM "common/common.ent">
+     %common;
+]>
+<!-- $Id: book.xml,v 1.1 2007-01-10 09:44:20 adam Exp $ -->
+<book id="book">
+ <bookinfo>
+  <title>pazpar2 - User's Guide and Reference</title>
+  <author>
+   <firstname>Sebastian</firstname><surname>Hammer</surname>
+  </author>
+  <copyright>
+   <year>&copyright-year;</year>
+   <holder>Index Data</holder>
+  </copyright>
+  <abstract>
+   <simpara>
+    pazpar2 - High-performance, user-interface 
+    user-interface independtent metasearching middleware.
+   </simpara>
+   <simpara>
+    This document is a guide and reference to pazpar version &version;.
+   </simpara>
+   <simpara>
+    <inlinemediaobject>
+     <imageobject>
+      <imagedata fileref="common/id.png" format="PNG"/>
+     </imageobject>
+     <imageobject>
+      <imagedata fileref="common/id.eps" format="EPS"/>
+     </imageobject>
+    </inlinemediaobject>
+   </simpara>
+  </abstract>
+ </bookinfo>
+
+ <chapter id="introduction">
+  <title>Introduction</title>
+  
+  <para>
+   <ulink url="&url.pazpar2;">pazpar2</ulink> is.. To be written.
+  </para>
+ </chapter>
+
+ <chapter id="license">
+  <title>pazpar2 License</title>
+  <para>To be decided and written.</para>
+ </chapter>
+ 
+ <chapter id="installation">
+  <title>Installation</title>
+  <para>
+   pazpar2 depends on the following tools/libraries:
+   <variablelist>
+    <varlistentry><term><ulink url="&url.yaz;">YAZ</ulink></term>
+     <listitem>
+      <para>
+       The popular Z39.50 toolkit for the C language. YAZ must be
+       compiled with Libxml2/Libxslt support.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+  <para>
+   In order to compile pazpar2 an ANSI C compiler is
+   required. The requirements should be the same as for YAZ.
+  </para>
+
+  <section id="installation.unix">
+   <title>Installation on Unix (from Source)</title>
+   <para>
+    Here is a quick step-by-step guide on how to compile the
+    tools that pazpar2 uses. Only few systems have none of the required
+    tools binary packages. If, for example, Libxml2/libxslt are already
+    installed as development packages use those (and omit compilation).
+   </para>
+   
+   <para>
+    Ensure that the development libraries + header files are
+    available on your system before compiling pazpar2. For installation
+    of YAZ, refer to the YAZ installation chapter.
+   </para>
+   <screen>
+    gunzip -c pazpar2-version.tar.gz|tar xf -
+    cd pazpar2-version
+    ./configure
+    make
+    su
+    make install
+   </screen>
+  </section>
+
+  <section id="installation.debian">
+   <title>Installation on Debian GNU/Linux</title>
+   <para>
+    All dependencies for pazpar2 are available as 
+    <ulink url="&url.debian;">Debian</ulink>
+    packages for the sarge (stable in 2005) and etch (testing in 2005)
+    distributions.
+   </para>
+   <para>
+    The procedures for Debian based systems, such as
+    <ulink url="&url.ubuntu;">Ubuntu</ulink> is probably similar
+   </para>
+   <screen>
+    apt-get install libyaz-dev
+   </screen>
+   <para>
+    With these packages installed, the usual configure + make
+    procedure can be used for pazpar2 as outlined in
+    <xref linkend="installation.unix"/>.
+   </para>
+  </section>
+ </chapter>
+ 
+ <reference id="refguide">
+  <title>Reference guide</title>
+    <para>
+     The material in this chapter is drawn directly from the individual
+     manual entries.
+    </para>
+    &manref;
+ </reference>
+</book>
+
+ <!-- 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/entities.ent b/doc/entities.ent
new file mode 100644 (file)
index 0000000..14c8fe3
--- /dev/null
+++ b/doc/entities.ent
@@ -0,0 +1,5 @@
+<!-- $Id: entities.ent,v 1.1 2007-01-10 09:44:20 adam Exp $ -->
+<!-- Manually edited stuff used for all package documentation -->
+<!ENTITY copyright-year "2007">
+<!ENTITY manref SYSTEM "manref.xml">
+

diff --git a/doc/local.ent.in b/doc/local.ent.in
new file mode 100644 (file)
index 0000000..954bf7a
--- /dev/null
+++ b/doc/local.ent.in
@@ -0,0 +1,4 @@
+<!-- $Id: local.ent.in,v 1.1 2007-01-10 09:44:20 adam Exp $ -->
+<!-- Modified by configure. Do not edit. Use pazpar2.ent insteas -->
+<!ENTITY version "@VERSION@">
+<!ENTITY prefix "@prefix@">

diff --git a/doc/pazpar2.xml b/doc/pazpar2.xml
new file mode 100644 (file)
index 0000000..825db7a
--- /dev/null
+++ b/doc/pazpar2.xml
@@ -0,0 +1,60 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+[
+     <!ENTITY % local SYSTEM "local.ent">
+     %local;
+     <!ENTITY % entities SYSTEM "entities.ent">
+     %entities;
+     <!ENTITY % common SYSTEM "common/common.ent">
+     %common;
+]>
+<!-- $Id: pazpar2.xml,v 1.1 2007-01-10 09:44:20 adam Exp $ -->
+<refentry id="pazpar2">
+ <refentryinfo>
+  <productname>pazpar2</productname>
+  <productnumber>&version;</productnumber>
+ </refentryinfo>
+ <refmeta>
+  <refentrytitle>Pazpar2</refentrytitle>
+  <manvolnum>1</manvolnum>
+ </refmeta>
+ 
+ <refnamediv>
+  <refname>pazpar2</refname>
+  <refpurpose>High-performance, user-interface independtent  metasearching
+         middleware</refpurpose>
+ </refnamediv>
+ 
+ <refsynopsisdiv>
+  <cmdsynopsis>
+   <command>pazpar2</command>
+  </cmdsynopsis>
+ </refsynopsisdiv>
+ 
+ <refsect1><title>DESCRIPTION</title>
+ </refsect1>
+ 
+ <refsect1><title>OPTIONS</title>
+ </refsect1>
+
+ <refsect1><title>EXAMPLES</title>
+ </refsect1> 
+
+ <refsect1><title>FILES</title>
+ </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/pazpar2-man.xml b/pazpar2-man.xml
deleted file mode 100644 (file)
index 5659186..0000000
--- a/pazpar2-man.xml
+++ /dev/null
@@ -1,59 +0,0 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
-[
-     <!ENTITY % local SYSTEM "local.ent">
-     %local;
-     <!ENTITY % entities SYSTEM "entities.ent">
-     %entities;
-     <!ENTITY % common SYSTEM "common/common.ent">
-     %common;
-]>
-<!-- $Id: pazpar2-man.xml,v 1.1 2007-01-10 05:46:43 quinn Exp $ -->
-<refentry id="pazpar2">
- <refentryinfo>
-  <productname>Pazpar2</productname>
-  <productnumber>&version;</productnumber>
- </refentryinfo>
- <refmeta>
-  <refentrytitle>Pazpar2</refentrytitle>
-  <manvolnum>1</manvolnum>
- </refmeta>
- 
- <refnamediv>
-  <refname>Pazpar2</refname>
-  <refpurpose>High-performance, user-interface independtent  metasearching
-         middleware</refpurpose>
- </refnamediv>
- 
- <refsynopsisdiv>
-  <cmdsynopsis>
-   <command>pazpar2</command>
-  </cmdsynopsis>
- </refsynopsisdiv>
- 
- <refsect1><title>DESCRIPTION</title>
- </refsect1>
- 
- <refsect1><title>OPTIONS</title>
- </refsect1>
-
- <refsect1><title>EXAMPLES</title>
- </refsect1> 
-
- <refsect1><title>FILES</title>
-</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:
--->