Copyright, Licenses and Formatting Conventions

For all copyright statements and license agreements see Copyright, Licenses and Disclaimers.

Formatting Conventions

The following tables detail formatting conventions used within this guide:

Table B.1. Formatting Conventions - Text

 StyleDescription Example
Cross-referenceCross-reference to external documents.See the Microsoft Manual of Style for Technical Publications.
GUI ItemUser interface items.Click Save.
Keyboard shortcutKeyboard shortcuts.Press Ctrl+A.
Mouse ButtonMouse buttons.Secondary-mouse button (usually the right-mouse button).
LinkLink to anchor-points within the current document and/or external sources.http://www.day.com
Code
Example of programming code.
if (weather == sunny) smile;
User InputExample of text, or commands, that you type.ls *.xml
<Variable User Input>Example of variable text - you type the actual value needed.
ls <cq-installation-dir>
[Optional Parameter]An optional parameter.
ls [<option>] [<filename>]
Computer OutputLogging and error messages.ls: cannot access error.log:

Table B.2. Formatting Conventions - Actions

 When you see this...It means do this...
Ctrl+AHold down the Ctrl key, then press the A key.
Right-clickPress the right-mouse button (or the left-mouse button if your mouse has been configured for left-handed use).
DragHold down the left mouse button while moving the item, then release the mouse button at the new location (or the right mouse button if your mouse has been configured for left-handed use).