This section provides guidance on the conventions that will be used in the documentation to indicate specific operations or to give a particular meaning to the written text.


Typographic Conventions

 

The text can take on special meaning in accordance with the conventions listed below:


 

Italics Text 

Italics text is used to indicate the specific terminology, the names of files and folders and extensions, the section titles in cross-references, records, property names

 

Bold Text

The bold text shows the text of commands, menus, window titles, and other elements of the graphical interface; also highlights concepts of particular importance.

 

<angle Corner with italic text>

 

When in the description of a syntax is shown a definition between angle brackets means that it must be replaced to the specific text deduced from the description reported: for example, 
/ P<path Project avviare>
indicates that you must enter / P followed by the path of the project to be undertaken, omitting the brackets:
/ PC: \ Program Files \ Crickets Automation \ X Vision 8.0 \ Projects \ MyProject1

 

[Brackets]


 

Elements in square brackets are optional within an expression. For example, the syntax:
/ P<path Project>[/ E]
indicates that the / E parameter can be omitted depending on the functionality you want to achieve. 

This Convention shall not apply to the names of the sections of the initialization file 

 

pipe character  ("|")


 

The pipe character, graphically represented by a vertical bar separates two alternative values ​​or assignments. For example:
WindowState = 0 | 1 | 6 | -1

means that the item WindowState can take only one of the following values: 0; 1; 6; ‑1


 

Note:

The words Note flag indications for specific cases, limitations of use, tips and additional information.


 

Attention!

 

Important!

 

The sections marked "Caution" or "Important" and enclosed in horizontal lines highlight concepts and information of particular interest, neglecting which you may incur data loss or malfunction of the system.


Conventions for keyboard and mouse

 

Uses the following conventions for drawing operations through keyboard and mouse:


<KEYSTROKE1> + < KEYSTROKE 2>:

 A plus sign (+) between key names indicates that the keys must be pressed simultaneously. For example, press Alt + F4 means to press the Alt key and press the F4 key and then release both.


MOUSE BUTTONS

The definition of right and left mouse buttons refers to the standard configuration of the operating system, which provides that the left button is the main button is used for selecting, dragging, resizing, and the right button is the key auxiliary, commonly used for displaying the context menu. Account should be taken of this definition if you are using a mouse configured for operation buttons reversed (use with the left hand).


DO "CLICK" 

Means to press and then release the mouse button down at a menu item or object. Unless otherwise specified, the key is to use the left (main). The click with the right button causes the display of context menus, where provided.


SELECT or CHOOSE

Expression equivalent to "Click" on the specified object. If the object in question is the element of a list, the selection can be changed by using the arrow keys.


DO "DOUBLE CLICK"

Means press twice in rapid succession the left mouse button.


DRAG

Means press the left mouse button at the specified object and hold down the button, move the mouse pointer to the desired position, then release the button.