<delim>

A delimiter is a character that marks the beginning or end of a section within a syntax diagram.

Usage information

Typical delimiter characters are parentheses, commas, tabs, vertical bars, or other special characters.

Specialization hierarchy

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

Content model

(Text | <data> | <foreign> | <keyword> | <term> | <text>)*

Contained by

<groupchoice>, <groupcomp>, <groupseq>, <synph>

Zero or more of the following
  • Text
  • <data>
  • <foreign>
  • <keyword>
  • <term>
  • <text>

Contained by

Inheritance

+ topic/ph pr-d/ph syntaxdiagram-d/delim

The <delim> element is specialized from <ph>. It is defined in the syntaxdiagram-domain module.

Attributes

The following attributes are available on this element: universal attributes.

For this element, the @importance attribute indicates whether this item in a syntax diagram is optional or required. The attribute value is limited to optional, required, or -dita-use-conref-target.

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

@importance
For this element, the @importance attribute indicates whether this item in a syntax diagram is optional or required. The attribute value is limited to optional, required, or -dita-use-conref-target.

Example

This section is non-normative.

The following code sample shows how the <delim> element can be used to specify that the equal sign (=) is used to mark the end of the group sequence:

<syntaxdiagram>
  <title>Integer addition</title>
  <groupseq>
    <var>integer</var>
    <oper>+</oper>
    <var>integer</var>
    <delim>=</delim>
    <var>total</var>
  </groupseq>
</syntaxdiagram>