Syntax examples

The following table provides syntax examples.
Table 1. Syntax examples
Item Syntax example
Required item.

Required items appear on the main path of the horizontal line. You must specify these items.

 

1  KEYWORD required_item
Required choice.

A required choice (two or more items) appears in a vertical stack on the main path of the horizontal line. You must choose one of the items in the stack.

 

1  KEYWORD
2.1 required_choice1
2.1 required_choice2
Optional item.

Optional items appear below the main path of the horizontal line.

 

1  KEYWORD? optional_item
Optional choice.

A optional choice (two or more items) appear in a vertical stack below the main path of the horizontal line. You may choose one of the items in the stack.

 

1  KEYWORD
2.1 optional_choice1
2.1 optional_choice2
Default.

Default items appear above the main path of the horizontal line. The remaining items (required or optional) appear on (required) or below (optional) the main path of the horizontal line. The following example displays a default with optional items.

 

1  KEYWORD
2.1! default_choice1
2.1 optional_choice2
2.1 optional_choice3
Variable.

Variables appear in lowercase italics. They represent names or values.

 

1  KEYWORD variable
Repeatable item.

An arrow returning to the left above the main path of the horizontal line indicates an item that can be repeated.

An arrow returning to the left above a group of repeatable items indicates that one of the items can be selected, or a single item can be repeated.

 

1  KEYWORD +  repeatable_item
Fragment.

The -| fragment |- symbol indicates that a labelled group is described below the main syntax diagram. Syntax is occasionally broken into fragments if the inclusion of the fragment would overly complicate the main syntax diagram.

 

1  KEYWORD %fragment
fragment

1  , required_choice1
1  , required_choice2
2.1!  , default_choice
2.1  , optional_choice