Table of Contents
Abstract
This chapter describes how to write and then build DocBook documentation. It is applicable for contributors who wish to update the documentation and check the result of their changes.
All of the sister projects provide supporting documentation,
typically a developers' guide
(developers-guide.xml) and a users' guide
(users-guide.xml). Star Objects itself has only a
developers guide, namely this document.
All of these documents are written in DocBook, and are built using Maven, using build plugins defined by the corporate POM (see Part IV, “Building and Deploying the Corporate Artifacts”).
This chapter explains how to write and built this documentation, using Star Objects' own documentation as a guide.
Generally speaking the documentation for all sister projects
lives in that project's sourceforge repository under
trunk/main/documentation. For example, the
documentation for the Star Objects project resides in the Star Objects
repository under trunk/main/documentation.
As always, use Subversion to check out. For example:
svn co https://starobjects.svn.sourceforge.net/svnroot/starobjects/trunk/main/documentation ~/starobjects/trunk/main/documentation