Building the documentation

Format

All the documentation (including this manual) is written in DocBook format. DocBook is an xml schema that can be converted to PDF, XHTML and more. As XML is inherently structured, the documentation is extremely easy to maintain.

Required tools

To build the documentation you need to acquire two things - the DocBook utilities and stylesheets and the Apache-FOP XSLT processor. On a debian/ubuntu based system the following will install all the docbook packages. On other distributions it may be nessecary to view the DocBook manual and download the given .rpms manually.

sudo apt-get install docbook*

The Apache-FOP XSLT processor is required to build the XSLT-FO intermediate files when converting to PDF. It is available from http://xmlgraphics.apache.org/fop/. You can download the binary version - unpack it somewhere and symlink bin/fopto /usr/bin/fop. This will allow the make script to access the FOP processor.

Unfortunately due to licensing issues a critical part of Apache-FOP can't be shipped with it - you must download it seperately. Go to http://offo.sourceforge.net/hyphenation/, download the stable .zip and extract the file fop-hyph.jarto <fop_install_dir>/lib/fop-hyph.jar.