How to write documentation

The Drake CMS official documentation files are created according to the XHTML 1.0 Strict standard, it is the only format from which documentation files may be created (independently from the distribution format).

Overall organization

All Drake CMS documentation manuals share images and CSS styles which are stored in the root docs/ directory.

The documentation integration directly into Drake CMS is provided through the docs.php application page.

Special comments

There are some special HTML comments inside each documentation page; you should not remove them as they are used to build the documentation files adding the top/bottom navigation bars.

Building documentation

Built documents should not be subversioned; documentation will be built by project administrators before release.

The TOPBAR and BOTTOMBAR blocks will be inserted, and also the meta description and keywords tags.