About this Help

This section describes the conventions that convey instructions and other information.

Conventions

Typographical

The following table explains the typographical conventions used in this help.

Convention

Application

Bold

User interface controls, commands, and keywords in body text.

italic

User input entered.

<…>

Generic parameters that must be replaced by specific code or text.

Icons

The following table explains the icon conventions used in this help.

Convention

Application

Note:

This icon designates a note or helpful suggestion or reference relating to the surrounding text.

Best Practice:

This icon designates a suggestion for best practice relating to the surrounding text.

Alert:

This icon designates warning or alert relating to the surrounding text. In this situation, the user should exercise caution to avoid an undesirable result.