About Help Format
Topics apply a standard format to aid navigation and distinguish between different types of information. You can Format Help in an alternate style if you require it to be more readable.
-
About Topics - The Speech Bubble icon is used to signify topics that provide introductory and conceptual information. About topics are the first item in each Help folder. In addition, key aspects of the software also have their own about topics.
-
Procedural Topics - The Map icon is used to signify topics that guide you through performing business tasks with the software.
-
Screen Topics - The Screen icon is used to signify topics that provide details about particular dialogs, schedules and messages. These topics provide information in addition to that available on-screen.
-
Notes - The Note icon is used to flag paragraphs that provide additional notes and tips. These provide related information and ways to save time on common tasks.
-
Warnings - The Warning icon is used to flag paragraphs that provide information that should not be ignored.
- New/Updated Help Contents
- Folders and topics that contain new/revised content are identified with an asterisk. Click the Contents tab to view these items. Open the folders marked with an asterisk to view the asterisked topics underneath.
- Links
- Linking text is indicated via underlining.
- Screen Shots
- The Help is designed to be used alongside the software; therefore, it has minimal screen shots. Where they are used, the following formatting applies:
- Full screen shots: Are provided in introductory sections for familiarisation with software layout. These are resized to 75% to save space and to differentiate from the software itself. You can click different areas of these images to jump to a topic relating to that part of the screen.
- Partial screen shots: Are provided to display a particular software function. These are resized to 75% to save space and to differentiate from the software itself. You cannot click these images.
- Screen Elements
- When the Help references a part of the software, whether it is an individual field, a tab, a dialog or the main window, the element name is displayed in bold.
- Menus
- When the Help references a menu, it provides a path in the following format: Menu Title | Sub Menu | Menu Item. For example, select File | New | Staff from the menu.
- Text to Enter
- Text that you intended to enter into the software is signified by single quotes. For example, enter 'Sanders' into the Surname field.
- Keys to Press
- Keys to be pressed are highlighted by bold uppercase text. Where you need to press two keys together they are joined with a hyphen. For example, press the RETURN key, or press the ALT-ENTER keys.
- Associated Topics