The documentation uses the following conventions:
The boldface font is used when referring to:
Screen elements
Dialog box elements
Dialog box titles
Command buttons
Menus and menu items
Toolbars
Toolbar icons
Text that you must type
Some examples:
From the left side bar, click All Projects.
Expand the Tree View.
From Sort By, choose Modified Date.
When referring to menus and menu items inside procedures and other topics, the documentation directs you to a menu in this fashion:
Menu | Submenu or Menu Item | Menu Item
Italicized text is primarily used for emphasis. For example, "If the probe hits an obstruction, it will not automatically stop".
Italicized text may also be used for book or manual titles and arguments in programming.
Uppercase text is generally used when referring to:
Acronyms (such as VDAFS, DMIS)
Time (such as 9 A.M. and 4 P.M.)
Device names (such as LPT1, or COMM PORT 2)
In those instances where elements of computer programming are displayed, the following items also use uppercase:
Control classes
Data formats
Environment variables
Handles
Hooks
Indexes
Macros
Statements
Structures
System Commands
Values
Underline is used for emphasis when appropriate, but usually emphasis uses italicized text.
Hyperlinks are also underlined.
Ordered lists of numbers or letters show a series of steps in instructions and procedures and other sequential lists. Ordered lists of letters often identify elements in diagrams and images.
For example, here's a sample ordered list:
Click All Products.
Position your mouse pointer over a product.
Click the execute button.
Throughout the documentation, you'll find special boxes that offset the documentation. Here is what they mean:
This indicates a note.
This indicates an important note.
This indicates a hint.
This indicates an example.
This indicates a caution. Failure to follow a caution may result in data loss or hardware damage.
This indicates a warning. Failure to follow a warning may result in bodily harm.
❯Contact the Documentation Team
Inspect 5.1
Copyright © 2022 Hexagon Manufacturing Intelligence – Metrology Software, Inc.
Help System last generated on 10 February 2022