Show README syntax highlighted
----------------------------------------------------------------------
README file for the DocBook XSL Stylesheets
----------------------------------------------------------------------
$Id: README 6286 2006-09-12 01:42:11Z xmldoc $
These are XSL stylesheets for transforming DocBook XML document
instances into various output formats.
This README file provides only very minimal documentation on using
the stylesheets. For more complete information, see Bob Stayton's
book "DocBook XSL: The Complete Guide", available online at:
http://www.sagehill.net/docbookxsl/
----------------------------------------------------------------------
Installation
----------------------------------------------------------------------
See the INSTALL file for information about installing this release.
----------------------------------------------------------------------
How to use the stylesheets
----------------------------------------------------------------------
The base canonical URI for these stylesheets is:
http://docbook.sourceforge.net/release/xsl/current/
You call any of the stylesheets in this distribution by doing one
of the following:
- Use the base canonical URI in combination with one of the
pathnames below. For example, for "chunked" HTML, output:
http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl
If your system has a working XML Catalog or SGML Catalog setup
(most Linux systems do), then that URI will automatically be
resolved and replaced with a local pathname on your system.
- Use a "real" local system base path in combination with one of
the pathnames below. For example, for "chunked" HTML, output:
/usr/share/xml/docbook/stylesheet/nwalsh/html/chunk.xsl
To transform documents created with the standard DocBook
schema/DTD, use one of the following stylesheets:
fo/docbook.xsl - for XSL-FO
fo/profile-docbook.xsl - for XSL-FO (single-pass profiled)
html/docbook.xsl - for HTML (as a single file)
html/chunk.xsl - for HTML (chunked into multiple files)
html/onechunk.xsl - for HTML (chunked output in single file)
html/profile-* - for HTML (single-pass profiled versions)
xhtml/*.xsl - for XHTML versions of the above
htmlhelp/htmlhelp.xsl - for HTML Help
javahelp/javahelp.xsl - for JavaHelp
eclipse/eclipse.xsl - for Eclipse Help
manpages/docbook.xsl - for groff/nroff man pages[1]
[1] more information at http://wiki.docbook.org/topic/ManPages
wordml/docbook.xsl - DocBook XML to WordML
wordml/docbook-pages.xsl - DocBook XML to Pages index.xml
wordml/pages-normalise.xsl - Pages index.xml to (1a)
To convert WordML into DocBook, use the following chain of stylesheets:
wordml/wordml-normalise.xsl - WordML to (1w)
wordml/wordml-sections.xsl - (1a or 1w) to (2)
wordml/wordml-blocks.xsl - (2) to (3)
wordml/wordml-final.xsl - (3) to DocBook XML
To transform documents created with the DocBook Slides schema/DTD,
use one of the following stylesheets:
slides/html/*.xsl - for HTML slides of various kinds
slides/xhtml/*.xsl - for XHTML slides of various kinds
slides/fo/plain.xsl - for XSL-FO slides
slides/htmlhelp/... - for HTML Help slides
To transform documents created with the DocBook Website
schema/DTD, use one of the following stylesheets:
website/website.xsl - for non-tabular, non-chunked output
website/tabular.xsl - for tabular, non-chunked output
website/chunk-* - for chunked output
To generate a titlepage customization layer from a titlepage spec:
template/titlepage.xsl
For details about creating titlepage spec files and generating and
using titlepage customization layers, see "DocBook XSL: The
Complete Guide" <http://www.sagehill.net/docbookxsl/>
----------------------------------------------------------------------
Manifest
----------------------------------------------------------------------
AUTHORS contact information
BUGS about known problems
COPYING copyright information
INSTALL installation instructions
README this file
RELEASE.* per-release cumulative summaries of user-visible changes
TODO about planned features not yet implemented
VERSION the current version number (note that this is an XSL stylesheet,
included by both fo/docbook.xsl and html/docbook.xsl)
NEWS changes since the last public release (for a cumulative list of
changes, see the ChangeHistory.xml file)
common/ code used among several output formats (HTML, FO, manpages,...)
docsrc/ documentation sources
eclipse/ for producing Eclipse Help
extensions/ Java XSLT extensions
fo/ for producing XSL-FO
highlighting files used for adding source-code syntax highlighting in output
html/ for producing HTML
htmlhelp/ for producing HTML Help
images/ images used in callouts and graphical admonitions
javahelp/ for producing Java Help
lib/ utility stylesheets with schema-independent functions
manpages/ for producing groff/nroff man pages
profiling/ for profiling (omitting/including conditional text)
slides/ for producing slides output (from Slides source)
template/ templates for building stylesheet customization layers
website/ for producing website output (from Website source)
wordml/ for "round trip" conversion between DocBook XML and WordML
xhtml/ for producing XHTML
----------------------------------------------------------------------
Changes
----------------------------------------------------------------------
See the ChangeHistory.xml.zip file for a cumulative list of all changes.
See the NEWS file for changes made since the previous release.
See the RELEASE-NOTES.html or RELEASE-NOTES.txt or RELEASE-NOTES.pdf files
for per-release cumulative summaries of significant user-visible changes.
See more files for this project here