stylesheets/evergreen_docbook_files/docbook-xsl-1.75.2/README

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