README for the DocBook Stylesheets $Id$ These are XSL stylesheets for transforming DocBook XML document instances into various output formats. (They would also work for transforming DocBook SGML document instances, modulo certain namecase problems and the fact that there aren't (yet) any XSL implementations that work with SGML source documents.) For more information, see http://docbook.sourceforge.net/ Manifest -------- BUGS about known problems INSTALL executable script for generating a catalog.xml file 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) WhatsNew changes since the last public release (for cumulative lists of changes, see the ChangeLog files in each subdirectory) common/ contains code common to both the HTML and FO stylesheets doc/ documentation docsrc/ documentation sources eclipse/ stylesheet that produces Eclipse Help extensions/ Java extensions fo/ stylesheets that produce XSL FO html/ stylesheets that produce HTML htmlhelp/ stylesheets that produce HTML Help images/ images javahelp/ stylesheets that produce Java Help lib/ contains schema-independent functions manpages/ stylesheets for producing groff/nroff man pages profiling/ stylesheets for profiling (omitting/including conditional text) template/ contains templates for building stylesheet customization layers xhtml/ stylesheets that produce XHTML Changes ------- See the ChangeLog in each subdirectory for cumulative lists of all changes. See WhatsNew for changes since the last release. See the RELEASE-NOTES.html or RELEASE-NOTES.txt file for per-release cumulative summaries of significant user-visible changes. Installation ------------ Unpack the distribution somewhere. Run the INSTALL script and follow the instructions it generates. Use --- Process your DocBook documents with one of the following stylesheets using your favorite XSLT processor: 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) xhtml/ - for XHTML versions above the above fo/docbook.xsl - for XSL FO manpages/docbook.xsl - for groff/nroff man pages eclipse/eclipse.xsl - for Eclipse Help htmlhelp/htmlhelp.xsl - for HTML Help javahelp/javahelp.xsl - for JavaHelp Copyright --------- Copyright (C) 1999, 2000, 2001, 2002 Norman Walsh Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ``Software''), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. Except as contained in this notice, the names of individuals credited with contribution to this software shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from the individuals in question. Any stylesheet derived from this Software that is publically distributed will be identified with a different name and the version strings in any derived Software will be changed so that no possibility of confusion between the derived package and this Software will exist. Warranty -------- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL NORMAN WALSH OR ANY OTHER CONTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Contacting the Author --------------------- These stylesheets are maintained by Norman Walsh, .