Next / Previous / Contents / NM Tech homepage

Abstract

Describes a customization layer for the DocBook 5 Modular Stylesheets. HTXS html-titlepage.xsl

This publication is available in Web form and also as a PDF document. Please forward any comments to john@nmt.edu.

This work is licensed under a Creative Commons BY-NC Creative Commons Attribution-NonCommercial 3.0 Unported License.

Table of Contents

1. Introduction
1.1. Bob Stayton's DocBook XSL: The complete guide
2. Online files
3. Required skills
4. What is a customization layer?
5. Overall structure of the local customization layer
6. Title page customization: XSLT that builds XSLT
7. zdp_html.xsl: HTML customization layer
7.1. HTML general page layout
7.2. HTML title page and table of contents
7.3. HTML headers and footers
7.3.1. The header.navigation template
7.3.2. The top.nav.bar template
7.3.3. The footer.navigation template
7.3.4. The bot.links template
7.3.5. The zdp.colophon template
7.3.6. The author.colophon.mode template
7.4. HTML section and subsection headings
7.5. HTML inline element customizations
7.5.1. The inline.italicsansseq template
7.5.2. The inline.smallcapsseq template
7.5.3. application
7.5.4. Emphasis with boldface
7.5.5. callout graphics
7.5.6. firstterm
7.5.7. guibutton, guiicon, guilabel, and guimenu
7.5.8. The keysym element
7.5.9. HTML inline math
7.6. HTML block element customizations
7.6.1. The programlisting element
7.6.2. The html-lit-block template: Formatting a literate block
7.7. Epilogue for the HTML stylesheet
8. The html_params.xsl file: HTML branding
8.1. email.to.author: Email address for reader comments
8.2. help.long.name: Full link text for the help link
8.3. help.short.name: Help link short text
8.4. help.url: Help link URL
8.5. home.long.name: Full home link text
8.6. home.short.name: Homepage short link text
8.7. home.url: Homepage URL
8.8. html.logo: Organizational logo image
8.9. html.stylesheet: URL of the CSS stylesheet
8.10. html_params.xsl: Epilogue
9. html-titlepage.xml: HTML title page template
10. docbook5.css: The CSS stylesheet for the HTML rendering
10.1. docbook5.css: Prologue
10.2. docbook5.css: General page layout
10.3. docbook5.css: Inline elements
10.3.1. span.application
10.3.2. span.colophon-uri
10.3.3. The span.gui{button|icon|label|menu} group
10.3.4. span.keysym
10.3.5. span.term
10.4. docbook5.css: Block elements
10.4.1. pre.executable
10.4.2. pre.programlisting and pre.screen
10.4.3. div.abstract
10.4.4. div.code-block-label
10.4.5. div.colophon
10.4.6. div.colophon-author
10.4.7. div.colophon-date
10.4.8. div.colophon-mail-to
10.4.9. div.colophon-url
11. zdp_fo.xsl: PDF customization layer
11.1. General page layout
11.2. Templates for title elements
11.2.1. The article.title template
11.2.2. The book.title template
11.3. PDF headers and footers
11.3.1. Other header/footer options to consider
11.4. PDF section and subsection headings
11.5. PDF inline element customizations
11.5.1. The inline.italicsansseq template
11.5.2. The inline.smallcaps template
11.5.3. application and the gui* group
11.5.4. Bold emphasis
11.5.5. Callouts
11.5.6. firstterm
11.5.7. keysym
11.5.8. Inline math
11.5.9. ulink
11.5.10. xref: Page cross-reference format
11.6. PDF block element customizations
11.6.1. Admonitions: caution, important, note, tip, and warning
11.6.2. programlisting and other verbatim elements
11.6.3. The fo-lit-block template: Format a literate block
11.6.4. variablelist: Variable list entry term
11.7. PDF epilogue
12. The fo_params.xsl file: PDF branding
12.1. pdf.logo: Image source for the PDF organizational logo
12.2. pdf.org.name: Organization's name for the running footer
12.3. fo_params.xsl: Epilogue
13. fo-titlepage.xml: PDF title page templates
13.1. Prologue to fo-titlepage.xml
13.2. Title page for a book
13.3. Title page for an article
13.4. Title page for an index
14. Configuration of XEP
14.1. xep.xml: Stock prologue
14.2. xep.xml: TCC modifications
14.2.1. Gandhi Sans
14.2.2. DejaVuSans
14.2.3. Pagella
14.2.4. DejaVuSerif
14.2.5. FreeSerif
14.2.6. Vera Sans Mono
14.2.7. Latin Modern Roman
14.2.8. Font sets
14.3. xep.xml: Stock epilogue

1. Introduction

DocBook is a generalized framework for writing documentation using XML. Among the many advantages of this system is that a single source document can be translated mechanically to both HTML and PDF representations.

This document contains all the files used for local customization, in “lightweight literate programming” format. For more information, see the author's Lightweight literate programming page.

A local DocBook toolchain consists of these components:

  • Norman Walsh's DocBook-XSL Stylesheets provide a generic styling of DocBook that can be customized with local style conventions. These stylesheets consist of XSLT scripts. For more information about XSLT, see XSL Transformations (XSLT) Version 1.0.

    These style sheets can be downloaded from the SourceForge repository.

  • The xsltproc package implements the XSLT language. Production of the HTML output from a DocBook document needs only XSLT.

  • The xep processor is necessary to produce the printable, PDF (Adobe Page Description Format) form of a DocBook document. This transformation starts by using xsltproc to transform the original DocBook document into XSL, also known as XSL-FO (for Formatting Objects). The resulting .fo file is input to xep, which produces the PDF output file.

    For more information on XSL, see the standard: Extensible Stylesheet Language (XSL) Version 1.0.

1.1. Bob Stayton's DocBook XSL: The complete guide

Without customization, the stock DocBook-XSL Stylesheets produce a pretty bland, generic output style. This document describes a customization layer, built on top of the DocBook-XSL Stylesheets, that gives documents their local style.

Documentation for the DocBook-XSL Stylesheets is rather skeletal. Fortunately, there is an excellent book that describes the customization process in detail:

Stayton, Bob. DocBook XSL: The complete guide. Third edition, March 2005, ISBN 0-9741521-2-9.

This book will be referred to throughout this document as “Stayton.”