Document conventions

The following conventions will be used in the documentation created by ConnectPlaza®.

1. Text conventions

Conventions	Description
Bold	Bold typeface indicates commands or characters the user types, provides emphasis, or the names of user interface elements.
Italic	Directory structures
`KEYBOARD`	Indicate key functions and generic keyboard keys; for example, `GET` and `CTRL`.
`KEY1`+`KEY`	A plus sign between key names indicates a simultaneous key sequence: you press and hold down the first key while pressing the second key. For example, `CTRL`+`X`.
`KEY1` `KEY2`	A space between key names indicates a sequential key sequence: you press and release the first key, then press another key. For example, `ESCAPE` `H`.

Conventions

Description

Bold

Bold typeface indicates commands or characters the user types, provides emphasis, or the names of user interface elements.

Italic

Directory structures

KEYBOARD

Indicate key functions and generic keyboard keys; for example, GET and CTRL.

KEY1+KEY

A plus sign between key names indicates a simultaneous key sequence: you press and hold down the first key while pressing the second key. For example, CTRL+X.

KEY1 KEY2

A space between key names indicates a sequential key sequence: you press and release the first key, then press another key. For example, ESCAPE H.

2. Code conventions

When code is explained, you we will use the following syntax conventions in our documents.

Convention Description

Convention	Description
`Fixed width`	A fixed-width font is used in syntax, code examples, system output, and file names.
`Fixed-width italics`	Fixed-width italics indicate variables in syntax.
`Fixed-width bold`	Fixed-width bold italic indicates variables in syntax with special emphasis.
`UPPERCASE fixed width`	Keywords in syntax and code examples are almost always shown in upper case.
[ ]	Brackets indicate the items within them are optional.
{ }	Braces indicate the items within them are required.
\|	A vertical bar indicates a choice.
…	Ellipses indicate repetition. You can choose one or more of the preceding items.

Fixed width

A fixed-width font is used in syntax, code examples, system output, and file names.

Fixed-width italics

Fixed-width italics indicate variables in syntax.

Fixed-width bold

Fixed-width bold italic indicates variables in syntax with special emphasis.

UPPERCASE fixed width

Keywords in syntax and code examples are almost always shown in upper case.

[ ]

Brackets indicate the items within them are optional.

{ }

Braces indicate the items within them are required.

A vertical bar indicates a choice.

…

Ellipses indicate repetition. You can choose one or more of the preceding items.