Syntax Diagrams - Document Convention

The commands described in this manual have their legal command and interrogation options presented in the form of syntax diagrams. These diagrams formalize the precise command sequences which may be used and are intended to supplement the explanations given in the appropriate sections of the manual.

The following conventions apply to syntax diagrams:

• All diagrams have abbreviated names. Such names are composed of lowercase letters enclosed in angled brackets, For example, <expres>. These short names, which are used for cross-referencing purposes in the text and within other syntax diagrams, are supplemented by fuller descriptions where they are not self-explanatory.

• Commands to be input from the Command Line are shown in a combination of uppercase and lowercase letters. In general, these commands can be abbreviated; the capital letters indicate the minimum permissible 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

  DEFault

  may be input in any of the following forms:

  DEF

  DEFA

  DEFAU

  DEFAUL

  DEFAULT

  Commands shown wholly in uppercase letters cannot be abbreviated.

• Syntax diagrams are generally read from top left to bottom right.

• Points marked with a plus sign (+) are option junctions which allow you to input any one of the commands to the right of the junction. Thus

  >---+--- ABC -----.     |             |     |--- PQR -----|     |             |     |--- <dia> ---|     |             |     ‘-------------+--->

  means you may type in ABC or PQR or any command allowed by the syntax given in diagram <dia> or just press Enter/Return to get the default option.

• Points marked with an asterisk (*) are loop-back junctions. Command options following these may be repeated as required. Thus

  .------<------.     /               | >---*--- option1 ---|     |               |     |--- option2 ---|     |               |     ‘--- option3 ---+--->

  permits any combination of option1 and/or option2 and/or option3 (each separated by at least one space) to be used. The ‘options’ may define commands, other syntax diagrams, or command arguments). The loop-back construction may form an exception to the rule of reading from top left to bottom right.

  The simplified format

  .----<-----.        /           |    >---*--- name --+--->

  means that you may type in a list of AVEVA E3D Design names, separated by at least one space.