From c3db1e5bdc42eb3ba6c50d18b200e7c816ee6e9e Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Wed, 24 May 2006 12:33:21 +0000 Subject: [PATCH] Documentation for YAZ is now based on the Docbook XML/XSLT using xsltproc + N Walsh's stylesheets. It means that the CVS version of YAZ 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. --- NEWS | 6 ++++++ configure.ac | 3 ++- debian/control | 2 +- doc/Makefile.am | 28 ++++++++++++++-------------- doc/yaz-asncomp-man.xml | 4 +++- doc/yaz-client-man.xml | 6 ++++-- doc/yaz-iconv-man.xml | 6 ++++-- doc/yaz-log-man.xml | 6 ++++-- doc/yaz-man.xml | 8 +++++--- doc/yaz-marcdump-man.xml | 7 +++++-- doc/zoomsh-man.xml | 6 ++++-- win/yaz.nsi | 9 +++------ 12 files changed, 55 insertions(+), 36 deletions(-) diff --git a/NEWS b/NEWS index 2ea643a..eedd7f9 100644 --- a/NEWS +++ b/NEWS @@ -1,3 +1,9 @@ +Documentation for YAZ is now based on the Docbook XML/XSLT using +xsltproc + N Walsh's stylesheets. It means that the CVS version of YAZ +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. + Added retrieval handling support in Generic Frontend Server to support conversion between MARC/XML as well as XSLTtransforms. See etc/yazgfs.xml for an example. diff --git a/configure.ac b/configure.ac index 2254960..a338509 100644 --- a/configure.ac +++ b/configure.ac @@ -1,6 +1,6 @@ dnl YAZ Toolkit, Index Data 1994-2006 dnl See the file LICENSE for details. -dnl $Id: configure.ac,v 1.16 2006-05-23 10:05:28 marc Exp $ +dnl $Id: configure.ac,v 1.17 2006-05-24 12:33:21 adam Exp $ AC_PREREQ(2.59) AC_INIT([yaz],[2.1.19],[adam@indexdata.dk]) AC_CONFIG_SRCDIR(configure.ac) @@ -364,6 +364,7 @@ doc/common/html.dsl doc/common/html.xsl doc/common/print.dsl doc/common/tkl.xsl +doc/common/man.xsl etc/Makefile yaz-config Doxyfile diff --git a/debian/control b/debian/control index 077d466..2791b05 100644 --- a/debian/control +++ b/debian/control @@ -34,7 +34,7 @@ Description: The YAZ Z39.50 toolkit (documentation) YAZ is a toolkit that allows you to develop software using the Z39.50/ISO23950 standard for information retrieval. . - This packages includes documentation for YAZ in HTML and PDF. + This packages includes HTML documentation for YAZ. Package: libyaz-dev Depends: libyaz (= ${Source-Version}), libxslt1-dev, libwrap0-dev, libssl-dev diff --git a/doc/Makefile.am b/doc/Makefile.am index d73de45..dd267cc 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -## $Id: Makefile.am,v 1.67 2006-05-23 19:09:13 adam Exp $ +## $Id: Makefile.am,v 1.68 2006-05-24 12:33:21 adam Exp $ docdir=$(datadir)/doc/@PACKAGE@ @@ -25,7 +25,7 @@ HTMLFILES = \ server.main.html server.vhosts.html \ soap.html soap.http.html soap.xml.html soap.srw.html \ tools.html tools.marc.html tools.nmem.html tools.log.html tools.oid.html \ - yaz.html zoom.events.html zoom.ext.html zoom.html zoom.options.html \ + index.html zoom.events.html zoom.ext.html zoom.html zoom.options.html \ zoom.query.html zoom.records.html zoom.resultsets.html zoom.scan.html MANFILES=yaz-client.1 yaz-ztest.8 \ @@ -37,41 +37,41 @@ REFFILES=yaz-client-man.xml yaz-ztest-man.xml yaz-config-man.xml \ SUPPORTFILES=entities.ent apilayer.obj -doc_DATA = $(HTMLFILES) yaz.pdf apilayer.png +doc_DATA = $(HTMLFILES) apilayer.png man_MANS = $(MANFILES) EXTRA_DIST = $(XMLFILES) $(SUPPORTFILES) $(man_MANS) $(REFFILES) \ $(doc_DATA) yaz-client.1: $(srcdir)/yaz-client-man.xml $(srcdir)/yaz-client-commands.xml - $(DB2MAN_PROG) $(srcdir)/yaz-client-man.xml $@ + xsltproc common/man.xsl $(srcdir)/yaz-client-man.xml yaz-ztest.8: yaz-ztest-man.xml gfs-options.xml gfs-synopsis.xml gfs-virtual.xml - $(DB2MAN_PROG) $(srcdir)/yaz-ztest-man.xml $@ + xsltproc common/man.xsl $(srcdir)/yaz-ztest-man.xml yaz-config.8: yaz-config-man.xml - $(DB2MAN_PROG) $(srcdir)/yaz-config-man.xml $@ + xsltproc common/man.xsl $(srcdir)/yaz-config-man.xml yaz.7: yaz-man.xml - $(DB2MAN_PROG) $(srcdir)/yaz-man.xml $@ + xsltproc common/man.xsl $(srcdir)/yaz-man.xml zoomsh.1: zoomsh-man.xml - $(DB2MAN_PROG) $(srcdir)/zoomsh-man.xml $@ + xsltproc common/man.xsl $(srcdir)/zoomsh-man.xml yaz-asncomp.1: yaz-asncomp-man.xml - $(DB2MAN_PROG) $(srcdir)/yaz-asncomp-man.xml $@ + xsltproc common/man.xsl $(srcdir)/yaz-asncomp-man.xml yaz-marcdump.1: yaz-marcdump-man.xml - $(DB2MAN_PROG) $(srcdir)/yaz-marcdump-man.xml $@ + xsltproc common/man.xsl $(srcdir)/yaz-marcdump-man.xml yaz-iconv.1: yaz-iconv-man.xml - $(DB2MAN_PROG) $(srcdir)/yaz-iconv-man.xml $@ + xsltproc common/man.xsl $(srcdir)/yaz-iconv-man.xml yaz-log.7: yaz-log-man.xml - $(DB2MAN_PROG) $(srcdir)/yaz-log-man.xml $@ + xsltproc common/man.xsl $(srcdir)/yaz-log-man.xml -$(HTMLFILES): $(XMLFILES) - jade -E14 -D $(srcdir) -d common/html.dsl -t sgml $(srcdir)/common/xml.dcl yaz.xml +$(HTMLFILES): $(XMLFILES) + xsltproc common/html.xsl $(srcdir)/yaz.xml yaz.pdf: $(XMLFILES) if test ! -f common/id.png ; then cp $(srcdir)/common/id.png common; fi diff --git a/doc/yaz-asncomp-man.xml b/doc/yaz-asncomp-man.xml index f39207f..c249b9b 100644 --- a/doc/yaz-asncomp-man.xml +++ b/doc/yaz-asncomp-man.xml @@ -1,4 +1,6 @@ - diff --git a/doc/yaz-client-man.xml b/doc/yaz-client-man.xml index 9959754..422dcae 100644 --- a/doc/yaz-client-man.xml +++ b/doc/yaz-client-man.xml @@ -1,9 +1,11 @@ - %common; ]> - + diff --git a/doc/yaz-iconv-man.xml b/doc/yaz-iconv-man.xml index 935fedb..5e52ddc 100644 --- a/doc/yaz-iconv-man.xml +++ b/doc/yaz-iconv-man.xml @@ -1,5 +1,7 @@ - - + + yaz-iconv diff --git a/doc/yaz-log-man.xml b/doc/yaz-log-man.xml index 0e78f36..816d7c7 100644 --- a/doc/yaz-log-man.xml +++ b/doc/yaz-log-man.xml @@ -1,5 +1,7 @@ - - + + yaz-log diff --git a/doc/yaz-man.xml b/doc/yaz-man.xml index d129516..093493d 100644 --- a/doc/yaz-man.xml +++ b/doc/yaz-man.xml @@ -1,8 +1,10 @@ - %common; ]> - + yaz @@ -10,7 +12,7 @@ - YAZ + yaz Z39.50 toolkit. diff --git a/doc/yaz-marcdump-man.xml b/doc/yaz-marcdump-man.xml index b7e008d..d2d1ad9 100644 --- a/doc/yaz-marcdump-man.xml +++ b/doc/yaz-marcdump-man.xml @@ -1,5 +1,8 @@ - - + + yaz-marcdump diff --git a/doc/zoomsh-man.xml b/doc/zoomsh-man.xml index dcc2001..eb831c2 100644 --- a/doc/zoomsh-man.xml +++ b/doc/zoomsh-man.xml @@ -1,7 +1,9 @@ - ]> - + diff --git a/win/yaz.nsi b/win/yaz.nsi index ebc4174..9da442e 100644 --- a/win/yaz.nsi +++ b/win/yaz.nsi @@ -1,4 +1,4 @@ -; $Id: yaz.nsi,v 1.82 2006-05-03 13:27:20 adam Exp $ +; $Id: yaz.nsi,v 1.83 2006-05-24 12:33:22 adam Exp $ !define VERSION "2.1.19" !define VS_RUNTIME_LOCATION "c:\Program Files\Microsoft Visual Studio .NET 2003\SDK\v1.1\Bin" @@ -122,15 +122,12 @@ Section "YAZ Documentation" YAZ_Documentation File /r ..\doc\*.dsl File /r ..\doc\*.ent File /r ..\doc\*.html - File /r ..\doc\*.pdf File /r ..\doc\*.xml File /r ..\doc\*.png File /r ..\doc\*.xsl SetOutPath $SMPROGRAMS\YAZ CreateShortCut "$SMPROGRAMS\YAZ\HTML Documentation.lnk" \ - "$INSTDIR\doc\yaz.html" - CreateShortCut "$SMPROGRAMS\YAZ\PDF Documentaion.lnk" \ - "$INSTDIR\doc\yaz.pdf" + "$INSTDIR\doc\index.html" SectionEnd Section "YAZ Source" YAZ_Source @@ -180,7 +177,7 @@ SectionEnd ;Language strings LangString DESC_YAZ_Runtime ${LANG_ENGLISH} "YAZ runtime files needed in order for YAZ to run, such as DLLs." LangString DESC_YAZ_Development ${LANG_ENGLISH} "Header files and import libraries required for developing software using YAZ." -LangString DESC_YAZ_Documentation ${LANG_ENGLISH} "YAZ Users' guide and reference in HTML and PDF. Describes both YAZ applications and the API." +LangString DESC_YAZ_Documentation ${LANG_ENGLISH} "YAZ Users' guide and reference in HTML. Describes both YAZ applications and the API." LangString DESC_YAZ_Source ${LANG_ENGLISH} "Source code of YAZ. Required if you need to rebuild YAZ (for debugging purposes)." ;Assign language strings to sections -- 1.7.10.4