The syntax note (<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.
Contains
Note: These models represent only the default document types distributed by OASIS.
Actual content models will differ with each new document type.
Contained by
| Doctype |
Content model |
|---|
| topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task (strict), task (general), bookmap |
syntaxdiagram, synblk, groupseq, groupchoice, groupcomp, fragment |
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
| Name |
Description |
Data Type |
Default Value |
Required? |
| callout |
Specifies what character is used for the footnote link, for
example a number or an alpha character. The attribute may also specify a short
string of characters. When no callout value is specified, footnotes are
numbered. |
CDATA |
#IMPLIED |
No |
| univ-atts attribute group (includes select-atts, id-atts,
and localization-atts groups) |
A set of related attributes, described in
univ-atts attribute group |
|
|
|
| global-atts attribute group (xtrf, xtrc) |
A set of related attributes, described in
global-atts attribute group |
|
|
|
| class, outputclass |
Common attributes described in
Other common DITA attributes |
|
|
|