DocBook

From rsyslog wiki
Jump to: navigation, search

Rsyslog intends to use DocBook to generate its documentation. Our main aim is to generate a consistent set of man, html and pdf files out of a single documentation source. This was initially proposed by Rio Fujita and was very welcome by the team.

However, when we initially looked at docbook, we found a lot of documentation on the web - so much, that the core ideas were actually hard to grasp. So we think it is a good idea to create a central resource where docbook ideas and procedures for generating documentation with it are very practically described. This wiki entry (and its descendants) is supposed to become this resource. Granted, it is not very rsyslog-specific, but we hope it will be a useful resource in understanding how rsyslog documentation works. Also, it will hopefully be a good resource to the docbook community in general.