Document conventions and symbols
Table 2 Document conventions
Convention
Colored
text
Black, underlined text
Colored, underlined
Bold text
Italic text
Monospace text
Monospace, italic text
Monospace, bold text
CAUTION: Indicates that failure to follow directions could result in damage to equipment or data.
IMPORTANT: Provides clarifying information or specific instructions.
NOTE: Provides additional information.
TIP: Provides helpful hints and shortcuts.
Element
Cross-reference links
Email addresses
text
Website addresses
•
Keys that are pressed
•
Text entered into a GUI element, such as a box
•
GUI elements that are clicked or selected, such as menu and list items,
buttons, and check boxes
Text emphasis
•
File and directory names
•
System output
•
Code
•
Commands, their arguments, and argument values
•
Code variables
•
Command parameters
Emphasis of file and directory names, system output, code, and text entered
at the command line
Document conventions and symbols
15