The help centre uses the following interface features and conventions.
You might also find it helpful to look at the conventions and symbols used in to show various status settings and options.
Feature | Description |
---|---|
Navigation menus. Use the help centre menus to navigate directly to articles of interest under any of the four categories. By browsing the menus you can get a clear idea of the overall scope of the material in the help centre. | |
Side menu (on sub-pages only). Use the side menu to navigate to related articles within the current section of the help centre. The name of the currently displayed article is shown in green text. Children of the current article are indented. Click the name of the parent article to go up a level in the menu. | |
Articles and sub-sections. As you browse the help centre, you'll see that articles are listed first in any section, followed by sub-sections (shown with the arrow symbol
|
|
Breadcrumbs are displayed above each section and article. You can navigate to a parent section by clicking on its name. |
|
Search box. For help on a specific term or phrase, type it into the Search box and press Enter. If you need to find an exact phrase, such as "staff settings", enclose the phrase in double quotes. That will find each occurrence of the required phrase ("staff settings") rather than all occurrences of the individual words "staff" and "settings". |
|
Use the Print Page button to print the current help article. | |
After a successful search for a keyword, all matching text is highlighted in yellow. Use the Remove search highlight button to clear the highlights (or just refresh the browser window). | |
Use the Expand/Collapse all button to show (or hide) all the hidden text in the current article. See Drop-down text below. | |
|
Drop-down text. Some articles include drop-down areas that contain more detailed information. The detail is hidden until you open the drop-down area by clicking the |
Convention | Description |
---|---|
Data field name | In the help centre, the names of menu items, buttons and data fields are shown in bold text. |
Required field name |
In the help centre, the names of mandatory (required) data fields are shown in bold red text. In the interface, these mandatory fields are flagged with an asterisk (*). |
Important |
Information shown like this is important for your understanding and effective use of . |
Tip |
Information shown like this may help you use more easily. |
Note |
Information shown like this may provide more context or detail. |
option > option |
To reduce the number of steps in some instructions in this help centre , the ">" symbol is used as shorthand for selecting a sequence of options. For example, the instruction: In the Business menu, select Invoices > + Create New Invoice > + Progress Invoice. means that after selecting Invoices in the Business menu, you should then select + Progress Invoice (from the + Create New Invoice drop-down menu, in this example). |
Checkbox terminology. A checkbox is either selected |
|
|
Toggle switch terminology. A toggle switch is used in a similar way to a checkbox to select an optional setting. A toggle switch is either toggled ON |