Typographical Notation

Table 1 shows the typographical notation and conventions used to describe commands, SQL syntax, and graphical user interface (GUI) features. This notation is used throughout this book and other IBM Tivoli Netcool® publications.

Table 1: Typographical Notation

Example

Description

Monospace

The following are described in a monospace font:

•    Commands and command line options

•    Screen representations

•    Source code

•    Object names

•    Program names

•    SQL syntax elements

•    File, path, and directory names

Italicized monospace text indicates a variable that the user must populate. For example, -password password.

Bold

The following application characteristics are described in a bold font style:

•    Buttons

•    Frames

•    Text fields

•    Menu entries

A bold arrow symbol indicates a menu entry selection. For example, File’Save.

Italic

The following are described in an italic font style:

•    An application window name; for example, the Login window

•    Information that the user must enter

•    The introduction of a new term or definition

•    Emphasized text

[1]    

Code or command examples are occasionally prefixed with a line number in square brackets. For example:

[2]    First command...

[3]    Second command...

[4]    Third command...

{ a | b }

In SQL syntax notation, curly brackets enclose two or more required alternative choices, separated by vertical bars.

[ ]

In SQL syntax notation, square brackets indicate an optional element or clause. Multiple elements or clauses are separated by vertical bars.

|

In SQL syntax notation, vertical bars separate two or more alternative syntax elements.

...

In SQL syntax notation, ellipses indicate that the preceding element can be repeated. The repetition is unlimited unless otherwise indicated.

,...

In SQL syntax notation, ellipses preceded by a comma indicate that the preceding element can be repeated, with each repeated element separated from the last by a comma. The repetition is unlimited unless otherwise indicated.

a

In SQL syntax notation, an underlined element indicates a default option.

( )

In SQL syntax notation, parentheses appearing within the statement syntax are part of the syntax and should be typed as shown unless otherwise indicated.

Many IBM Tivoli Netcool commands have one or more command line options that can be specified following a hyphen (-).

Command line options can be string, integer, or BOOLEAN types:

•   A string can contain alphanumeric characters. If the string has spaces in it, enclose it in quotation (") marks.

•   An integer must contain a positive whole number or zero (0).

•   A BOOLEAN must be set to TRUE or FALSE.

SQL keywords are not case-sensitive, and may appear in uppercase, lowercase, or mixed case. Names of ObjectServer objects and identifiers are case-sensitive.

 

Tip, Note, and Warning information

 

The following types of information are used in the documentation:

 

  Note


    Note is used for extra information about the feature or operation that is being described. Essentially, this is for extra data that is important but not vital to the user.


 

Tip


    Tip is used for additional information that might be useful for the user. For example, when describing an installation process, there might be a shortcut that could be used instead of following the standard installation instructions.


 

Attention


    Attention is used for highlighting vital instructions, cautions, or critical information. Pay close attention to this information, as it is vital to the successful use of IBM’s products.


 

Syntax and Sample subheadings

The following types of constrained subheading are used in the documentation:

Syntax:

Syntax subheadings contain examples of ObjectServer SQL syntax commands and their usage. For example:

CREATE DATABASE database_name;

Sample:

Sample subheadings describe typical or generic scenarios, or samples of code. For example:

[1]    <body>

[2]     <img src="ChartView?template=barchart&format=PNG

[3]     &request=image&chart=quote&width=800&height=400" border="0" height="400"

[4]     width="800" alt="Events by Severity"

[5]     >

[6]    </body>