This user guide contains a number of typographic and writing conventions as well as visual elements that will help you to better understand information and to perform tasks.
Terms and writing conventions
The following writing conventions are used in this user guide:
| Writing convention | Description |
|---|---|
| <version> | Indicates that you must replace the text enclosed in angled brackets with information specific to your installation or environment. For example, in the registry path HKEY_CURRENT_USER\Software\Motive\M-Files\<version>\Client, you would replace <version> with the version number of your specific M-Files installation. |
| The > symbol indicates that you need to select an item from a menu. For example, indicates that you need to open the menu bar and select the Applications item from the Settings menu. | |
| Before you begin | The Before you begin section tells you what you need to do before you can perform a given task. Complete the tasks listed in the Before you begin section before you move on to the task at hand. |
| Steps | The Steps section contains an ordered list of steps that need to be performed in consecutive order to complete the given task. |
| Optional | Optional indicates that a step in a task is optional and up to the users to decide whether or not they need to complete the step. |
| Results | The Results section describes the outcome of a successfully completed task. If you have completed the task correctly as instructed, you should experience the same outcome as described in the Results section. |
For a list of terms commonly referenced in this user guide, see M-Files Terminology.
Visual elements
The following visual elements are used in this user guide:
| Visual element | Name | Description |
|---|---|---|
 |
Note | The Note icon highlights important information related to the topic at hand. |
 |
Tip | The Tip icon highlights alternative procedures and additional information related to the topic being discussed. |
  |
Video | The Video icon indicates that the chapter contains an instructional video related to the topic being discussed. |
 |
Information | The Information icon highlights important information related to a specific step in a task. This information is always listed under the related step. |
 |
Step example | The Step example icon highlights an example of how a given step should be completed. This information is always listed under the related step. |
 |
Step result | The Step result icon highlights a description of the expected results for successfully completing |
Typographic conventions
The following typographic conventions are used in this user guide:
| Typographic convention | Description |
|---|---|
| Bold | In task steps, bolded text indicates user interface elements that the user
can interact with, such as buttons and menu items. Example: Click OK to continue. |
| Italics | In task steps, italics indicates user interface elements that are not
directly interactable, such as dialog names and labels and dialog section
titles. Example: The Object Type Properties dialog is opened. |
| Blue text | Blue underlined text indicates hyperlinks. There are mainly three types of
hyperlinks in this user guide:
|
|
Task heading |
A heading with a blue background indicates a section that outlines procedural instructions. Such a section answers the question "How do I..." and it contains an ordered list of steps to be taken for completing a specific task. |
|
Main heading |
A heading with a grey background indicates a section containing information on a specific topic. In contrast to procedural instructions above, these sections answer the question "What is..." and they contain background information on a single subject. |
|
Subtopic heading |
These headings are subheadings of a larger chapter and they cover a related subtopic of the parent topic. |
|
Section heading |
These headings represent a subordinate heading for a subheading for further dividing the topic at hand into smaller sections. |