<synnote>
The syntax note provides additional information within a syntax diagram.
Usage information
The syntax note explains aspects of the syntax that cannot be expressed in the markup itself.
Rendering expectations
The note typically appears at the bottom of the syntax diagram instead of at the bottom of the page.
Specialization hierarchy
The <synnote> element is specialized from <fn>. It
is defined in the syntax-diagram domain module, which is a specialization of the programming
domain module.
Content model
(Text |
<cite>
|
<include>
|
<keyword>
|
<markupname>
|
<apiname>
|
<option>
|
<parmname>
|
<cmdname>
|
<msgnum>
|
<varname>
|
<wintitle>
|
<numcharref>
|
<parameterentity>
|
<textentity>
|
<xmlatt>
|
<xmlelement>
|
<xmlnsname>
|
<xmlpi>
|
<ph>
|
<strong>
|
<em>
|
<b>
|
<i>
|
<line-through>
|
<overline>
|
<sup>
|
<sub>
|
<tt>
|
<u>
|
<hwcontrol>
|
<partno>
|
<codeph>
|
<filepath>
|
<msgph>
|
<systemoutput>
|
<userinput>
|
<synph>
|
<menucascade>
|
<uicontrol>
|
<q>
|
<term>
|
<abbreviated-form>
|
<text>
|
<tm>
|
<xref>
)*
Contained by
<fragment>
,
<groupchoice>
,
<groupcomp>
,
<groupseq>
,
<synblk>
,
<syntaxdiagram>
- Text
-
<abbreviated-form> -
<apiname> -
<b> -
<cite> -
<cmdname> -
<codeph> -
<em> -
<filepath> -
<hwcontrol> -
<i> -
<include> -
<keyword> -
<line-through> -
<markupname> -
<menucascade> -
<msgnum> -
<msgph> -
<numcharref> -
<option> -
<overline> -
<parameterentity> -
<parmname> -
<partno> -
<ph> -
<q> -
<strong> -
<sub> -
<sup> -
<synph> -
<systemoutput> -
<term> -
<text> -
<textentity> -
<tm> -
<tt> -
<u> -
<uicontrol> -
<userinput> -
<varname> -
<wintitle> -
<xmlatt> -
<xmlelement> -
<xmlnsname> -
<xmlpi> -
<xref>
Contained by
Inheritance
+ topic/fn pr-d/fn syntaxdiagram-d/synnote
The <synnote> element is specialized from
<fn>
. It is defined in the syntaxdiagram-domain module.
Attributes
The following attributes are available on this element: universal attributes and the attribute defined below.
The following attributes are available on this element: universal attributes and the attributes defined below.
Example
This section is non-normative.
The following code sample show how the
<synnote> element can be used to remind
the reader where to find information for a required parameter:
<syntaxdiagram id="validate">
<title>Validate account setup</title>
<groupseq>
<kwd>clicmd</kwd>
<groupcomp>
<oper>--</oper><kwd>user</kwd><sep>=</sep><var>userid</var>
<synnote>Your user ID can be found in your account activation email.</synnote>
</groupcomp>
<groupcomp>
<oper>--</oper><kwd>validate</kwd>
</groupcomp>
</groupseq>
</syntaxdiagram>