The syntax diagrams are read from left to
right, and from top to bottom. The syntax diagrams are text-based
with symbols to indicate valid usage of the statement. Words that
are shown in italics, are descriptive placeholders. They are not
part of the syntax but they describe the type of information it
should be replaced with. Words that are in normal face, represent
the actual syntax that the user should use. The following table
is a summary of the symbols used in the syntax diagrams
throughout the online help.
| |
Symbol |
Description |
| item |
no symbol |
To indicate that the item is required as part of the syntax.
| Given |
|
Possibilities |
| statement required_item
|
|
statement required_item |
|
| [ item
] |
brackets |
To indicate that the item between the left and right brackets is
optional.
| Given |
|
Possibilities |
| statement [optional_item]
|
|
statement
statement optional_item |
|
| [ item
]* |
brackets with asterisk |
To indicate that if the
optional item is included in the statement, the item or item-type can be repeated 0 or more times in
sequential order.
| Given |
|
Possibilities |
| statement [optional_item]*
|
|
statement
statement optional_item, ... |
|
| ( item
)* |
parentheses with asterisk |
To indicate that the
mandatory item or item-type can be repeated 0 or more times in
sequential order. This is rarely part of a syntax.
| Given |
|
Possibilities |
| statement item1(,
required_item)* |
|
statement item1
statement item1, required_item,
... |
|
| [ item
]+ |
brackets with 'addition'
symbol |
To indicate that if the
optional item is included in the statement, the item or item-type can be repeated 1 or more times in
sequential order.
| Given |
|
Possibilities |
| statement [optional_item]+
|
|
statement
statement optional_item
statement optional_item, ... |
|
| ( item
)+ |
parentheses with
'addition' symbol |
To indicate that the
mandatory item or item-type can be be repeated 1 or more times in
sequential order.
| Given |
|
Possibilities |
| statement (required_item)+
|
|
statement required_item
statement required_item, ... |
|
| item1
| item2 |
pipe |
To indicate that you have
the option of choosing item1 or item2. If the choices are enclosed in brackets, then
the choices are optional. If the choices are enclosed in
parentheses, then the one of the options must be
selected.
| Given |
|
Possibilities |
| statement (choice1
| choice2 | choice3) |
|
statement choice1
statement choice2
statement choice3 |
Note: if the parentheses were replaced
with brackets, another option would be statement
(by itself) in addition to the other possibilities.
|
| ... |
three periods in sequence |
To indicate that the
syntax continues on the next line. It is not part of the
syntax. Usually if the syntax is too long for the display
width, it will be divided into two parts.
| Given |
|
Possibility |
statement1 ...
statement2_follows |
|
statement1
statement2_follows |
|
The example shown above, is the syntax for
using the macro definition and expansion directive. The syntax is
divided into four parts. A step by step interpretation of this
syntax diagram would begin with: