FILE ... TOC
Formatting the embedded documentation
You can write paragraphs into multiple lines. An empty line breaks the paragraph.
You can use line commands and in-line formatting. Line commands begin at the start
of the line with an = sign and contain a keyword. The keyword can optionally be followed
by parameters.
The line commands are:
- section switches to a section. The default section is the main section.
One section can contain parts at several location in the source file, sections can be
stopped, start a new section, then continue with a new.
- notoc tells the formatter not to include the section in the table of contents. You can have, and
should have a link to the section uning a reference using the construct R<section>
- title Defines the title of the section. Should only be used once for each section.
- H Defines the title of the actual section and inserts the title into the
documentation as a
header
- abstract Starts the abstract of the section. This abstract should describe briefly
the details of the section. This will appear in the toc.
- end End of the abstract of the section
- toc place for the table of contents, used int he main section and in the main section
of the project in the SDD file. If no such a line is present in the main section then toc will be
appended to the end of the section.
- hrule Horizontal rule
- itemize Start itemizing. You can nest as HTML can.
- item start a new item
- noitemize Stop itemizing
- bold Start lines in bold.
- nobold Finish bold lines.
- italic Start lines in italic.
- noitalic Finish italic lines.
- verbatim Start lines verbatim.
- noverbatim Finish verbatim lines.
You can also use in-line formatting. These are ?<any character except > and close with>. The
format characters can be
- H for header
- B bold characters
- I italic characters
- T teletype characters
FILE ... TOC