|
3.8.10 Typesetting of help and info strings
The info strings of the libraries which are included in the distribution
of SINGULAR and the help strings of the corresponding procedures
are parsed and automatically converted into the texinfo format
(the typesetting language in which the documentation of SINGULAR
is written).
The illustrative example given in template_lib should provide
sufficient information on how this works. For more details, check the
following items:
-
Users familiar with
texinfo may write help and info strings
directly in the texinfo format. The string should, then,
start with the @ sign. In this case, no parsing will be done.
-
Help and info strings are typeset within a
@table @asis environment
(which is similar to the latex description environment).
-
If a line starts with uppercase words up to a colon, then the text up to
the colon is taken to be the description-string of an item, and the
text following the colon is taken to be the content of the item.
-
If the description-string of an item matches
SEE ALSO
- then the
content of the item is assumed to consist of comma-separated words
which are valid references to other
texinfo nodes of the manual
(e.g., all procedure and command names are also texinfo nodes).
KEYWORDS
- then the content of the item is assumed to be a
semicolon-separated list of phrases which are taken as keys for the
index of the manual (the name of a procedure/library is
automatically added to the index keys).
-
If the description-string of an item in the info string of a
library matches
LIBRARY
- then the content of the item is assumed to be a one-line description of
the library. If this one-line description consists of uppercase characters
only, then it is typeset in lowercase characters (otherwise it is left as is).
PROCEDURES
- then the content of the item is assumed to consist of lines of type
| <proc_name>(); <one line description of the purpose>
| Separate texinfo nodes (subsections in printed documents)
are created precisely for those procedures of the library appearing
here (that is, for some if not all non-static procedures of the library).
With respect to the content of an item, the following texinfo
markup elements are recognized:
|