[DocBook kit] (https://el-tramo.be/docbook-kit)
This is a collection of scripts and Makefiles to help creating DocBook documents.
- Python >= 2.4 (http://python.org)
- xmllint (http://xmlsoft.org/xmllint.html). Part of LibXML2.
- xsltproc (http://xmlsoft.org/XSLT/xsltproc2.html). Part of LibXML2.
- pdftk (http://www.accesspdf.com/pdftk/). For PDF attachments. Optional.
- links (http://links.sourceforge.net). For TXT output.
- wget (http://www.gnu.org/software/wget/). To download required DocBook files.
- aspell (http://aspell.net/). For spellchecking. Optional.
- zip. For EPUB format. Optional.
To use this kit, put it in the directory of your DocBook project, and have a look at the example/ dir to see how to use it in your project.
-
The Makefile include automatically downloads DocBook if necessary, and automatically builds your project (and its depended-on files). If you want to avoid downloading all tools if you already have them in another project that uses the docbook-kit, just create a
docbook
softlink to thedocbook
dir in your other project.The makefile provides the following commands:
make
: Create HTML and PDF versions (if FOP is available) of the documentmake html
: Create a HTML version of the documentmake pdf
: Create a PDF version of the documentmake epub
: Create an EPUB version of the documentmake wordpress
: Create a PHP file that integrates with a WordPress blog
make txt
: Create a text version of the documentmake clean
: Clean up all generated filesmake check-document
: Validates the document syntaxmake check-spelling
: Checks the spelling of the documentmake check-quotes
: Checks for correct usage of curly quotesmake check-braces
: Checks for correctly balanced bracesmake check-ulinks
: Checks whether the URIs pointed to by elements are valid.make package
: Creates a tarball of your document. The package contains a flattened version of the DocBook sources, and normalized figure names.
If you want to use custom fonts in your style sheets, drop the .ttf
or
.pfm
file in the fonts/
directory.