Conventions used in this documentation

This documentation uses standardized formatting and terminology to make it easier for all users to understand.

Text conventions

This documentation uses special text formatting to help you quickly identify certain items:
  • Titles, labels, new terms, and messages are indicated using italic text (for example, Object Properties).
  • File names, screen text, and text you must enter are indicated using monospace text (for example, D:\Setup.exe ).
  • Buttons, menu options, and keyboard keys are indicated using a bold typeface (for example, File menu).
In addition, this documentation segregates some text into Tip, Note, and Caution boxes:
  • Tips provide useful information to save development time or to improve the project performance.
  • Notes provide extra information that may make it easier to understand the nearby text, usually the text just before the note.
  • Cautions provide information necessary to prevent errors that can cause problems when running the project, and may result in damage.

Mouse and selection conventions

Because most PCs used for project development run a version of Microsoft Windows with a mouse, this documentation assumes you are using a mouse. Generally, a PC mouse is configured for right-handed use, so that the left mouse button is the primary button and the right mouse button is the secondary button.

This documentation uses the following mouse and selection conventions:
  • Click and Select both mean to click once on an item with the left mouse button. In general, you click buttons and you select from menus and lists.
  • Double-click means to quickly click twice on an item with the left mouse button.
  • Right-click means to click once on an item with the right mouse button.
  • Select also means you should use your pointing device to highlight or specify an item on the computer screen. Selecting an item with a touchscreen is usually the same as selecting with a mouse, except that you use your finger to touch (select) a screen object or section. To select items with your keyboard, you typically use the Tab key to move around options, the Enter key to open menus, and the Alt key with a letter key to select an object that has an underlined letter.
  • Drag means to press down the appropriate mouse button and move the mouse before releasing the button. Usually an outline of the item will move with the mouse cursor.

Windows conventions

This documentation uses the following Windows conventions:
  • dialoges (or dialogs) are windows that allow you to configure settings and enter information.
  • Text boxes are areas in dialogs where you can type text.
  • Radio buttons are white circles in which a black dot appears or disappears when you click on the button. Typically, the dot indicates the option or function is enabled (selected). No dot indicates the option or function is disabled (not selected).
  • Check boxes are white squares in which a check () appears or disappears when you click on it with the cursor. Typically, a check indicates the option or function is enabled (selected). No check indicates the option or function is disabled (not selected).
  • Buttons are icons in boxes appear "pressed" when you click on them.
  • Lists are panes (white boxes) in windows or dialogs containing two or more selectable options.
  • Combo boxes have arrows that, when clicked, show part or all of an otherwise concealed list.
  • Dockable windows are windows that you can drag to an edge of the interface and merge with that edge.