Writing Documentation

This chapter provides information and guidelines on writing Opus and UrbanSim documentation. This guide is written using L^ATEX. Other documentation includes a growing number of tutorials, and documentation on individual indicators. Tutorials can be written using a variety of formatters, including L^ATEX and wiki; guidelines for writing tutorials is on our external wiki at http://www.urbansim.org/wiki/external/index.php/Contributing_Tutorials. Documentation for individual indicators is written using XML files; guidelines for writing indicator documentation are given in Section 11.6.

We use L^ATEX for the guide and other major documents, since it produces elegantly formatted printable document, handles mathematics well, and includes facilities for cross-referencing and indexing. In addition to a pdf version of the documentation written using L^ATEX, we use the latex2html converter program to produce an html version.