Creating context-sensitive help
SCOadmin includes a facility to connect context-sensitive help
to your management applications. SCOHelp uses a simple
mechanism to associate windows and window elements
(referred to hereafter as widgets) with text files.
The help system uses the following abstractions:
widget sum-
a unique symbolic tag generated by SCOhelp that is used to
associate help with a window or widget. (This sum is
based on the full widget name, which can be quite long
and identifies its location in the widget tree)
widget tree-
the hierarchical arrangement of widget sums of a SCOadmin manager
hook file-
a database file that associates widget sums with text files
help node-
a help topic file associated with one or more widget sums
help topic-
a directory that contains all the help files for a manager
To create context-sensitive help:
-
Dump the widget sums.
-
Create a help topic and help files.
-
Create a hook file for the topic.
-
Add the help topic to the system.
-
Test the help topic.
NOTE:
The procedures described here explain how to connect
HTML files to manager windows and window elements.
SCOHelp displayes these files when the <F1>
key is pressed, a Help button is activated,
or the Help menu is used.
© 2004 The SCO Group, Inc. All rights reserved.
UnixWare 7 Release 7.1.4 - 27 April 2004