Documentation Conventions

This guide makes use of the following documentation conventions:

Bold

Bold text is used for emphasis and in a procedure indicates a key, link or menu option that is to be selected.

Bold Italic

Bold and italic text in a procedure indicates a button that is to be selected.

Ctrl+V

Indicates two keys that must be pressed sequentially.

Italic

Indicates emphasis or a Prognosis document name (Display, Analyst, etc).

Syntax Conventions

Conventions for defining syntax in Prognosis are as follows:

{Option A | Option B}

Braces - A group of items included within braces and separated by vertical lines indicates a list from which one item is to be entered (i.e. either ’Option A’ or ’Option B’ may be included but not both). The braces themselves are not entered.

|

When shown within braces the vertical line separates mutually exclusive choices, the line is not included in the actual input. In other cases, without braces, the vertical line is used to separate multiple items and is included as part of the input.

Item A[, Item B]

Brackets - Items included within brackets indicate options from which one or none may be entered (often includes a comma (,) as the first character since a list of options will normally be separated by a comma). Except where otherwise noted the brackets themselves should not be entered.

NOTE: Section names in INI files are enclosed by literal brackets, in these cases, they do not represent options and form part of the input.

<value>

The enclosed text describes a constant which should be substituted with an appropriate value. The <> characters should not be entered.

, ( ) / ; etc

These general punctuation marks are included in the input exactly as they appear in the syntax.

"["

Quotation marks around a symbol indicate that the character is required and must be entered as shown. The actual quotation marks are not included in the input.

One exception to this is the use of "[" and "]" in INI files. INI files use these literal square brackets to define sections, and they must be included.

...

Ellipsis - An ellipsis immediately following a pair of brackets or braces indicates that the enclosed sequence of syntax items can be repeated multiple times. For example, TME USER (<user>[, <user>]...)

For example, the following is a section of configuration syntax.

SUBSYS ABCD

[AUTO-INV ({HARDWARE | SOFTWARE | SCOBOL}, {ON | OFF})]
[TME-USER ([<server-name>\]<user>[, <user>]...)]
  • The AUTO-INV statement is optional, but if included, the parameters must be contained within parenthesis. The parameters MUST include ONE ONLY of HARDWARE, SOFTWARE, or SCOBOL and must include one of ON or OFF.

  • The TME-USER statement is optional, but if included, the parameters must be contained within parenthesis. The parameters must include the name of at least one user, which can optionally be preceded by a 'server-name' name followed by a \. Additional user names can be included with each one separated by a comma.

Provide feedback on this article