Documentation Conventions

It is important that the conventions used in the documentation are understood.

Mouse conventions

These are the conventions related to using the mouse.

When you see this…	Do this…
Click *File - Login*	Click the *File* menu with the mouse, and then click the item *Login* in the menu.
Click OK	Click this button on a toolbar to initiate On Key functionality.
Enable a check box	Click the check box to place a tick inside the box.
Disable a check box	Click the check box to remove the tick.

These are the conventions related to your keyboard actions.

When you see this...	Do this...
Press [Enter]	Press the Enter key on the keyboard.
Press [Ctrl+L]	Press the Control and L keys at the same time.

These are the text formatting conventions.

When you see this...	It indicates...
Bold type	A button with text, for example OK or Yes, or emphasis of the words in bold type.
Italic type	A field name. For example, Priority or Description.

These terms are used throughout the documentation.

This term…	Means…
Browse window	The window that displays a list of records for an item.
Child	An item in a hierarchical tree structure that is linked to another item at a higher level in the structure.
Configure	Setting up details in a database.
Edit window	The window that opens to add or edit an item. An edit window is opened by double-clicking on a menu option, double-clicking a record in a browse window, or selecting the edit button on specific windows.
Item	A unique object in a database.
Parent	An item in a hierarchical tree structure to which other items are linked at a lower level in the structure.
Populate	A database is populated when records are added to it. A screen is populated when information from a database is used to fill in details on the screen, or when data is typed in.
Screen	The screen in which an instance of the On Key system is available.
Select	Highlight an item using a single click.
Window	Any window that can be minimised, maximised, or closed when it is open in the working area.