|
Home > |
|---|
This document uses standard conventions for describing the user interface and for alerting you to important information.
Notes are used to alert you to important or helpful information. They use the following format:
Note: Take note. Contains important or helpful information.
Cautions are used to alert you to important information that may help prevent unexpected results or data loss. They use the following format:
CAUTION: Exercise caution. Contains important information that may help prevent unexpected results or data loss.
Warnings are used to alert you to the potential for catastrophic data loss or personal injury. They use the following format:
WARNING! Be extremely careful and obey all safety and security measures. In this situation you might do something that could result in catastrophic data loss or personal injury.
| Format | Convention |
|---|---|
| bold |
The bold attribute is used to indicate the following: •Command-line commands and options (Type dir /p.) • Button names (Click Save As.) • Check box and radio button names (Select the Print Duplex check box.) • Dialog box titles (On the Protect Document dialog box, click Yes.) • Field names (User Name: Enter the name of the user.) • Menu names (On the File menu, click Save.) (Click Menu > Go To > Folders.) •User input (In the Date box, type April 1.) |
| italics |
In type, the italic attribute is used for emphasis or to indicate a related document. (See the Installation Guide for more information.) |
| <variable> | In command descriptions, angle brackets represent variables. You must substitute a value for command line arguments that are enclosed in angle brackets. |
| [optional] [<optional>] |
Represent optional keywords or <variables> in a command line description. Optionally enter the keyword or <variable> that is enclosed in square brackets, if it is necessary or desirable to complete the task. |
| {a|b|c} {<a>|<b>|<c>} |
Represent required alternate keywords or <variables> in a command line description. You must choose one command line argument enclosed within the braces. Choices are separated by vertical (OR) bars. |
| [a|b|c] [<a>|<b>|<c>] |
Represent optional alternate keywords or <variables> in a command line description. Choose one command line argument enclosed within the braces, if desired. Choices are separated by vertical (OR) bars. |