Typographical Conventions

Copyright © TIBCO Software Inc. All Rights Reserved

Preface : Typographical Conventions

Typographical Conventions

The following typographical conventions are used in this manual.

Table 1 General Typographical Conventions

Convention

Use

TIBCO_HOME

TIB_ADLDAP_HOME

ENV_NAME

CONFIG_HOME

Many TIBCO products must be installed within the same home directory. This directory is referenced in documentation as TIBCO_HOME. The default value of TIBCO_HOME depends on the operating system. For example, on Windows systems, the default value is C:\tibco.

Other TIBCO products are installed into an installation environment. Products installed into different installation environments do not share components. 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. The name is appended to the name of Windows services created by the installer and is a component of the path to the product in the Windows Start > All Programs menu. This directory is referenced in documentation as ENV_NAME.

•

Path The directory into which the product is installed. This directory is referenced in documentation as TIBCO_HOME. TIBCO ActiveMatrix Adapter for LDAP installs into a directory within TIBCO_HOME. This directory is referenced in documentation as TIB_ADLDAP_HOME. The default value of TIB_ADLDAP_HOME depends on the operating system. For example, on Unix systems, the default value is TIBCO_HOME/adapter/adldap/version.

A TIBCO configuration folder stores configuration data generated by TIBCO products. Configuration data can include sample scripts, session data, configured binaries, logs, and so on. This folder is referenced in documentation as CONFIG_HOME. The default location of the folder is USER_HOME/ENV_NAME/tibco/cfgmgmt/product_name. For example, on Windows, the default location is C:\Documents and Settings\user_name\Application Data\ENV_NAME\tibco\cfgmgmt\product_name

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 ActiveMatrix 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 names 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.

Table 2 Syntax Typographical Conventions

Convention

Use

[ ]

An optional item in a command or code syntax.

For example:

MyCommand [optional_parameter] required_parameter

|

A logical OR that separates multiple items of which only one may be chosen.

For example, you can select only one of the following parameters:

MyCommand param1 | param2 | param3

{ }

A logical group of items in a command. Other syntax notations may appear within each logical group.

For example, the following command requires two parameters, which can be either the pair param1 and param2, or the pair param3 and param4.

MyCommand {param1 param2} | {param3 param4}

In the next example, the command requires two parameters. The first parameter can be either param1 or param2 and the second can be either param3 or param4:

MyCommand {param1 | param2} {param3 | param4}

In the next example, the command can accept either two or three parameters. The first parameter must be param1. You can optionally include param2 as the second parameter. And the last parameter is either param3 or param4.

MyCommand param1 [param2] {param3 | param4}

Convention	Use
[ ]	An optional item in a command or code syntax. For example: MyCommand [optional_parameter] required_parameter
\|	A logical OR that separates multiple items of which only one may be chosen. For example, you can select only one of the following parameters: MyCommand param1 \| param2 \| param3
{ }	A logical group of items in a command. Other syntax notations may appear within each logical group. For example, the following command requires two parameters, which can be either the pair param1 and param2, or the pair param3 and param4. MyCommand {param1 param2} \| {param3 param4} In the next example, the command requires two parameters. The first parameter can be either param1 or param2 and the second can be either param3 or param4: MyCommand {param1 \| param2} {param3 \| param4} In the next example, the command can accept either two or three parameters. The first parameter must be param1. You can optionally include param2 as the second parameter. And the last parameter is either param3 or param4. MyCommand param1 [param2] {param3 \| param4}