<synnote>
The <synnote>
element contains a note (similar to a footnote)
within a syntax definition group or fragment. The syntax note explains aspects of the syntax that
cannot be expressed in the markup itself. The note will appear at the bottom of the syntax diagram
instead of at the bottom of the page. This element
is part of the DITA programming domain, a special set of DITA elements
designed to document programming tasks, concepts, and reference information.
Content models
See appendix for information about this element in OASIS document type shells.
Inheritance
+ topic/fn pr-d/synnote
Example
<groupcomp><var>one</var><var>two</var><var>three</var></groupcomp>
<synnote>My first syntax note.</synnote>
Attributes
The following attributes are available on this element: Universal attribute group, outputclass, and the attribute defined below.
@callout
- Specifies what character is used for the
footnote link, for example a number or an alpha
character. The attribute can also specify a short string of
characters. When no
@callout
value is specified, footnotes are typically numbered.
@datatype
- Available for describing the type of data contained in the value attribute for this metadata element. The default value is the empty string "".