|
|
|
|
WIMOVAC Help SystemIn order to meet the criteria of accessibility and open documentation wimovac uses the Microsoft Help Compiler (version 3.10.504) to incorporate an on-line context sensitive hyper-help system containing segmented hyper graphics, equations, bitmapped images and scaleable Windows metafile images. The wimovac help file has been constructed using a word processor WFW (Microsoft Word for Windows v7.01) which is used to create rich text files (RTF) containing the textual information, inserted graphics and header/footer entries that allow hyper help functionality. The help compiler then builds this RTF into a help file format compatible with the help file manager (winhelp.exe) and display system built into Windows and related operating systems. The advantage of using a word processor and secondary compiler combination in this manner is that expert scientists may contribute to the content of the help file without the need for any specialist programming skills. Further the word processed help file may be used with little or no modification to form the basis of a printed manual or hardcopy documentation of the modelling system. The initial task in constructing the help file in wimovac was to gather information for the help topics; the second task was to develop a plan for the help system which included i). Defining the likely audience of the material. ii). Planning the content of the help system iii). Planning the structure of help topics iv). Determining the topic file structure and v). Designing the individual help topics. These processes are summarized diagramatically in Figure 14.
Figure 14. Workflow diagram for the construction of the online context sensitive help system contained within wimovacA hierarchical structure of help topics was chosen for its clarity, ease of navigation and because it reflects the internal structure of model modules in wimovac. Help topics were designed with a consistent font size, color and layout to improve visual consistency and ease of navigation. To each topic a list of key words was added. These keywords are used to access information quickly using the Windows help viewer search feature (Figure 15vii, viii) without having to navigate multiple hyperlinks. A number of word processor macros have been written to automate these construction processes and to ensure consistency of design throughout. The help file is available in wimovac at all times from the help menu on the master window and may also be accessed via the help buttons found on selected dialogs. The help file contains information about both the vegetation model algorithms and the general use/operation of the software.
Figure 15. The wimovac context sensitive online hyper-help system. (i) Contents button returns the user to the starting page of the help file. (ii) Search button provides keyword and topic search facilities within the help system and displays the search dialog. (iii) The print button allows help topics to be printed to any Windows supported printer. (iv) Segmented hyper graphic metafile and bitmap images used to illustrate the help file and clarify textual information. (v) Detailed equation listing of model algorithms. (vi) Underlined coloured text indicates a hyper-help topic on which further information is available. Double clicking on this jumps the displayed help topic to the requested item. (vii) Help search dialog with scrollable alphabetical list of all key words contained in the help system. (viii) Freeform user text entry box for customised searches. |
Send mail to humph@essex.ac.uk with questions or comments about this web site.
|
