Next: Processing the documentation Up: Documenting solved problems and Previous: Simple statements

Documenting subsystems

A subsystem describes some part of a dynamic system that may have several submodels. Models may differ in interface, parameters, way of modeling of physical phenomena, etc.

The document describing a subsystem must be written in LATEX. It contains only the documentation (not data), so it has no colons for distinguishing data from documentation. It may contain the special statements FIG, SITE, and the statement CAPTION.

The CAPTION statement.

CAPTION name of the subsystem

The statement CAPTION inserts the heading of a subsystem. It should be the first statement of each subsystem file documentation.





(c) DYN 2002, feedback: dyn@virtual.cvut.cz