Re: [PATCH xorg-docs 1/2] Documentation: add Docbook external references support
On Tue, 2011-03-22 at 17:45 -0600, Matt Dew wrote: Maybe an addendum that says this is for formats that support links. Something like... This feature works with PDF, HTML, PS (and epub?) generated documents and will generate links to the other versions of the same type. IE, html docs will link to other html docs, and pdf docs will link to other pdf docs. Done signature.asc Description: This is a digitally signed message part ___ xorg-devel@lists.x.org: X.Org development Archives: http://lists.x.org/archives/xorg-devel Info: http://lists.x.org/mailman/listinfo/xorg-devel
[PATCH xorg-docs 1/2] Documentation: add Docbook external references support
When writing technical documentation, it is often necessary to cross reference to other information. When that other information is not in the current document, additional support is needed, namely olink. A new feature with version 1.7 of xorg-sgml-doctools adds references to other documents within or outside this package. This patch adds technical support for this feature but does not change the content of the documentation as seen by the end user. Each book or article must generate a database containing the href of sections that can be referred to from another document. This database is installed in DATAROOTDIR/sgml/X11/dbs. There is a requirement that the value of DATAROOTDIR for xorg-sgml-doctools and for the package documentation is the same. This forms a virtual document tree. This database is consulted by other documents while they are being generated in order to fulfill the missing information for linking. Refer to the xorg-sgml-doctools for further technical information. Co-authored-by: Matt Dew mar...@osource.org Signed-off-by: Gaetan Nadon mems...@videotron.ca --- .gitignore|1 + configure.ac |9 ++-- docbook.am| 95 + general/Makefile.am | 18 +--- general/fonts/Makefile.am | 13 -- general/graphics/Makefile.am | 13 -- general/input/Makefile.am | 13 -- general/platforms/Makefile.am | 15 --- specs/CTEXT/Makefile.am | 14 -- specs/ICCCM/Makefile.am | 14 -- specs/XLFD/Makefile.am| 14 -- specs/Xext/Makefile.am| 14 -- specs/Xserver/Makefile.am | 14 -- xmlrules.in | 65 14 files changed, 198 insertions(+), 114 deletions(-) create mode 100644 docbook.am delete mode 100644 xmlrules.in diff --git a/.gitignore b/.gitignore index a8719d3..04042e4 100644 --- a/.gitignore +++ b/.gitignore @@ -80,3 +80,4 @@ core *.ps *.pdf *.txt +*.db diff --git a/configure.ac b/configure.ac index fc9b8b8..615d31a 100644 --- a/configure.ac +++ b/configure.ac @@ -32,14 +32,15 @@ AC_CONFIG_SRCDIR([Makefile.am]) AM_INIT_AUTOMAKE([foreign dist-bzip2]) AM_MAINTAINER_MODE -# Require xorg-macros minimum of 1.10 for DocBook XML documentation +# Require xorg-macros minimum of 1.12 for DocBook XML documentation m4_ifndef([XORG_MACROS_VERSION], - [m4_fatal([must install xorg-macros 1.10 or later before running autoconf/autogen])]) -XORG_MACROS_VERSION(1.10) + [m4_fatal([must install xorg-macros 1.12 or later before running autoconf/autogen])]) +XORG_MACROS_VERSION(1.12) XORG_DEFAULT_OPTIONS XORG_ENABLE_DOCS XORG_ENABLE_SPECS -XORG_WITH_XMLTO(0.0.20) +XORG_WITH_XMLTO(0.0.22) +XORG_WITH_XSLTPROC XORG_WITH_FOP XORG_CHECK_SGML_DOCTOOLS(1.5) diff --git a/docbook.am b/docbook.am new file mode 100644 index 000..10d0053 --- /dev/null +++ b/docbook.am @@ -0,0 +1,95 @@ +# +# Generate output formats for a single DocBook/XML with/without chapters +# +# Variables set by the calling Makefile: +# shelfdir: the location where the docs/specs are installed. Typically $(docdir) +# docbook: the main DocBook/XML file, no chapters, appendix or image files +# chapters: all files pulled in by an XInclude statement and images. +# + +# +# This makefile is intended for Users Documentation and Functional Specifications. +# Do not use for Developer Documentation which is not installed and does not require olink. +# Refer to http://www.x.org/releases/X11R7.6/doc/xorg-docs/ReleaseNotes.html#id2584393 +# for an explanation on documents classification. +# + +# DocBook/XML generated output formats to be installed +shelf_DATA = + +# DocBook/XML file with chapters, appendix and images it includes +dist_shelf_DATA = $(docbook) $(chapters) + +# +# Generate DocBook/XML output formats with or without stylesheets +# + +# Stylesheets are available if the package xorg-sgml-doctools is installed +if HAVE_STYLESHEETS + +# The location where all cross reference databases are installed +sgmldbsdir = $(XORG_SGML_PATH)/X11/dbs +masterdb = $(sgmldbsdir)/masterdb$(suffix $@).xml +XMLTO_FLAGS = \ + --searchpath $(XORG_SGML_PATH)/X11\ + --stringparam target.database.document=$(masterdb) \ + --stringparam current.docid=$(:.xml=)\ + --stringparam collect.xref.targets=no + +XMLTO_XHTML_FLAGS = \ + -m $(STYLESHEET_SRCDIR)/xorg-xhtml.xsl \ + --stringparam html.stylesheet=$(STYLESHEET_SRCDIR)/xorg.css + +XMLTO_FO_FLAGS = \ + -m $(STYLESHEET_SRCDIR)/xorg-fo.xsl +endif HAVE_STYLESHEETS + +shelf_DATA += $(docbook:.xml=.html) +%.html: %.xml $(chapters) + $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) $(XMLTO_XHTML_FLAGS) xhtml-nochunks $ + +if HAVE_FOP +shelf_DATA += $(docbook:.xml=.pdf) $(docbook:.xml=.ps) +%.pdf: %.xml $(chapters) +
Re: [PATCH xorg-docs 1/2] Documentation: add Docbook external references support
On 03/22/2011 08:19 AM, Gaetan Nadon wrote: When writing technical documentation, it is often necessary to cross reference to other information. When that other information is not in the current document, additional support is needed, namelyolink. A new feature with version 1.7 of xorg-sgml-doctools adds references to other documents within or outside this package. Maybe an addendum that says this is for formats that support links. Something like... This feature works with PDF, HTML, PS (and epub?) generated documents and will generate links to the other versions of the same type. IE, html docs will link to other html docs, and pdf docs will link to other pdf docs. This patch adds technical support for this feature but does not change the content of the documentation as seen by the end user. Each book or article must generate a database containing the href of sections that can be referred to from another document. This database is installed in DATAROOTDIR/sgml/X11/dbs. There is a requirement that the value of DATAROOTDIR for xorg-sgml-doctools and for the package documentation is the same. This forms a virtual document tree. This database is consulted by other documents while they are being generated in order to fulfill the missing information for linking. Refer to the xorg-sgml-doctools for further technical information. Co-authored-by: Matt Dewmar...@osource.org Signed-off-by: Gaetan Nadonmems...@videotron.ca --- .gitignore|1 + configure.ac |9 ++-- docbook.am| 95 + general/Makefile.am | 18 +--- general/fonts/Makefile.am | 13 -- general/graphics/Makefile.am | 13 -- general/input/Makefile.am | 13 -- general/platforms/Makefile.am | 15 --- specs/CTEXT/Makefile.am | 14 -- specs/ICCCM/Makefile.am | 14 -- specs/XLFD/Makefile.am| 14 -- specs/Xext/Makefile.am| 14 -- specs/Xserver/Makefile.am | 14 -- xmlrules.in | 65 14 files changed, 198 insertions(+), 114 deletions(-) create mode 100644 docbook.am delete mode 100644 xmlrules.in diff --git a/.gitignore b/.gitignore index a8719d3..04042e4 100644 --- a/.gitignore +++ b/.gitignore @@ -80,3 +80,4 @@ core *.ps *.pdf *.txt +*.db diff --git a/configure.ac b/configure.ac index fc9b8b8..615d31a 100644 --- a/configure.ac +++ b/configure.ac @@ -32,14 +32,15 @@ AC_CONFIG_SRCDIR([Makefile.am]) AM_INIT_AUTOMAKE([foreign dist-bzip2]) AM_MAINTAINER_MODE -# Require xorg-macros minimum of 1.10 for DocBook XML documentation +# Require xorg-macros minimum of 1.12 for DocBook XML documentation m4_ifndef([XORG_MACROS_VERSION], - [m4_fatal([must install xorg-macros 1.10 or later before running autoconf/autogen])]) -XORG_MACROS_VERSION(1.10) + [m4_fatal([must install xorg-macros 1.12 or later before running autoconf/autogen])]) +XORG_MACROS_VERSION(1.12) XORG_DEFAULT_OPTIONS XORG_ENABLE_DOCS XORG_ENABLE_SPECS -XORG_WITH_XMLTO(0.0.20) +XORG_WITH_XMLTO(0.0.22) +XORG_WITH_XSLTPROC XORG_WITH_FOP XORG_CHECK_SGML_DOCTOOLS(1.5) diff --git a/docbook.am b/docbook.am new file mode 100644 index 000..10d0053 --- /dev/null +++ b/docbook.am @@ -0,0 +1,95 @@ +# +# Generate output formats for a single DocBook/XML with/without chapters +# +# Variables set by the calling Makefile: +# shelfdir: the location where the docs/specs are installed. Typically $(docdir) +# docbook: the main DocBook/XML file, no chapters, appendix or image files +# chapters: all files pulled in by an XInclude statement and images. +# + +# +# This makefile is intended for Users Documentation and Functional Specifications. +# Do not use for Developer Documentation which is not installed and does not require olink. +# Refer to http://www.x.org/releases/X11R7.6/doc/xorg-docs/ReleaseNotes.html#id2584393 +# for an explanation on documents classification. +# + +# DocBook/XML generated output formats to be installed +shelf_DATA = + +# DocBook/XML file with chapters, appendix and images it includes +dist_shelf_DATA = $(docbook) $(chapters) + +# +# Generate DocBook/XML output formats with or without stylesheets +# + +# Stylesheets are available if the package xorg-sgml-doctools is installed +if HAVE_STYLESHEETS + +# The location where all cross reference databases are installed +sgmldbsdir = $(XORG_SGML_PATH)/X11/dbs +masterdb = $(sgmldbsdir)/masterdb$(suffix $@).xml +XMLTO_FLAGS = \ + --searchpath $(XORG_SGML_PATH)/X11 \ + --stringparam target.database.document=$(masterdb) \ + --stringparam current.docid=$(:.xml=) \ + --stringparam collect.xref.targets=no + +XMLTO_XHTML_FLAGS = \ + -m $(STYLESHEET_SRCDIR)/xorg-xhtml.xsl \ + --stringparam
