doc/xslt/README

   1 ----------------------------------------------------------------------
   2               README file for the DocBook XSL Stylesheets
   3 ----------------------------------------------------------------------
   4 $Id$
   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 schema/DTD
  45 (or DocBook NG schema/DTD, use one of the following stylesheets:
  46
  47   fo/docbook.xsl          - for XSL-FO
  48   fo/profile-docbook.xsl  - for XSL-FO (single-pass profiled)
  49
  50   html/docbook.xsl        - for HTML (as a single file)
  51   html/chunk.xsl          - for HTML (chunked into multiple files)
  52   html/onechunk.xsl       - for HTML (chunked output in single file)
  53   html/profile-*          - for HTML (single-pass profiled versions)
  54
  55   xhtml/*.xsl             - for XHTML versions of the above
  56
  57   htmlhelp/htmlhelp.xsl   - for HTML Help
  58   javahelp/javahelp.xsl   - for JavaHelp
  59   eclipse/eclipse.xsl     - for Eclipse Help
  60
  61   manpages/docbook.xsl    - for groff/nroff man pages
  62
  63 To transform documents created with the DocBook Slides schema/DTD,
  64 use one of the following stylesheets:
  65
  66   slides/html/*.xsl       - for HTML slides of various kinds
  67   slides/xhtml/*.xsl      - for XHTML slides of various kinds
  68   slides/fo/plain.xsl     - for XSL-FO slides
  69   slides/htmlhelp/...     - for HTML Help slides
  70
  71 To transform documents created with the DocBook Website
  72 schema/DTD, use one of the following stylesheets:
  73
  74   website/website.xsl     - for non-tabular, non-chunked output
  75   website/tabular.xsl     - for tabular, non-chunked output
  76   website/chunk-*         - for chunked output
  77
  78 ----------------------------------------------------------------------
  79 Manifest
  80 ----------------------------------------------------------------------
  81 AUTHORS     contact information
  82 BUGS        about known problems
  83 COPYING     copyright information
  84 INSTALL     installation instructions
  85 README      this file
  86 RELEASE.*   per-release cumulative summaries of user-visible changes
  87 TODO        about planned features not yet implemented
  88 VERSION     the current version number (note that this is an XSL stylesheet,
  89             included by both fo/docbook.xsl and html/docbook.xsl)
  90 NEWS        changes since the last public release (for cumulative lists of
  91             changes, see the ChangeLog files in each subdirectory)
  92
  93 common/     contains code common to both the HTML and FO stylesheets
  94 doc/        documentation
  95 docsrc/     documentation sources
  96 eclipse/    stylesheet that produces Eclipse Help
  97 extensions/ Java extensions
  98 fo/         stylesheets that produce XSL FO
  99 html/       stylesheets that produce HTML
 100 htmlhelp/   stylesheets that produce HTML Help
 101 images/     images
 102 javahelp/   stylesheets that produce Java Help
 103 lib/        contains schema-independent functions
 104 manpages/   stylesheets for producing groff/nroff man pages
 105 profiling/  stylesheets for profiling (omitting/including conditional text)
 106 slides/     stylesheets for producing slides (from DocBook Slides source)
 107 template/   contains templates for building stylesheet customization layers
 108 website/    stylesheets for producing a website (from DocBook Website source)
 109 xhtml/      stylesheets that produce XHTML
 110
 111 ----------------------------------------------------------------------
 112 Changes
 113 ----------------------------------------------------------------------
 114 See the ChangeLog in each subdirectory for cumulative lists of all changes.
 115
 116 See the NEWS file for changes made since the previous release.
 117
 118 See the RELEASE-NOTES.html or RELEASE-NOTES.txt or RELEASE-NOTES.pdf files
 119 for per-release cumulative summaries of significant user-visible changes.