synnoteref

The syntax note (<synnoteref>) reference element references a syntax note element (<synnote>) that has already been defined elsewhere in the topic. The same notation can be used in more than one syntax definition. The syntax note reference element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information.

Contains

no content

Contained by

syntaxdiagram, synblk, groupseq, groupchoice, groupcomp, fragment

Inheritance

topic/xref, pr-d/synnoteref

Attributes

Name Description Data Type Default Value Required?
href Points to the target syntax note (<synnote>), which must be in the same syntax diagram. Use standard DITA href syntax for targetting the element: href="#topicid/synnoteid" CDATA #IMPLIED No
%univ-atts; (%select-atts;, %id-atts;, translate, xml:lang) 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 othercommon

Example

<synnoteref href="#topicid/mysyn"/>