Documentation Conventions
The following sections describe Dictionary-IV documentation conventions.
Keyboard Designations
Section titled “Keyboard Designations”Keys on the keyboard are identified in bold type. For example, Press Enter to make your selection or press F4 to exit.
The documentation refers to Line-Insert Key, Line-Delete Key, End-of-Line Key, etc. These are the functions of particular keys. Please refer to your keyboard documentation to determine the specific key that performs this function for you.
Prompts and Messages
Section titled “Prompts and Messages”Software prompts and messages are indented and shown in bold type. For example:
RETURN-Select, F4-END
Save Changes (Y/N)
Prompts and messages may refer to Return,<CR>, or Carriage Return. This manual refers to these as the Enter key.
Responses
Section titled “Responses”Options you may select or information you must type appear in bold type. It must be entered exactly as shown. For example, Type John Smith and press Enter.
Notational Symbols
Section titled “Notational Symbols”Syntax appears in a bold non-proportional font to better display spaces and punctuation. Elements of the syntax are always explained directly below. The following conventions are used in command formats throughout the Thoroughbred product line.
Command Syntax
CONNECT VIEW {view-name-1}[[view-name-2]...]- Notational Symbol
- Description
- (BOLD
- CONNECT VIEW
- FACE/UPPERCASE)
- Commands or keywords you must type exactly as shown. Example: CONNECT VIEW UTVCUST You must type CONNECT VIEW including the space.
- Italic Face
- view-name-1 Information you must supply. Example: CONNECT VIEW UTVCUST You supply the view name UTVCUST. In most cases, lowercase italics denotes values that accept uppercase or lowercase characters.
- Braces { }
- {view-name-1} [[view-namd-2]...] You must select one of the values enclosed by the braces. Example: {UTVCUST1} [[UTVCUST2]... You must supply the view name UTVCUST1.
- Brackets [ ]
- You can select one of the options enclosed by the brackets; none of the enclosed values is required. Example: {UTVCUST1} [[UTVCUST2]... You must supply the view name UTVCUST1. You may also supply the optional view name UTVCUST2.
- Ellipsis …
- You can repeat the word or clause that immediately precedes the ellipsis. Example: {UTVCUST1} [[UTVCUST2]... You must supply the view name UTVCUST1. You may also supply the optional view names UTVCUST2, UTVCUST3, UTVCUSTX. X represents any existing view name in the library.
- Other Notational Symbols
-
- Notational Symbol
- Description Option-1 | Option-2 | Option-3
- Vertical Bar |
- Piping separates options. One vertical bar separates options; two vertical bars separate three options. You select only one of the options. Example: Add|Change|Delete You may select the Add, Change, or Delete option.
- Underscores
- Either a default in a command description or display
or UPPERCASE ITALICS default in a screen image.
Example: Add|Change|Delete
You may select the Add, Change, or Delete option. The Change option is the default value.
From the Dictionary-IV User Guide, version 8.9.1. Open this page in the PDF