Typographical Conventions

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

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

Formatting convention

Type of Information

Example

Special Bold

Items you must select, such as menu options, command buttons, or items in a list.

Go to the System tab.

 

Titles of chapters, sections, and subsections.

Read the Basic Administration chapter.

Italics

Used to emphasize the importance of a point, to introduce a term or to designate a command line placeholder, which is to be replaced with a real name or value.

The system supports the so called wildcard character search.

Monospace

The names of commands, files, and directories.

The license file is located in the http://docs/common/licenses directory.

Preformatted

On-screen computer output in your command-line sessions; source code in XML, C++, or other programming languages.

# ls –al /files

total 14470

Preformatted Bold

What you type, contrasted with on-screen computer output.

# cd /root/rpms/php

CAPITALS

Names of keys on the keyboard.

SHIFT, CTRL, ALT

KEY+KEY

Key combinations for which the user must press and hold down one key and then press another.

CTRL+P, ALT+F4

Source code highlighting conventions are described in the following table.

Preformatted grey

Comments in code.

//Creates a DEB package

Preformatted blue

User-defined variables.

$MyVariable

Preformatted red

String values.

'Hello, world!'

Preformatted dark-blue

Words or word combinations reserved by a programming language.

procedure CreateAccount()