diff options
author | Gaetan Nadon <memsize@videotron.ca> | 2011-03-02 14:33:07 -0500 |
---|---|---|
committer | Gaetan Nadon <memsize@videotron.ca> | 2011-03-31 09:29:43 -0400 |
commit | 7f8345aa6fb60a7fd7adf0095a2354fad1d8d5ef (patch) | |
tree | ea4c0eb63656d29aadd10f2ff9627157b349b4b9 /devbook.am | |
parent | 77027deabca37183cfbbed107cf14ca80f29f26d (diff) |
doc: use common makefile for developers documentation
The user/specs docs now have external references support.
Developers doc are not installed so they do not participate.
However, using a similar makefile shared amongst developers
document reduces maintenance and is forward looking.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Diffstat (limited to 'devbook.am')
-rw-r--r-- | devbook.am | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/devbook.am b/devbook.am new file mode 100644 index 0000000..62f4829 --- /dev/null +++ b/devbook.am @@ -0,0 +1,61 @@ +# +# Generate output formats for a single DocBook/XML with/without chapters +# +# Variables set by the calling Makefile: +# noinst_DATA: developers docs are not installed +# 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 Developers Documentation and is not installed. +# Do not use for Users docs or Specs which need to be installed and require olink support +# Refer to http://www.x.org/releases/X11R7.6/doc/xorg-docs/ReleaseNotes.html#id2584393 +# for an explanation on documents classification. +# + +# Developers documnetation is not installed +noinst_DATA = + +# DocBook/XML file with chapters, appendix and images it includes +dist_noinst_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 +XMLTO_FLAGS = \ + --searchpath "$(XORG_SGML_PATH)/X11" \ + --stringparam current.docid="$(<:.xml=)" + +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 + +noinst_DATA += $(docbook:.xml=.html) +%.html: %.xml $(chapters) + $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) $(XMLTO_XHTML_FLAGS) xhtml-nochunks $< + +if HAVE_FOP +noinst_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 +noinst_DATA += $(docbook:.xml=.txt) +%.txt: %.xml $(chapters) + $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) $(XMLTO_XHTML_FLAGS) txt $< +endif HAVE_XMLTO_TEXT + +CLEANFILES = $(noinst_DATA) |