[PATCH xorg-docs 1/1] Documentation: add Docbook external references support
Gaetan Nadon
memsize at videotron.ca
Wed Mar 23 19:00:21 PDT 2011
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 feature works with PDF, HTML, PS (and epub?) generated documents
and will generate links to the other versions of the same type, i.e. 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 Dew <marcoz at osource.org>
Signed-off-by: Gaetan Nadon <memsize at videotron.ca>
---
.gitignore | 1 +
configure.ac | 11 +++--
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, 199 insertions(+), 115 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..ef12a95 100644
--- a/configure.ac
+++ b/configure.ac
@@ -32,16 +32,17 @@ 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 XORG_WITH_XSLTPROC
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)
+XORG_CHECK_SGML_DOCTOOLS(1.7)
AC_CONFIG_FILES([Makefile
general/Makefile
diff --git a/docbook.am b/docbook.am
new file mode 100644
index 0000000..3cf21e8
--- /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 = \
+ -x $(STYLESHEET_SRCDIR)/xorg-xhtml.xsl \
+ --stringparam html.stylesheet=$(STYLESHEET_SRCDIR)/xorg.css
+
+XMLTO_FO_FLAGS = \
+ -x $(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)
+ $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) $(XMLTO_FO_FLAGS) --with-fop pdf $<
+%.ps: %.xml $(chapters)
+ $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) $(XMLTO_FO_FLAGS) --with-fop ps $<
+endif HAVE_FOP
+
+if HAVE_XMLTO_TEXT
+shelf_DATA += $(docbook:.xml=.txt)
+%.txt: %.xml $(chapters)
+ $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) $(XMLTO_XHTML_FLAGS) txt $<
+endif HAVE_XMLTO_TEXT
+
+#
+# Generate documents cross-reference target databases
+#
+
+# This is only possible if the xorg-sgml-doctools package is installed
+if HAVE_STYLESHEETS
+if HAVE_XSLTPROC
+
+# DocBook/XML generated document cross-reference database
+sgmldbs_DATA = $(docbook:.xml=.html.db) $(docbook:.xml=.fo.db)
+
+# Generate DocBook/XML document cross-reference database
+# Flags for the XSL Transformation processor generating xref target databases
+XSLTPROC_FLAGS = \
+ --path "$(XORG_SGML_PATH)/X11" \
+ --stringparam targets.filename "$@" \
+ --stringparam collect.xref.targets "only" \
+ --nonet --xinclude
+
+%.html.db: %.xml $(chapters)
+ $(AM_V_GEN)$(XSLTPROC) $(XSLTPROC_FLAGS) \
+ http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl $<
+
+%.fo.db: %.xml $(chapters)
+ $(AM_V_GEN)$(XSLTPROC) $(XSLTPROC_FLAGS) \
+ http://docbook.sourceforge.net/release/xsl/current/fo/docbook.xsl $<
+
+endif HAVE_XSLTPROC
+endif HAVE_STYLESHEETS
+
+CLEANFILES = $(shelf_DATA) $(sgmldbs_DATA)
diff --git a/general/Makefile.am b/general/Makefile.am
index 70f7474..cddb7e1 100644
--- a/general/Makefile.am
+++ b/general/Makefile.am
@@ -2,16 +2,20 @@
SUBDIRS = fonts input graphics platforms
if ENABLE_DOCS
+if HAVE_XMLTO
-doc_sources = \
- License.xml \
- README.xml \
- ReleaseNotes.xml \
+# Main DocBook/XML files (DOCTYPE book)
+docbook = \
+ License.xml \
+ README.xml \
+ ReleaseNotes.xml \
Versions.xml
-xmldir = $(docdir)
-dist_xml_DATA = $(doc_sources)
+# The location where the DocBook/XML files and their generated formats are installed
+shelfdir = $(docdir)
-include $(top_srcdir)/xmlrules.in
+# Generate DocBook/XML output formats with or without stylesheets
+include $(top_srcdir)/docbook.am
+endif HAVE_XMLTO
endif ENABLE_DOCS
diff --git a/general/fonts/Makefile.am b/general/fonts/Makefile.am
index 57f9bd2..d7f0944 100644
--- a/general/fonts/Makefile.am
+++ b/general/fonts/Makefile.am
@@ -1,10 +1,15 @@
+
if ENABLE_DOCS
+if HAVE_XMLTO
-doc_sources = fonts.xml
+# Main DocBook/XML files (DOCTYPE book)
+docbook = fonts.xml
-xmldir = $(docdir)/fonts
-dist_xml_DATA = $(doc_sources)
+# The location where the DocBook/XML files and their generated formats are installed
+shelfdir = $(docdir)/fonts
-include $(top_srcdir)/xmlrules.in
+# Generate DocBook/XML output formats with or without stylesheets
+include $(top_srcdir)/docbook.am
+endif HAVE_XMLTO
endif ENABLE_DOCS
diff --git a/general/graphics/Makefile.am b/general/graphics/Makefile.am
index 542f12c..80cb437 100644
--- a/general/graphics/Makefile.am
+++ b/general/graphics/Makefile.am
@@ -1,10 +1,15 @@
+
if ENABLE_DOCS
+if HAVE_XMLTO
-doc_sources = dps.xml
+# Main DocBook/XML files (DOCTYPE book)
+docbook = dps.xml
-xmldir = $(docdir)/graphics
-dist_xml_DATA = $(doc_sources)
+# The location where the DocBook/XML files and their generated formats are installed
+shelfdir = $(docdir)/graphics
-include $(top_srcdir)/xmlrules.in
+# Generate DocBook/XML output formats with or without stylesheets
+include $(top_srcdir)/docbook.am
+endif HAVE_XMLTO
endif ENABLE_DOCS
diff --git a/general/input/Makefile.am b/general/input/Makefile.am
index 292ed2c..5133f68 100644
--- a/general/input/Makefile.am
+++ b/general/input/Makefile.am
@@ -1,10 +1,15 @@
+
if ENABLE_DOCS
+if HAVE_XMLTO
-doc_sources = XKB-Config.xml XKB-Enhancing.xml
+# Main DocBook/XML files (DOCTYPE book)
+docbook = XKB-Config.xml XKB-Enhancing.xml
-xmldir = $(docdir)/input
-dist_xml_DATA = $(doc_sources)
+# The location where the DocBook/XML files and their generated formats are installed
+shelfdir = $(docdir)/input
-include $(top_srcdir)/xmlrules.in
+# Generate DocBook/XML output formats with or without stylesheets
+include $(top_srcdir)/docbook.am
+endif HAVE_XMLTO
endif ENABLE_DOCS
diff --git a/general/platforms/Makefile.am b/general/platforms/Makefile.am
index 65dbf2a..ee6c806 100644
--- a/general/platforms/Makefile.am
+++ b/general/platforms/Makefile.am
@@ -1,12 +1,15 @@
+
if ENABLE_DOCS
+if HAVE_XMLTO
-doc_sources = \
- Darwin.xml \
- Solaris.xml
+# Main DocBook/XML files (DOCTYPE book)
+docbook = Darwin.xml Solaris.xml
-xmldir = $(docdir)/platforms
-dist_xml_DATA = $(doc_sources)
+# The location where the DocBook/XML files and their generated formats are installed
+shelfdir = $(docdir)/platforms
-include $(top_srcdir)/xmlrules.in
+# Generate DocBook/XML output formats with or without stylesheets
+include $(top_srcdir)/docbook.am
+endif HAVE_XMLTO
endif ENABLE_DOCS
diff --git a/specs/CTEXT/Makefile.am b/specs/CTEXT/Makefile.am
index 9492c4a..f4a1a90 100644
--- a/specs/CTEXT/Makefile.am
+++ b/specs/CTEXT/Makefile.am
@@ -1,9 +1,15 @@
+
if ENABLE_SPECS
+if HAVE_XMLTO
+
+# Main DocBook/XML files (DOCTYPE book)
+docbook = ctext.xml
-xmldir = $(docdir)/$(subdir)
-doc_sources = ctext.xml
-dist_xml_DATA = $(doc_sources)
+# The location where the DocBook/XML files and their generated formats are installed
+shelfdir = $(docdir)/ctext
-include $(top_srcdir)/xmlrules.in
+# Generate DocBook/XML output formats with or without stylesheets
+include $(top_srcdir)/docbook.am
+endif HAVE_XMLTO
endif ENABLE_SPECS
diff --git a/specs/ICCCM/Makefile.am b/specs/ICCCM/Makefile.am
index 274a395..9e1fc34 100644
--- a/specs/ICCCM/Makefile.am
+++ b/specs/ICCCM/Makefile.am
@@ -1,9 +1,15 @@
+
if ENABLE_SPECS
+if HAVE_XMLTO
+
+# Main DocBook/XML files (DOCTYPE book)
+docbook = icccm.xml
-xmldir = $(docdir)/$(subdir)
-doc_sources = icccm.xml
-dist_xml_DATA = $(doc_sources)
+# The location where the DocBook/XML files and their generated formats are installed
+shelfdir = $(docdir)/icccm
-include $(top_srcdir)/xmlrules.in
+# Generate DocBook/XML output formats with or without stylesheets
+include $(top_srcdir)/docbook.am
+endif HAVE_XMLTO
endif ENABLE_SPECS
diff --git a/specs/XLFD/Makefile.am b/specs/XLFD/Makefile.am
index 01f9a54..73cd69c 100644
--- a/specs/XLFD/Makefile.am
+++ b/specs/XLFD/Makefile.am
@@ -1,9 +1,15 @@
+
if ENABLE_SPECS
+if HAVE_XMLTO
+
+# Main DocBook/XML files (DOCTYPE book)
+docbook = xlfd.xml
-xmldir = $(docdir)/$(subdir)
-doc_sources = xlfd.xml
-dist_xml_DATA = $(doc_sources)
+# The location where the DocBook/XML files and their generated formats are installed
+shelfdir = $(docdir)/xlfd
-include $(top_srcdir)/xmlrules.in
+# Generate DocBook/XML output formats with or without stylesheets
+include $(top_srcdir)/docbook.am
+endif HAVE_XMLTO
endif ENABLE_SPECS
diff --git a/specs/Xext/Makefile.am b/specs/Xext/Makefile.am
index 6cdb477..1133dfe 100644
--- a/specs/Xext/Makefile.am
+++ b/specs/Xext/Makefile.am
@@ -1,9 +1,15 @@
+
if ENABLE_SPECS
+if HAVE_XMLTO
+
+# Main DocBook/XML files (DOCTYPE book)
+docbook = lbxalg.xml
-xmldir = $(docdir)/$(subdir)
-doc_sources = lbxalg.xml
-dist_xml_DATA = $(doc_sources)
+# The location where the DocBook/XML files and their generated formats are installed
+shelfdir = $(docdir)/xext
-include $(top_srcdir)/xmlrules.in
+# Generate DocBook/XML output formats with or without stylesheets
+include $(top_srcdir)/docbook.am
+endif HAVE_XMLTO
endif ENABLE_SPECS
diff --git a/specs/Xserver/Makefile.am b/specs/Xserver/Makefile.am
index 24e4c95..71d486f 100644
--- a/specs/Xserver/Makefile.am
+++ b/specs/Xserver/Makefile.am
@@ -1,9 +1,15 @@
+
if ENABLE_SPECS
+if HAVE_XMLTO
+
+# Main DocBook/XML files (DOCTYPE book)
+docbook = analysis.xml appgroup.xml secint.xml XACE-Spec.xml
-xmldir = $(docdir)/$(subdir)
-doc_sources = analysis.xml appgroup.xml secint.xml XACE-Spec.xml
-dist_xml_DATA = $(doc_sources)
+# The location where the DocBook/XML files and their generated formats are installed
+shelfdir = $(docdir)/Xserver
-include $(top_srcdir)/xmlrules.in
+# Generate DocBook/XML output formats with or without stylesheets
+include $(top_srcdir)/docbook.am
+endif HAVE_XMLTO
endif ENABLE_SPECS
diff --git a/xmlrules.in b/xmlrules.in
deleted file mode 100644
index 41abb1b..0000000
--- a/xmlrules.in
+++ /dev/null
@@ -1,65 +0,0 @@
-#
-# Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a
-# copy of this software and associated documentation files (the "Software"),
-# to deal in the Software without restriction, including without limitation
-# the rights to use, copy, modify, merge, publish, distribute, sublicense,
-# and/or sell copies of the Software, and to permit persons to whom the
-# Software is furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice (including the next
-# paragraph) shall be included in all copies or substantial portions of the
-# Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
-# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-# DEALINGS IN THE SOFTWARE.
-#
-
-if HAVE_XMLTO
-xml_DATA = $(doc_sources:.xml=.html)
-
-if HAVE_FOP
-xml_DATA += $(doc_sources:.xml=.ps) $(doc_sources:.xml=.pdf)
-endif
-
-if HAVE_XMLTO_TEXT
-xml_DATA += $(doc_sources:.xml=.txt)
-endif
-
-if HAVE_STYLESHEETS
-XMLTO_FLAGS = \
- -m $(XSL_STYLESHEET) \
- --searchpath $(XORG_SGML_PATH)/X11 \
- --stringparam html.stylesheet=$(STYLESHEET_SRCDIR)/xorg.css \
- --stringparam img.src.path=$(abs_builddir)/
-endif
-
-CLEANFILES = $(xml_DATA)
-
-SUFFIXES = .xml .ps .pdf .txt .html
-
-%.txt: %.xml $(dist_xml_DATA)
- $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) txt $<
-
-%.html: %.xml $(dist_xml_DATA)
- $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) xhtml-nochunks $<
-
-%.pdf: %.xml $(dist_xml_DATA)
- $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) --with-fop pdf $<
-
-%.ps: %.xml $(dist_xml_DATA)
- $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) --with-fop ps $<
-
-chunked-html: $(doc_sources)
- $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) -o html xhtml $(doc_sources)
-
-clean-local:
- $(AM_V_GEN)rm -fr html/
-
-endif HAVE_XMLTO
--
1.6.0.4
More information about the xorg-devel
mailing list