Copyright © 2006 Robert Bienert
This material has been released under and is subject to the terms of the Common Documentation License, v.1.0, the terms of which are hereby incorporated by reference. Please obtain a copy of the License at http://www.opensource.apple.com/cdl/ and read it before using this material. Your use of this material signifies your agreement to the terms of the License.
Abstract
This document describes the docbooktoc.xsl TOC generator.
Table of Contents
Abstract
The docbooktoc.xsl is a XSLT file for generating a XHTML table of contents from DocBook XML documents. It is used by the LayManSys project for the documentation.
docbooktoc accepts the following parameters:
extThe names of linked files are determined from the chapters id, which does not contain a filename suffix. This (string) parameter tells docbooktoc the suffix to use. Its default value is html.
style.sheetThis (string) parameter may contain stylesheets for styling the output document. You can pass more than one stylesheet by delimiting their filenames with a white-space (space, tab or newline).
style.typeThis (string) parameter contains the MIME type used for content stylesheets. It defaults to text/css.
docbooktoc generates a XHTML document containing the books meta information (in DocBook XML, this is the subnode bookinfo and than lists all of the books chapters and section in an ordered list. The meta information are both used for generating the <head> as well as the documents header (in the XHTML <body>) and the output is the same like the DocBook XSLT driver for XHTML generates. The books chapters and sections are presented as a n ordered, nested list, where the chapters are top level items, that contain lists of sections, where a section item again may contain a list of subsections.
You can use the Makefile distributed in this package and the LayManSys documentation for generating the example file toc.html. The make command for this is make test.
This section contains some examples how to use docbooktoc with certain XSLT processors.
If you use xsltproc from libxml, you should use docbooktoc this way:
xsltproc docbooktoc.xsl [--stringparam ext file_extension] [--stringparam style.sheet 'list of stylesheets'] [--stringparam style.type stylesheet_content_type]