Typographical Conventions

The following typographical conventions are used in this manual.

Table 1 General Typographical Conventions (Cont’d)

Convention

TIBCO products are installed into an installation environment. A product installed into an installation environment does not access components in other installation environments. Incompatible products and multiple instances of the same product must be installed into different installation environments.

An installation environment consists of the following properties:

•

Name Identifies the installation environment. This name is referenced in documentation as ENV_NAME. On Microsoft Windows, the name is appended to the name of Windows services created by the installer and is a component of the path to the product shortcut in the Windows Start > All Programs menu.

•

Path The folder into which the product is installed. This folder is referenced in documentation as TIBCO_HOME.

TIBCO Hawk installs into a directory within a TIBCO_HOME. This directory is referenced in documentation as HAWK_HOME. The default value of HAWK_HOME depends on the operating system. For example on Windows systems, the default value is C:\tibco\hawk\5.2.

A TIBCO Hawk configuration folder stores configuration data generated by TIBCO Hawk. Configuration data can include sample scripts, session data, configured binaries, logs, and so on. This folder is referenced in documentation as CONFIG_FOLDER. For example, on Windows systems, the default value is C:\ProgramData\tibco\cfgmgmt\hawk.

code font

Code font identifies commands, code examples, filenames, pathnames, and output displayed in a command window. For example:

Use MyCommand to start the foo process.

bold code font

Bold code font is used in the following ways:

•

In procedures, to indicate what a user types. For example: Type admin.

•

In large code samples, to indicate the parts of the sample that are of particular interest.

•

In command syntax, to indicate the default parameter for a command. For example, if no parameter is specified, MyCommand is enabled:
MyCommand [enable | disable]

italic font

Italic font is used in the following ways:

•

To indicate a document title. For example: See TIBCO BusinessWorks Concepts.

•

To introduce new terms For example: A portal page may contain several portlets. Portlets are mini-applications that run in a portal.

•

To indicate a variable in a command or code syntax that you must replace. For example: MyCommand pathname

Key combinations

Key name separated by a plus sign indicate keys pressed simultaneously. For example: Ctrl+C.

Key names separated by a comma and space indicate keys pressed one after the other. For example: Esc, Ctrl+Q.

The note icon indicates information that is of special interest or importance, for example, an additional action required only in certain circumstances.

The tip icon indicates an idea that could be useful, for example, a way to apply the information provided in the current section to achieve a specific result.

The warning icon indicates the potential for a damaging situation, for example, data loss or corruption if certain steps are taken or not taken.