groupchoice

Darwin Information Typing Architecture (DITA) Version 1.3 Part 3: All-Inclusive Edition

version
1.3
author
OASIS DITA Technical Committee

The groupchoice element is part of the subset of elements that define syntax diagrams in DITA. A group is a logical set of pieces of syntax that go together. A group choice specifies that the user must make a choice about which part of the syntax to use. Groups are often nested. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts, and reference information.

Content models

See appendix for information about this element in OASIS document type shells.

Inheritance

+ topic/figgroup pr-d/groupchoice

Example

<syntaxdiagram frame="bottom">
 <title>CopyFile</title>
 <groupseq><kwd>COPYF</kwd></groupseq>
 <groupcomp><var>input-filename</var><kwd>*INFILE</kwd></groupcomp>
 <groupseq><var>output-filename</var><kwd>*OUTFILE</kwd></groupseq>
 <groupchoice><var>input-filename</var><kwd>*INFILE</kwd></groupchoice>
 <groupchoice><var>output-filename</var><kwd>*OUTFILE</kwd></groupchoice>
</syntaxdiagram>

Attributes

The following attributes are available on this element: Universal attribute group (with a narrowed definition of importance, given below) and outputclass.

importance
The attribute indicates whether this item in a syntax diagram is optional, required, or default. Output processors can indicate this designation in a generated diagram. Allowable values are:
optional
This section of the syntax is optional.
required
This section of the syntax is required.
default
This section of the syntax is used by default or has this default value.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.