24.10 Miscellaneous Commands

24.10.1 Sequential Environments

In order to define the ToDo and Convention environments below, and in order to provide an easy way for similar user-defined environments, we provide the command ∖defSequentialEnvironment. See the sections about the ToDo and Convention in order to find examples how to use ∖defSequentialEnvironment and the environment that is defined by that command.

The TEX commands are similar to the ones in the definition of ∖list as defined in the file latex.ltx of LATEX2ɛ, but they allow nesting of such environments to an arbitrary depth.

24.10.2 The ToDo environment

The environment ToDo should be used inside the documentation to mark unfinished ideas.

One can find out about all possible ToDo’s by looking at the index or simply by clicking on the left and right triangles.

The background color of a ToDo environment can be configured via the commands ∖backgroundColor{ToDo}{...} at a local customization (see Section 24.12).

24.10.3 The Convention environment

The environment Convention should be used inside the documentation to mark conventions in any form. Code conventions or any assumptions that is necessary to make the code run properly should be documented inside such an environment.

One can find out about all possible conventions by looking at the index or simply by clicking on the left and right triangles.

The background color of a Convention environment can be configured via the commands ∖backgroundColor{Convention}{...} at a local customization (see Section 24.12).