diff options
author | Keith Packard <keithp@keithp.com> | 2013-11-18 12:12:54 -0800 |
---|---|---|
committer | Keith Packard <keithp@keithp.com> | 2013-11-18 12:12:54 -0800 |
commit | 963a61986ea4b48fdca0989479e9c50acb0f1a9d (patch) | |
tree | 35597326f461f301226804b2cfd1eff15a207825 | |
parent | 9953a5f0440b269dac5c675f120e6a31dde8ec69 (diff) |
doc: Switch to xorg style to generate index
This style sheet generates a nice PDF index
Signed-off-by: Keith Packard <keithp@keithp.com>
-rw-r--r-- | doc/Makefile | 18 | ||||
-rw-r--r-- | doc/xorg-fo.xsl | 97 |
2 files changed, 105 insertions, 10 deletions
diff --git a/doc/Makefile b/doc/Makefile index 06346a2d..6e326ba5 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -11,29 +11,27 @@ RELNOTES=\ release-notes-1.1.html \ release-notes-1.1.1.html \ release-notes-1.2.html \ - release-notes-1.2.1.html + release-notes-1.2.1.html \ + release-notes-1.3.html RELNOTES_XSL=$(RELNOTES:.html=.xsl) HTML=altusmetrum.html altos.html telemetry.html companion.html micropeak.html $(RELNOTES) PDF=altusmetrum.pdf altos.pdf telemetry.pdf companion.pdf micropeak.pdf DOC=$(HTML) $(PDF) HTMLSTYLE=/usr/share/xml/docbook/stylesheet/docbook-xsl/html/docbook.xsl -FOSTYLE=/usr/share/xml/docbook/stylesheet/docbook-xsl/fo/docbook.xsl +FOSTYLE=./xorg-fo.xsl PDFSTYLE= IMAGES=telemetrum.svg telemini.svg -.SUFFIXES: .xsl .html .fo .pdf +.SUFFIXES: .xsl .html .pdf XSLTFLAGS=--stringparam section.autolabel 1 --xinclude .xsl.html: xsltproc $(XSLTFLAGS) -o $@ $(HTMLSTYLE) $*.xsl -.xsl.fo: - xsltproc $(XSLTFLAGS) -o $@ $(FOSTYLE) $*.xsl - -.fo.pdf: - fop -fo $*.fo -pdf $@ +.xsl.pdf: + xmlto -x $(FOSTYLE) --with-fop pdf $*.xsl all: $(HTML) $(PDF) @@ -48,10 +46,10 @@ publish: $(DOC) git push) clean: - rm -f $(HTML) $(PDF) *.fo + rm -f $(HTML) $(PDF) distclean: - rm -f $(HTML) $(PDF) *.fo + rm -f $(HTML) $(PDF) altusmetrum.html: $(RELNOTES_XSL) $(IMAGES) altusmetrum.fo: $(RELNOTES_XSL) $(IMAGES) diff --git a/doc/xorg-fo.xsl b/doc/xorg-fo.xsl new file mode 100644 index 00000000..896fcb6c --- /dev/null +++ b/doc/xorg-fo.xsl @@ -0,0 +1,97 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + X.Org DocBook/XML customization + + DocBook XSL Stylesheets FO Parameters + http://docbook.sourceforge.net/release/xsl/current/doc/fo/ +--> + +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version='1.0'> +<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/fo/docbook.xsl"/> + + + <!-- Reference Pages HTML/FO Parameters --> + + <!-- The formatting of a function element will include generated parentheses --> + <xsl:param name="function.parens" select="1"/> + + <!-- ANSI-style function synopses are generated for a funcsynopsis element --> + <xsl:param name="funcsynopsis.style" select="ansi"/> + + <!-- Linking HTML/FO Parameters --> + + <!-- open new PDF documents in new tab, don't replace doc in current window --> + <xsl:attribute-set name="olink.properties"> + <xsl:attribute name="show-destination">new</xsl:attribute> + </xsl:attribute-set> + + <!-- Miscellaneous HTML/FO Parameters--> + + <!-- SVG will be considered an acceptable image format --> + <xsl:param name="use.svg" select="1"/> + + <!-- ToC/LoT/Index Generation --> + <!-- put page breaks before and after the Table of Contents, + so that the ToC is on a page by itself + Reference: http://www.sagehill.net/docbookxsl/PrintToc.html + --> + <xsl:attribute-set name="toc.margin.properties"> + <xsl:attribute name="break-before">page</xsl:attribute> + <xsl:attribute name="break-after">page</xsl:attribute> + </xsl:attribute-set> + + <!-- Pagination and General Styles FO Parameters --> + <!-- + Speed up ps & pdf creation by not creating pages with "draft" image, + thus not needing to wait for http fetch of draft.png from docbook website. + --> + <xsl:param name="draft.mode" select="no"/> + + <!-- Processor Extensions FO Parameters--> + + <!-- PDF bookmarks extensions for FOP version 0.90 and later will be used. --> + <xsl:param name="fop.extensions" select="0"></xsl:param> + <xsl:param name="fop1.extensions" select="1"></xsl:param> + + <!-- Cross Refrences FO Parameters--> + + <!-- Make links in pdf output blue so it's easier to tell they're internal + links + --> + <xsl:attribute-set name="xref.properties"> + <xsl:attribute name="color">blue</xsl:attribute> + </xsl:attribute-set> + + <!-- Make links in pdf output green so it's easier to tell they're external + links + --> + <xsl:attribute-set name="olink.properties"> + <xsl:attribute name="color">green</xsl:attribute> + </xsl:attribute-set> + + <!-- Linking to a target inside a pdf document. + This feature is only available as of docbook-xsl-1.76.1. + When set to zero, the link will point to the document --> + <xsl:param name="insert.olink.pdf.frag" select="0"></xsl:param> + + + <!-- Font Families FO Parameters --> + + <!-- + Since a number of documents, especially the credits section in the + ReleaseNotes, use characters not found in the fop default base-14 + PostScript fonts, set the fonts for the fop generated documents to + use the free DejaVu and GNU Unifont fonts which cover a much wider + range of characters. + + DejaVu is available from http://dejavu-fonts.org/ + GNU Unifont is available from http://unifoundry.com/unifont.html + + To set fop font paths to find them after installing, see + http://xmlgraphics.apache.org/fop/1.0/fonts.html#basics + --> + <xsl:param name="body.font.family">DejaVu Serif</xsl:param> + <xsl:param name="symbol.font.family">serif,Symbol,AR PL UMing CN,AR PL ShanHeiSun Uni,GNU Unifont</xsl:param> + +</xsl:stylesheet> |