|
In some parts of the documentation, special instructions may be given that include keyboard keys to press, mouse buttons to click, menu items to select, data fields to fill in, etc. Examples include installation instructions, instructions on starting online help, or a description of a specific development environment.
Spatial uses the following conventions in these cases:
|
|
|
<Shift>
|
Keyboard keys to press are in a
Sans Serif font, enclosed within angle brackets. Key names are those names or abbreviations found on standard English computer keyboards and are in mixed case.
|
|
|
<Left Mouse>
|
Mouse buttons to click are in a
Sans Serif font, enclosed within angle brackets. The mouse buttons are:
<Left Mouse><Middle Mouse>, and
<Right Mouse>, as found on a right-handed 3-button mouse.
|
|
|
<Ctrl+Y>
|
Key
combinations (or key and mouse click combinations) are joined with a plus sign. This indicates the keys should be pressed simultaneously. The entire key combination is enclosed within angle brackets. The individual key names are not enclosed within angle brackets, unless necessary in order to distinguish them.
|
|
|
<Ctrl+X> <E>
|
Key
sequences are joined with a space separator. This indicates the individual keys (or key combinations) should be pressed in sequence. Individual key names (or key combinations) are enclosed within angle brackets. For example,
<Ctrl+X> <E> means to press the key combination
<Ctrl+X> followed by the single key
<E>.
|
|
|
Preprocessor
|
Names of application menus, "tabs," data fields, radio buttons, etc. are in a
Sans Serif font.
|
|
|
Build | Settings
|
Multi-level menu selections are shown in a
Sans Serif font, with the levels separated by a vertical bar. For example, the menu description
Build | Settings means to select the
Build menu, then select the
Settings submenu.
|