`<synnoteref>`

A syntax note reference is the mechanism for referencing a syntax note within the same syntax diagram.

Usage information

The same notation can be used in more than one syntax definition.

Specialization hierarchy

The <synnoteref> element is specialized from <xref>. It is defined in the syntax-diagram domain module, which is a specialization of the programming domain module.

Content model

EMPTY

Empty

Attributes

The following attributes are available on this element: universal attributes and @href.

For this element, the @href attribute is a reference to a syntax note within the same syntax diagram.

The following attributes are available on this element: universal attributes and the attributes defined below.

@href (link-relationship attributes): Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.; For this element, the @href attribute is a reference to a syntax note within the same syntax diagram.

Example

This section is non-normative.

In the following code sample, a syntax note is reused twice in the sample diagram, instructing the reader how to request a modified user name or password:

<syntaxdiagram id="validate">
  <title>Validate account setup</title>
  <groupseq>
    <kwd>clicmd</kwd>
    <groupcomp>
      <oper>--</oper><kwd>user</kwd><sep>=</sep><var>account_id</var><synnoteref href="#./reset"/>
    </groupcomp>
    <groupcomp>
      <oper>--</oper><kwd>pwd</kwd><sep>=</sep><var>password_key</var><synnoteref href="#./reset"/>
    </groupcomp>
    <groupcomp>
      <oper>--</oper><kwd>validate</kwd>
    </groupcomp>
  </groupseq>
  <synnote id="reset">If you have forgotten your account ID or password key,
    please contact customer support.</synnote>
</syntaxdiagram>