Convention | Description |
---|---|
Italic | In paragraph text, italic identifies the titles of documents that are being referenced. When used in conjunction with the Code text described below, italics identify a variable that should be replaced by the user with an actual value. |
Bold | Emphasizes items of particular importance. |
Code | Text that represents program code. |
A path to a function or dialog box within an interface. For example, | indicates that you should select the Open function from the file menu.|
( ) and | | Parentheses enclose optional items in command syntax. The vertical bar (pipe) separates syntax items in a list of choices. For example, any of the following three items can be entered in this syntax: persistPolicy (Never | OnTimer | OnUpdate | NoMoreOftenThan) |
Note:
or Warning:
|
A note highlights important supplemental information. A warning highlights procedures or information that is necessary to avoid damage to equipment, damage to software, loss of data, or invalid test results. |