Next: Unit Testing / Levelized
Up: Documentation
Previous: Other Document Features
Making use of the capabilities of Document, LATEX and LATEX2HTML,
the CÆSAR Code documentation has these features:
- Hardcopy and HTML versions from a single source,
which is collocated with the source code
- Multiple output files and source languages (f90, gm4)
- Graphics, equations, code listings easily included
- Automatic table of contents (hyperlinked in HTML)
- Semi-automatic indexing (hyperlinked in HTML)
- Items included in only LATEX or HTML version
- Automatic navigation tools for HTML (Next, Up,
Previous, Contents, and Index links on every page)
- Hyper references (e.g. ``see Section 3.2'' becomes a link)
- External HTML links (e.g. to related presentations,
papers, packages or projects)
- Level 6 Documentation -- User's Manual, Code Manual,
Methods Discussion and Code Listing in Hardcopy and
Hyperlinked HTML via Literate Programming
Next: Unit Testing / Levelized
Up: Documentation
Previous: Other Document Features
Michael L. Hall