Conventions

To enhance user understanding, certain formatting conventions are used throughout this document. The formatting conventions used are listed below.

User Guide Conventions

Element

Notation

Description

Output

General emphasis

In the Program workspace.

To make certain text elements stand out, or to highlight.

Text in Bold

Graphical User Interface (GUI) items

Select the Function button.

Any reference to items found on screen in the GUI (for example, command buttons, icon names and field names).

Text in Bold

Graphical User Interface (GUI) Path >

Generally, on the top of the GUI.

Navigation aid which keeps track of the location in the GUI.

For example: Controller > Program > Edit

User input

Enter a Description for the program.

Any text input by the user.

Text in Bold

File names

Enter a File Name for the export.

Files either exported from, or imported into the system.

Text in Bold Italic

Variable and parameter names

Enter a Name for the export.

Variable and parameter names (not values).

Text in Italic

Variable and parameter values

Enter a VALUE for the export.

Variable and parameter values.

Text in BOLD CAPS

System output

Client.Domain.Models.ExportImportConfiguration

Any text output by the system.

Text in Monospace

External links

Links to external sites that have information connected to the document or subject content. These could include:

  • Technical Product Data

  • Dimensional Drawings

  • Accessories

  • Product Specific Information

Selectable text to external sites

Internal documentation links

  • Relevant Information - links to information which is directly related to the current topic and needs to be considered for certain configurations that are made.

  • In this Section - links to all the topics within the section, which can be useful when understanding a feature, or configuration.

If available, these links will be presented below the text.

Selectable text to internal content