Wednesday, March 11, 2009

Documentation ported to Docbook

Gilberto C. Andrade recently ported Click's documentation to Docbook using Michael Fuchs HTML to Docbook converter.

This is really great news as we can now generate the documentation in both PDF and HTML formats.

Below is a screenshot of how the PDF looks like:

And here is how the HTML version looks like:

To generate the docs we use a modified version of the Velocity Docbook Framework. The modifications include upgrading to the latest versions of Apache FOP and Docbook XLS.

To achieve syntax highlighting for our source code we include the XSLTHL library.

The only issue I encountered was that XSLTHL doesn't work with the latest official Docbook XLS release. Luckily the latest snapshot of Docbook XLS resolved the issue.

We hope the new format will make it easier to read and learn Click.

The Click team.