Previous Topic

Next Topic

Book Contents

Book Index

Typographical Conventions

Before you start using this guide, it is important to understand the terms and typographical conventions used in the documentation.

The following kinds of formatting in the text identify special information.

Formatting convention

Type of Information

Special Bold

  • Items you must select, such as menu options, command buttons, or items in a list
  • Type of note
  • Values you must type, constants

Emphasis

  • Titles of books
  • Important word
  • Captions for figures
  • Variable expressions such as parameters

Monospace

Code samples

CAPITALS

Names of keys on the keyboard. for example, SHIFT, CTRL or ALT.

KEY+KEY

Key combinations for which the user must press and hold down one key and then press another, for example, CTRL+P or ALT+F4.

The following formatting is used to explain command syntax:

Formatting convention

Type of Information

Special Bold

Values you must type, constants

Emphasis

Variable expressions such as parameters

Monospace

Code samples

[ ]

Brackets enclose optional parameters

{ }

Braces or curly brackets enclose required parameters

|

Bar separates options within brackets or braces

( ...)

Indicates options may repeat