README
1This directory contains a number of auxiliary files that are used by the
2docbook build system to convert the documentation in docbook-xml format to
3various output formats.
4
5* catalog.xml:
6 This is a XML catalog file. The file is used by the tools that process
7 docbook sources to map public identifiers, which are commonly found in
8 docbook source files, such as
9 "-//OASIS//DTD DocBook XML V4.3//EN"
10 to local files. The default version of the file refers to a generic
11 catalog file that is commonly found in /etc/xml/catalog.
12
13 You can modify the file if you want to use a particular version of docbook
14 schema files or XSL stylesheets to produce the output. This is very useful
15 because there is no need to modify source docbook files, the catalog file
16 can be used to re-map the public identifier in those files to a local (and
17 possibly customized) version of the schema or stylesheets.
18
19* common.xsl:
20 This file contains docbook XSL stylesheet customizations that are shared
21 by all output-specific XSL files, for example, the code that strips
22 leading and trailing whitespace in <screen> sections is located here.
23
24* dep.xsl:
25 This file contains a special XSL stylesheet which can be used to produce a
26 file with dependencies for any given docbook source file. The stylesheet
27 traverses docbook documents and looks for files included with the
28 xi:include mechanism, or for files included by docbook tags, such as
29 images, screen listings, etc. The list of dependencies is then written in
30 a separate file and the file can be included in a Makefile that is used to
31 build documentation. This is all done by the docbook makefile system.
32
33* html.chunked.xsl:
34 The stylesheet in this file is used to generate HTML output split in
35 multiple files. This is useful if you need to generate HTML files with
36 documentation for browsers that do not support XHTML.
37
38* Makefile:
39 This is the main Makefile of the Docbook build system. Rules implemented
40 in this Makefile can be used to validate docbook documents, generate lists
41 of dependendies, generate HTML, plain-text, READMEs, and other output
42 formats out of docbook documents. This file is not meant to be used
43 directly. Instead, each directory with docbook source files should have
44 its own minimal Makefile which includes this file.
45
46* man.xsl:
47 This stylesheet can be used to convert docbook sources into man pages. The
48 docbook build system uses this stylesheet to convert docbook files with
49 man pages contents to real man pages, some modules contain such docbook
50 files.
51
52* readme.xsl:
53 This stylesheet is used to generate module README files from docbook sources.
54
55* sr-doc.css:
56 The CSS stylesheets that are used for online HTML documentation generated
57 from docbook sources.
58
59* txt.xsl:
60 The XSL stylesheet used to generate plain text version of the
61 documentation. XHTML stylesheets are used to generate XHTML code that is
62 then fed to lynx to produce plain a text version. This stylesheet contains
63 XHTML customization that are applied only when a plain-text output is
64 desired.
65
66 -- Jan Janak <jan@iptel.org>
67
readme.xsl