Naming Conventions#
The following conventions are applied throughout the document:
Info
Helpful hints to assist in particular situations.
Note
A note with important information.
Warning
A warning or a word of caution.
Tip
A best practice or a recommendation.
These call-outs carry important information can be very useful. However, in some situations, other smaller icons are visible and should be regarded as a visual identifier that a larger information call-out of the same type can be found below. These icons include:
| Convention | Callout |
|---|---|
| Info | |
| Warning | |
| Note | |
| Tip |
Table: Snippet visual conventions
Other visual indicators are used in the documentation to indicate information on specific actions or operations found in the MES GUI:
| Convention | Description |
|---|---|
| Described functionality is associated with the stated security feature | |
| Icon that symbolizes an edit action | |
| Icon that symbolizes an add action | |
| Icon that symbolizes a remove action | |
| Icon that symbolizes a move up action | |
| Icon that symbolizes a move down action | |
| Icon that symbolizes the use of a camera or scanner | |
| Icon that symbolizes the use of a keypad | |
| Icon that symbolizes a browser modal window view action | |
| Icon that symbolizes a download action | |
| Icon that symbolizes a copy action | |
| Icon symbolizing PDF availability |
Table: Visual conventions
Functionality Name#
For every described functionality, the specific security feature associated to it is listed below the name. Example:
FeatureGroup.Feature
Deprecated Features#
When a feature page is set to be deprecated and removed in a future version, it will display the following indication below the title:
This feature is marked as deprecated and will be removed in a future version.