Conventions Used in the Syntax Graphs
- Last UpdatedFeb 15, 2023
- 2 minute read
The syntax graph conventions are as follows:
-
Commands are shown in a combination of uppercase and lowercase letters, where the capital letters indicate the minimum abbreviation.
Note:
This convention does not mean that the second part of the command must be typed in lowercase letters; commands may be entered in any combination of uppercase and lowercase letters.
-
For example, the command
CReate
-
can be input in any of the following forms
CR
CRE
CREA
CREAT
CREATE -
Commands shown in all uppercase letters cannot be abbreviated.
-
Command arguments are shown in lowercase letters. These are just descriptions of what the administrator needs to enter. For example:
FONTDirectory name
-
This means that to set the name of the font directory to newfonts, the administrator enters:
FONTD newfonts
-
Syntax graphs are read from top left to bottom right. The start point is shown by >, and the administrator can follow any path through the graph until the exit point, shown by >, is reached.
-
Points marked with a plus sign (+) are option junctions which allow the administrator to input any one of the commands to the right of the junction. For example:
>----+--- ABC ------.
| |
|--- PQR ------|
| |
‘--------------+---> -
This means the administrator can type in ABC or PQR or just press Enter to get the default option.
-
Text in angle brackets <...> is the name of another syntax graph. This convention is used for syntax which occurs in many places. The graphs referred to are described at the end of this section. For example:
>----+--- ABC ------.
| |
|--- PQR ------|
| |
|--- <dia> ----|
| |
‘--------------+---> -
This means the administrator can type in ABC or PQR or any command allowed by the syntax given in diagram <dia>, or press Enter to get the default option.
-
Points marked with an asterisk (*) are loop back junctions. Command options following these may be repeated as required. For example:
.-----<-------.
/ |
>---*--- option1 ---|
| |
|--- option2 ---|
| |
‘--- option3 ---+---> -
This means that the administrator can enter any combination of option1 and/or option2 and/or option3, where the options can be commands, other syntax diagrams, or command arguments.
-
The simplified format:
.----<------.
/ |
>---*--- name ----+---> -
This means that the administrator may type in a list of the AVEVA base product names, separated by at least one space.