`<groupseq>`

The <groupseq> element specifies the sequence of groups with pieces of syntax.

Usage information

Each syntax group is a logical set of pieces of syntax that go together. Within the syntax definition, groups of keywords, delimiters and other syntax units act as a combined unit, and they occur in a specific sequence, as delimited by the <groupseq> element.

Specialization hierarchy

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

Content model

In order

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, required, or used by default. The attribute value is limited to optional, required, default, 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, required, or used by default. The attribute value is limited to optional, required, default, or -dita-use-conref-target.

Example

This section is non-normative.

The following code sample shows how the <groupseq> element can be used to indicate that a short set of command line syntax is specified in a sequential order. The runprogram tool name is followed by a choice of how to specify an input file.

<syntaxdiagram>
  <title>Syntax for runprogram command</title>
  <groupseq>
    <kwd>runprogram</kwd>
    <groupchoice>
      <groupcomp><oper>-</oper><kwd>i</kwd><sep>:</sep><var>program-name.py</var></groupcomp>
      <groupcomp><oper>--</oper><kwd>input</kwd><sep>=</sep><var>program-name.py</var></groupcomp>
    </groupchoice>
  </groupseq>
</syntaxdiagram>