funcsynopsisinfo — Information supplementing the funcdefs of a funcsynopsis
funcsynopsisinfo ::=
(info
? db.titleforbidden.info, ((text |
lineannotation
| Bibliography inlines | Computer-output inlines | Error inlines | Graphic inlines | GUI inlines | Indexing inlines | Keyboard inlines | Linking inlines | Markup inlines | Math inlines | Object-oriented programming inlines
| Operating system inlines |
Product inlines | Programming inlines | Publishing inlines | Technical inlines | Ubiquitous inlines | User-input inlines)* |
textobject
))
Common attributes and common linking attributes.
Additional attributes:
continuation
(enumeration) = “continues” | “restarts”
linenumbering
(enumeration) = “numbered” | “unnumbered”
startinglinenumber
(integer)
language
xml:space
(enumeration) = “preserve”
Supplementary information in a funcsynopsis
.
See funcsynopsis
.
Unlike the other info elements,
funcsynopsisinfo
is not a container for meta-information. Instead,
funcsynopsisinfo
is a verbatim environment for adding
additional information to a function synopsis.
This element is displayed “verbatim”; whitespace and line breaks within this element are significant.
Common attributes and common linking attributes.
Determines whether line numbering continues from the previous element or restarts.
Enumerated values: | |
---|---|
“continues” | Line numbering continues from the immediately preceding element with the same name. |
“restarts” | Line numbering restarts (begins at 1, usually). |
Identifies the language (i.e., programming language) of the verbatim content.
Determines whether lines are numbered.
Enumerated values: | |
---|---|
“numbered” | Lines are numbered. |
“unnumbered” | Lines are not numbered. |
Specifies the initial line number.
Can be used to indicate explicitly that whitespace in the verbatim environment is preserved. Whitespace must always be preserved in verbatim environments whether this attribute is specified or not.
Enumerated values: | |
---|---|
“preserve” | Whitespace must be preserved. |