Conventions Used in the Syntax Graphs
- Last UpdatedAug 19, 2025
- 3 minute read
The commands described are presented in the form of syntax graphs.
-
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 can be typed in any combination of uppercase and lowercase letters.
-
For example, the command:
Create
can be typed 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 needs to be typed. For example:
FONTDirectory name
This means that to set the name of the Font Directory to newfonts, type:
FONTD newfonts
-
Syntax graphs are read from the top left to the bottom right. The starting point is shown by '>', and the user can follow any path through the graph until the exit point, also shown by '>', is reached.
-
Points marked with a plus sign (+) are option junctions, which allows the user to input any one of the commands to the right of the junction. For example:
>---+--- ABC ---.
| |
|--- PQR --- |
| |
‘------------+->
This means that the user can type in ABC, 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 user can type in ABC, PQR, or any command allowed by the syntax given in the diagram <dia> or just 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 user 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 user may type in a list of AVEVA E3D Design names, separated by at least one space.
-
Names in lowercase letters enclosed in angled brackets (for example: <gid>) represent subsidiary syntax diagrams. Most of the subsidiary syntax diagrams are given in Software Customization Reference. The only ones used in this manual are <gid> and <uval>.
-
In Isodraft, the <gid> syntax has the restricted range of options which are shown here:
>---+--- name ----.
| |
‘--- refno ---+--->
-
The full range of options for <gid> are shown in the Software Customization Reference. They apply only to database navigation operations.
-
<uval> is used to enter a dimension using a unit of measurement, which is not the current default unit:
>---+-- value -----.
| |
‘-- <expres> --+-- EXponential -- value --.
| |
‘--------------------------+--- MM -------.
| |
|--- Metres ---|
| |
|--- INches ---|
| |
|--- FT -------|
| |
|--- FEet -----|
| |
|--- text -----|
| |
‘--------------+-->
where <expres> is another subsidiary diagram representing the range of mathematical expressions that can be used to input values, and text represents a user-defined unit of measurement. The use of expressions in AVEVA E3D Design is described in PML Customization.
For example:
9.75 INCH
1.5 FT
Note: For information about the syntax of PML, the AVEVA E3D Design Programmable Macro Language, and the AVEVA E3D Design forms and menus, refer to PML Customization.