INFORMIX
DataBlade Developers Kit User's Guide
Introduction
Home Contents Index Master Index New Book

Documentation Conventions

This section describes the conventions that this manual uses. These conventions make it easier to gather information from this and other volumes in the documentation set. The following conventions are covered:

Typographical Conventions

This manual uses the following standard set of conventions to introduce new terms, describe command syntax, and so forth.

Convention Meaning

KEYWORD

All keywords appear in uppercase letters in a serif font.

italics

Within text, new terms and emphasized words appear in italics. Within syntax diagrams, values that you are to specify appear in italics.

boldface

Identifiers (names of classes, objects, constants, events, routines, program variables, forms, labels, and reports), environment variables, database names, filenames, table names, column names, icons, menu items, command names, and other similar terms appear in boldface.

monospace

Information that the product displays and information that you enter appear in a monospace typeface.

KEYSTROKE

Keys that you are to press appear in uppercase letters in a sans serif font.

This symbol indicates the end of product- or platform-specific information.

Tip: When you are instructed to "enter" characters or to "execute" a command, press RETURN immediately after the entry. When you are instructed to "type" the text or to "press" other keys, no RETURN is required.

Icon Conventions

Comment icons identify warnings, important notes, or tips. This information is always displayed in italics.

Icon Description

The warning icon identifies vital instructions, cautions, or critical information.

The important icon identifies significant information about the feature or operation that is being described.

The tip icon identifies additional details or shortcuts for the functionality that is being described.

Routine Syntax Conventions

This guide uses the following conventions to specify routine syntax:

These routine syntax conventions used in context look like this:




DataBlade Developers Kit User's Guide, version 3.6
Copyright © 1998, Informix Software, Inc. All rights reserved.