Document Conventions

 

This book uses a standard set of typographical conventions for clarity and ease of use. The NOTE, Procedure, Example, and Command Line conventions also have a second setting used with indentation.

Convention

Description

Italics

Italics indicate placeholders for information that must be supplied, such as user and table names. The word in italics should not be typed, but be replaced by the actual name. Italics also are used to introduce new terms, and are occasionally used for emphasis.

Boldface

Boldface indicates filenames, database names, table names, column names, user names, and other database schema objects. It is also used to emphasize menu commands in procedural steps.

KEYWORDS

All keywords used by the SQL language appear in uppercase when used in normal paragraph text.

small caps

Small capital letters indicate keys on the keyboard. A plus sign (+) between two key names indicates to hold down the first key while pressing the second. A comma (,) between two key names indicates to release the first key before pressing the second key.

NOTE

Contains important information.

Procedure

Indicates that procedural steps or sequential items will follow. Many tasks are described using this format to provide a logical sequence of steps for the user to follow

Example

Examples are given to clarify descriptions, and commonly include text as it will appear on the screen.

Command Line

Indicates text as it should appear on a text-delimited screen. This format is commonly used to show input and output for dmSQL commands or the content in the dmconfig.ini file

Figure: Document Conventions Table