From b4edc17e33ad611f70f231072bedcd2ab6415476 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Wed, 10 Jan 2007 09:44:20 +0000 Subject: [PATCH] Added Docbook stuff for doc. Moved pazpar2-man.xml to doc/pazpar2.xml. Started skeleton User guide and reference (book.xml). --- Makefile.am | 2 +- configure.ac | 5 ++ doc/.cvsignore | 16 ++++++ doc/Makefile.am | 68 +++++++++++++++++++++++++ doc/book.xml | 147 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/entities.ent | 5 ++ doc/local.ent.in | 4 ++ doc/pazpar2.xml | 60 ++++++++++++++++++++++ pazpar2-man.xml | 59 ---------------------- 9 files changed, 306 insertions(+), 60 deletions(-) create mode 100644 doc/.cvsignore create mode 100644 doc/Makefile.am create mode 100644 doc/book.xml create mode 100644 doc/entities.ent create mode 100644 doc/local.ent.in create mode 100644 doc/pazpar2.xml delete mode 100644 pazpar2-man.xml diff --git a/Makefile.am b/Makefile.am index f0647d2..eb2fc40 100644 --- 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 --- 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 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 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 index 0000000..27256cd --- /dev/null +++ b/doc/book.xml @@ -0,0 +1,147 @@ + + + %local; + + %entities; + + %common; +]> + + + + pazpar2 - User's Guide and Reference + + SebastianHammer + + + ©right-year; + Index Data + + + + pazpar2 - High-performance, user-interface + user-interface independtent metasearching middleware. + + + This document is a guide and reference to pazpar version &version;. + + + + + + + + + + + + + + + + Introduction + + + pazpar2 is.. To be written. + + + + + pazpar2 License + To be decided and written. + + + + Installation + + pazpar2 depends on the following tools/libraries: + + YAZ + + + The popular Z39.50 toolkit for the C language. YAZ must be + compiled with Libxml2/Libxslt support. + + + + + + + In order to compile pazpar2 an ANSI C compiler is + required. The requirements should be the same as for YAZ. + + +
+ Installation on Unix (from Source) + + 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). + + + + 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. + + + gunzip -c pazpar2-version.tar.gz|tar xf - + cd pazpar2-version + ./configure + make + su + make install + +
+ +
+ Installation on Debian GNU/Linux + + All dependencies for pazpar2 are available as + Debian + packages for the sarge (stable in 2005) and etch (testing in 2005) + distributions. + + + The procedures for Debian based systems, such as + Ubuntu is probably similar + + + apt-get install libyaz-dev + + + With these packages installed, the usual configure + make + procedure can be used for pazpar2 as outlined in + . + +
+ + + + Reference guide + + The material in this chapter is drawn directly from the individual + manual entries. + + &manref; + + + + diff --git a/doc/entities.ent b/doc/entities.ent new file mode 100644 index 0000000..14c8fe3 --- /dev/null +++ b/doc/entities.ent @@ -0,0 +1,5 @@ + + + + + diff --git a/doc/local.ent.in b/doc/local.ent.in new file mode 100644 index 0000000..954bf7a --- /dev/null +++ b/doc/local.ent.in @@ -0,0 +1,4 @@ + + + + diff --git a/doc/pazpar2.xml b/doc/pazpar2.xml new file mode 100644 index 0000000..825db7a --- /dev/null +++ b/doc/pazpar2.xml @@ -0,0 +1,60 @@ + + %local; + + %entities; + + %common; +]> + + + + pazpar2 + &version; + + + Pazpar2 + 1 + + + + pazpar2 + High-performance, user-interface independtent metasearching + middleware + + + + + pazpar2 + + + + DESCRIPTION + + + OPTIONS + + + EXAMPLES + + + FILES + + + + diff --git a/pazpar2-man.xml b/pazpar2-man.xml deleted file mode 100644 index 5659186..0000000 --- a/pazpar2-man.xml +++ /dev/null @@ -1,59 +0,0 @@ - - %local; - - %entities; - - %common; -]> - - - - Pazpar2 - &version; - - - Pazpar2 - 1 - - - - Pazpar2 - High-performance, user-interface independtent metasearching - middleware - - - - - pazpar2 - - - - DESCRIPTION - - - OPTIONS - - - EXAMPLES - - - FILES - - - -- 1.7.10.4