Help Conventions
In this documentation, reader alert and style conventions are used to bring attention to specific information or help you identify information.
Reader Alert Conventions
Reader alerts are used throughout this documentation to notify readers of both supplementary and essential information. The following table explains the meaning of each alert.
Table 1: Reader Alert Conventions
Image | Alert Name | Description |
Tip | Tips are used to indicate helpful information that could assist you in better using the desired function or feature. | |
Note | Notes are used to draw attention to pieces of information that should stand out. | |
Caution | Cautions indicate that this information is critical to the success of the desired feature. | |
Important Note | Important notes are used for information that is essential for users to read. | |
Security | Security alerts identify security issues. | |
Task | The Task graphic indicates that procedural instructions follow. | |
Applies To |
The following contents only apply to certain users based on their subscription or purchased add-ons. | |
Best Practices |
Best Practices alerts instruct you on the best way to accomplish a task. | |
Examples |
Examples provide real life scenarios to help users understand how the feature may be used in the real world. | |
Video | The Video icon indicates that a video is available to demonstrate the feature or functionality. |
Style Conventions
The following style conventions are used throughout this documentation.
Table 2: Style Conventions
Style | Example | Description |
User Interface Elements | On the File menu, click Print. | User interface elements appear in bold when referenced in tasks. |
Variables | [[Description]] | Variables appear in italics. |
User Inputted Text | Enter Brass Railroad Key as the title. | Text that is to be entered as a literal value is displayed in a monospace typeface, in bold, and in blue. |
File Name and Directory Paths | Backups are located in the C:\MyDocuments\Backups directory. | File names and directory paths are presented in a monospace typeface. |
Functions | Manage Item Templates allows you to edit and create item templates. | Functions are presented in bold. |
Screen Output | If you type an incorrect value, the message The system cannot find the path specified is displayed. | Screen output is displayed in a monospace typeface, and in blue. |