From b5e0f092ff4326645b09ddcac88da36008572304 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Wed, 24 May 2006 19:12:46 +0000 Subject: [PATCH] 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. --- buildconf.sh | 9 ++- configure.ac | 3 +- doc/Makefile.am | 30 ++++------ doc/entities.ent | 29 +++++++++ doc/idzebra-config-man.sgml | 129 ---------------------------------------- doc/idzebra-config-man.xml | 131 ++++++++++++++++++++++++++++++++++++++++ doc/zebra.xml.in | 40 +++---------- doc/zebraidx-man.sgml | 100 ------------------------------- doc/zebraidx-man.xml | 99 +++++++++++++++++++++++++++++++ doc/zebrasrv-man.sgml | 136 ------------------------------------------ doc/zebrasrv-man.xml | 138 +++++++++++++++++++++++++++++++++++++++++++ win/zebra.nsi | 7 +-- 12 files changed, 426 insertions(+), 425 deletions(-) create mode 100644 doc/entities.ent delete mode 100644 doc/idzebra-config-man.sgml create mode 100644 doc/idzebra-config-man.xml delete mode 100644 doc/zebraidx-man.sgml create mode 100644 doc/zebraidx-man.xml delete mode 100644 doc/zebrasrv-man.sgml create mode 100644 doc/zebrasrv-man.xml diff --git a/buildconf.sh b/buildconf.sh index 90cc825..21d46ef 100755 --- 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 --- 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 --- 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 index 0000000..a953715 --- /dev/null +++ b/doc/entities.ent @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + +'> +'> +'> +'> diff --git a/doc/idzebra-config-man.sgml b/doc/idzebra-config-man.sgml deleted file mode 100644 index a84ff50..0000000 --- a/doc/idzebra-config-man.sgml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - idzebra-config - 1 - - - - idzebra-config - Script to get information about idzebra - - - - - idzebra-config - - - - - - - libraries - - - - DESCRIPTION - - idzebra-config is a script that returns information - that your own software should use to build software that uses idzebra. - - - - The following libraries are supported: - - - - None (yet) - - - - - OPTIONS - - - - --prefix[=DIR] - - Returns prefix of idzebra or assume a different one if DIR is - specified. - - - - - --version - - Returns version of idzebra. - - - - - --libs - - Library specification be used when linking with idzebra. - - - - - --lalibs - - Return library specification. - - - - - --cflags - - Return C Compiler flags. - - - - - --tabs - - Return directory of idzebra tables. - - - - - - - FILES - - prefix/bin/idzebra-config - - - prefix/lib/libidzebra*.a - - - prefix/include/idzebra/*.h - - - - - - diff --git a/doc/idzebra-config-man.xml b/doc/idzebra-config-man.xml new file mode 100644 index 0000000..69aa9fd --- /dev/null +++ b/doc/idzebra-config-man.xml @@ -0,0 +1,131 @@ + + + + + + idzebra-config + 1 + + + + idzebra-config + Script to get information about idzebra + + + + + idzebra-config + + + + + + + libraries + + + + DESCRIPTION + + idzebra-config is a script that returns information + that your own software should use to build software that uses idzebra. + + + + The following libraries are supported: + + + + None (yet) + + + + + OPTIONS + + + + --prefix[=DIR] + + Returns prefix of idzebra or assume a different one if DIR is + specified. + + + + + --version + + Returns version of idzebra. + + + + + --libs + + Library specification be used when linking with idzebra. + + + + + --lalibs + + Return library specification. + + + + + --cflags + + Return C Compiler flags. + + + + + --tabs + + Return directory of idzebra tables. + + + + + + + FILES + + prefix/bin/idzebra-config + + + prefix/lib/libidzebra*.a + + + prefix/include/idzebra/*.h + + + + + + diff --git a/doc/zebra.xml.in b/doc/zebra.xml.in index 282205f..2ddc219 100644 --- a/doc/zebra.xml.in +++ b/doc/zebra.xml.in @@ -1,37 +1,13 @@ - - - - - - - - - - - - - - - - - - - - - - '> - '> - '> - '> + + %entities; + + %common; ]> - + Zebra - User's Guide and Reference diff --git a/doc/zebraidx-man.sgml b/doc/zebraidx-man.sgml deleted file mode 100644 index d3e5216..0000000 --- a/doc/zebraidx-man.sgml +++ /dev/null @@ -1,100 +0,0 @@ - - - - Zebra - User's Guide - and Reference"> - Local Representation %ref-tail;"> - Record Types %ref-tail;"> - The Zebra Configuration File - %ref-tail;"> - Safe Updating - Using Shadow - Registers %ref-tail;"> -]> - - - - - zebraidx - 1 - - - - zebraidx - Zebra Administrative Tool - - - - - zebraidx - - - - - - - - - - - - - command - file - - - - DESCRIPTION - - zebraidx allows you to insert, delete or updates - records in Zebra. zebraidx accepts a set options - (see below) and exactly one command (mandatory). - - - - COMMANDS - &zebraidx-commands; - - - OPTIONS - &zebraidx-options; - - FILES - - zebra.cfg - - - SEE ALSO - - - zebrasrv - 8 - - - - See "shadow registers" in Zebra manual - - - See "administration" in Zebra manual - - - - - diff --git a/doc/zebraidx-man.xml b/doc/zebraidx-man.xml new file mode 100644 index 0000000..f75cbd6 --- /dev/null +++ b/doc/zebraidx-man.xml @@ -0,0 +1,99 @@ + + + + Zebra - User's Guide + and Reference"> + + + Local Representation"> + Record Types"> + The Zebra Configuration File"> + Safe Updating - Using Shadow + Registers"> +]> + + + + + zebraidx + 1 + + + + zebraidx + Zebra Administrative Tool + + + + + zebraidx + + + + + + + + + + + + + command + file + + + + DESCRIPTION + + zebraidx allows you to insert, delete or updates + records in Zebra. zebraidx accepts a set options + (see below) and exactly one command (mandatory). + + + + COMMANDS + &zebraidx-commands; + + + OPTIONS + &zebraidx-options; + + FILES + + zebra.cfg + + + SEE ALSO + + + zebrasrv + 8 + + + + See "shadow registers" in Zebra manual + + + See "administration" in Zebra manual + + + + + diff --git a/doc/zebrasrv-man.sgml b/doc/zebrasrv-man.sgml deleted file mode 100644 index 701ed74..0000000 --- a/doc/zebrasrv-man.sgml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - -]> - - - - - - - - - zebrasrv - 8 - - - - zebrasrv - Zebra Server - - - - - &zebrasrv-synopsis; - - DESCRIPTION - 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. - - - zebrasrv is the Z39.50 and SRW/U frontend - server for the Zebra indexer. - - - On Unix you can run the zebrasrv - 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. - - - - - OPTIONS - - - The options for zebrasrv are the same - as those for YAZ' yaz-ztest. - Option -c specifies a Zebra configuration - file - if omitted zebra.cfg is read. - - - &zebrasrv-options; - - VIRTUAL HOSTS - - zebrasrv uses the YAZ server - - &zebrasrv-virtual; - - FILES - - zebra.cfg - - - SEE ALSO - - - zebraidx - 1 - , - - yaz-ztest - 8 - - - - Section "The Z39.50 Server" in the Zebra manual. - http://www.indexdata.dk/zebra/doc/server.tkl - - - Section "Virtual Hosts" in the YAZ manual. - http://www.indexdata.dk/yaz/doc/server.vhosts.tkl - - - Section "Specification of CQL to RPN mappings" in the YAZ manual. - http://www.indexdata.dk/yaz/doc/tools.tkl#tools.cql.map - - - The Zebra software is Copyright Index Data - http://www.indexdata.dk - and distributed under the - GPLv2 license. - - - - - diff --git a/doc/zebrasrv-man.xml b/doc/zebrasrv-man.xml new file mode 100644 index 0000000..ae8ff7c --- /dev/null +++ b/doc/zebrasrv-man.xml @@ -0,0 +1,138 @@ + + + + + +]> + + + + + + + + + zebrasrv + 8 + + + + zebrasrv + Zebra Server + + + + + &zebrasrv-synopsis; + + DESCRIPTION + 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. + + + zebrasrv is the Z39.50 and SRW/U frontend + server for the Zebra indexer. + + + On Unix you can run the zebrasrv + 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. + + + + + OPTIONS + + + The options for zebrasrv are the same + as those for YAZ' yaz-ztest. + Option -c specifies a Zebra configuration + file - if omitted zebra.cfg is read. + + + &zebrasrv-options; + + VIRTUAL HOSTS + + zebrasrv uses the YAZ server + + &zebrasrv-virtual; + + FILES + + zebra.cfg + + + SEE ALSO + + + zebraidx + 1 + , + + yaz-ztest + 8 + + + + Section "The Z39.50 Server" in the Zebra manual. + http://www.indexdata.dk/zebra/doc/server.tkl + + + Section "Virtual Hosts" in the YAZ manual. + http://www.indexdata.dk/yaz/doc/server.vhosts.tkl + + + Section "Specification of CQL to RPN mappings" in the YAZ manual. + http://www.indexdata.dk/yaz/doc/tools.tkl#tools.cql.map + + + The Zebra software is Copyright Index Data + http://www.indexdata.dk + and distributed under the + GPLv2 license. + + + + + diff --git a/win/zebra.nsi b/win/zebra.nsi index 2e6b190..059c9bb 100644 --- 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" -- 1.7.10.4