Text
Text that you will actually type when following our instructions appears in quotation marks (“ ”). This indicates that you are to type the quoted word or phrase exactly as it appears, spaces and all. For example, if we were to ask you to type something like “setup.exe” at the command prompt, you would see it in the quotation marks.
Italicized text indicates that you should supply the actual information for the italicized word or words that are merely a description of what you should type. For example, if we ask you to enter, IPaddress, you will actually type in a set of numbers that are the IP address (such as 127.0.0.1).
When the titles of file names, dialog boxes (or windows), and menus and menu items appear in the text, these are bold. If the text surrounding the title is also blue, then the title will match that text color. For example, a step that directs you to choose the Click Assignment menu item from the Configure menu will have this kind of text formatting.
Mouse Instructions
Mouse actions such as clicking, double-clicking, right-clicking, and selecting appear in bold for easy identification of actions in procedures. Clicking involves depression of the mouse button or buttons, once or twice. Selecting is associated with choosing an item from a menu or a list box as well as with clicking and holding the mouse button while dragging the mouse over something on the screen so that there is a color change.
Buttons
To denote a screen button, this documentation uses bold brackets surrounding the label of the button. For example, [Help] refers to a button on the screen with the name “help.” It is assumed that you are sufficiently familiar with the functionality of [OK] and [Cancel] buttons. They are not included in the descriptions about windows because they always function the same way as in other applications.
Keystrokes
Keys on the keyboard that are supposed to be pressed simultaneously to invoke a certain action are documented with a plus sign (e.g. Shift+F4) separating the two key names. Keystrokes that you should press in succession are separated by a comma (e.g. Shift, F4).
Alerts, Notes, and Tips
In the help, you will notice three kinds of offset sections of text with additional information. These often interrupt steps in a procedure with important or relevant information. We recommend you do not skip the first 2 kinds of sections in your reading. The third, power usage, will always contain information you don't necessarily need.
Alerts are marked with an exclamation point (!). These sections give important information that you need to know to use the product.
NOTES offer information that you might need under special circumstances. To determine whether you fall under these special circumstances, you will need to read the Notes.
TIPs give you information about shortcuts. These shortcuts are peripheral functioning of the product that do not change the original functionality outlined in the procedures. You DO NOT have to employ these methods to use the product.
It is our goal to provide complete, clear, and accessible help documentation. We welcome your comments about the quality of our Help Documents. Please e-mail your comments to us at documentation@ctc-core.com.