synnote

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. The syntax block element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information.

Example

<groupcomp><var>one</var><var>two</var><var>three</var></groupcomp>
<synnote>My first syntax note.</synnote>         

Contains

Doctype Content model
ditabase, topic, task, reference, concept, glossary ( text data or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or term or xref or cite or q or boolean or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or tm) (any number)

Contained by

Doctype Parents
ditabase, topic, task, concept, reference, glossary syntaxdiagram, synblk, groupseq, groupchoice, groupcomp, fragment

Inheritance:

+ topic/fn pr-d/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; (%select-atts;, %id-atts;, %localization-atts;) A set of related attributes, described at %univ-atts; parameter entity PE not applicable Not applicable
%global-atts; (xtrf, xtrc) A set of related attributes, described at %global-atts; parameter entity PE not applicable Not applicable
class, outputclass Common attributes described in Other common DITA attributes