doc/xslt/README

   1 ----------------------------------------------------------------------
   2               README file for the DocBook XSL Stylesheets
   3 ----------------------------------------------------------------------
   4 $Id: README 8484 2009-07-13 20:35:34Z mzjn $
   5
   6 These are XSL stylesheets for transforming DocBook XML document
   7 instances into various output formats.
   8
   9 This README file provides only very minimal documentation on using
  10 the stylesheets. For more complete information, see Bob Stayton's
  11 book "DocBook XSL: The Complete Guide", available online at:
  12
  13   http://www.sagehill.net/docbookxsl/
  14
  15 ----------------------------------------------------------------------
  16 Installation
  17 ----------------------------------------------------------------------
  18 See the INSTALL file for information about installing this release.
  19
  20 ----------------------------------------------------------------------
  21 How to use the stylesheets
  22 ----------------------------------------------------------------------
  23 The base canonical URI for these stylesheets is:
  24
  25   http://docbook.sourceforge.net/release/xsl/current/
  26
  27 You call any of the stylesheets in this distribution by doing one
  28 of the following:
  29
  30   - Use the base canonical URI in combination with one of the
  31     pathnames below. For example, for "chunked" HTML, output:
  32
  33     http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl
  34
  35     If your system has a working XML Catalog or SGML Catalog setup
  36     (most Linux systems do), then that URI will automatically be
  37     resolved and replaced with a local pathname on your system.
  38
  39   - Use a "real" local system base path in combination with one of
  40     the pathnames below. For example, for "chunked" HTML, output:
  41
  42     /usr/share/xml/docbook/stylesheet/nwalsh/html/chunk.xsl
  43
  44 To transform documents created with the standard DocBook
  45 schema/DTD, use one of the following stylesheets:
  46
  47   fo/docbook.xsl              - for XSL-FO
  48
  49   html/docbook.xsl            - for HTML (as a single file)
  50   html/chunk.xsl              - for HTML (chunked into multiple files)
  51   html/onechunk.xsl           - for HTML (chunked output in single file)
  52
  53   xhtml/*.xsl                 - for XHTML versions of the above
  54
  55   xhtml-1_1/*.xsl             - for XHTML 1.1 versions of the above
  56
  57   epub/docbook.xsl            - for .epub
  58
  59   htmlhelp/htmlhelp.xsl       - for HTML Help
  60   javahelp/javahelp.xsl       - for JavaHelp
  61   eclipse/eclipse.xsl         - for Eclipse Help
  62
  63   manpages/docbook.xsl        - for groff/nroff man pages
  64
  65   */profile-*                 - single-pass-profiling versions of all above
  66
  67   roundtrip/*.xsl             - for DocBook to WordML, etc., to DocBook
  68
  69 To transform documents created with the DocBook Slides schema/DTD,
  70 use one of the following stylesheets:
  71
  72   slides/html/*.xsl           - for HTML slides of various kinds
  73   slides/xhtml/*.xsl          - for XHTML slides of various kinds
  74   slides/fo/plain.xsl         - for XSL-FO slides
  75   slides/htmlhelp/...         - for HTML Help slides
  76
  77 To transform documents created with the DocBook Website
  78 schema/DTD, use one of the following stylesheets:
  79
  80   website/website.xsl         - for non-tabular, non-chunked output
  81   website/tabular.xsl         - for tabular, non-chunked output
  82   website/chunk-*             - for chunked output
  83
  84 To generate a titlepage customization layer from a titlepage spec:
  85
  86   template/titlepage.xsl
  87
  88 For details about creating titlepage spec files and generating and
  89 using titlepage customization layers, see "DocBook XSL: The
  90 Complete Guide" <http://www.sagehill.net/docbookxsl/>
  91
  92 ----------------------------------------------------------------------
  93 Manifest
  94 ----------------------------------------------------------------------
  95 AUTHORS       contact information
  96 BUGS          about known problems
  97 COPYING       copyright information
  98 INSTALL       installation instructions
  99 README        this file
 100 RELEASE.*     per-release cumulative summaries of user-visible changes
 101 TODO          about planned features not yet implemented
 102 VERSION       release metadata, including the current version
 103               number (note that the VERSION file is an XSL stylesheet)
 104 NEWS          changes since the last public release (for a cumulative list of
 105               changes, see the ChangeHistory.xml file)
 106
 107 common/       code used among several output formats (HTML, FO, manpages,...)
 108 docsrc/       documentation sources
 109 eclipse/      for producing Eclipse Help
 110 epub/         for producing .epub
 111 extensions/   DocBook XSL Java extensions
 112 fo/           for producing XSL-FO
 113 highlighting  files used for adding source-code syntax highlighting in output
 114 html/         for producing HTML
 115 htmlhelp/     for producing HTML Help
 116 images/       images used in callouts and graphical admonitions
 117 javahelp/     for producing Java Help
 118 lib/          utility stylesheets with schema-independent functions
 119 manpages/     for producing groff/troff man pages
 120 profiling/    for profiling (omitting/including conditional text)
 121 roundtrip/    for "round trip" conversion among DocBook and
 122               various word-processor formats (WordML, etc.)
 123 slides/       for producing slides output (from Slides source)
 124 template/     templates for building stylesheet customization layers
 125 tools/        assorted supplementary tools
 126 website/      for producing website output (from Website source)
 127 xhtml/        for producing XHTML
 128 xhtml-1_1/    for producing (stricter) XHTML 1.1
 129
 130 ----------------------------------------------------------------------
 131 Changes
 132 ----------------------------------------------------------------------
 133 See the NEWS file for changes made since the previous release.
 134
 135 See the RELEASE-NOTES.html or RELEASE-NOTES.txt or RELEASE-NOTES.pdf
 136 files for per-release cumulative summaries of significant
 137 user-visible changes.
 138
 139 For online access to a hyperlinked view of all changes made over
 140 the entire history of the codebase, see the following:
 141
 142   http://docbook.svn.sourceforge.net/viewvc/docbook/trunk/xsl/?view=log
 143
 144 WARNING: That above change history is a very long list and may
 145 take a long time to load/download.
 146
 147 You can also create an XML-formatted "ChangeHistory.xml" copy of
 148 the complete change history for the codebase by running the
 149 following commands:
 150
 151   svn checkout https://docbook.svn.sf.net/svnroot/docbook/trunk/xsl
 152   svn log --xml --verbose xsl > ChangeHistory.xml
 153
 154 ----------------------------------------------------------------------
 155 Copyright information
 156 ----------------------------------------------------------------------
 157 See the accompanying file named COPYING.