Conventions
Typographical conventions
UI control | User interface controls, commands, and keywords in body text. |
Blue-bold | Option in a menu. |
Input field | Input field where user input is expected. |
Underline | Link to another section of the guide. |
monospace | Snippets of code that the user must input or can use as a reference. |
<…> | Generic parameters that must be replaced by specific code or text. |
[…] | Generic parameters that are replaced by dynamic text. |
Notes and recommendations
Note: Designates a note or reference related to the surrounding text.
Remember: Designates a usage recommendation related to the surrounding text.
CAUTION: Designates a warning or alert related to the surrounding text. You should exercise caution to avoid an undesirable outcome.