|
1 | 1 | # XscHelp
|
2 |
| -Help ToolKit for Motif |
| 2 | +Help ToolKit for OSF/Motif and the X-Window System |
| 3 | + |
| 4 | +## Help ToolKit Overview |
| 5 | + |
| 6 | +The Help ToolKit for Motif allows developers to easily add and modify various |
| 7 | +types of on-line context-sensitive help to Motif applications. Using a small |
| 8 | +set of functions to install the library, every widget and gadget in a Motif |
| 9 | +application seemingly inherits new resources allowing help to be configured |
| 10 | +and changed via X resource files. |
| 11 | + |
| 12 | +The ToolKit supports three core help types: **Tips**, **Cues**, and **Hints**. All of |
| 13 | +these help types can be assigned to any widget and any Motif-based gadget. |
| 14 | + |
| 15 | +**Tips** are brief notes that appear in small pop-up windows over or near a |
| 16 | +screen object when the mouse cursor briefly rests over the object. Tips |
| 17 | +are commonly seen with icon buttons and where originally popularized in |
| 18 | +Windows 95 applications. |
| 19 | + |
| 20 | +**Cues** are displayed in small pop-up windows that normally float above the |
| 21 | +shell widget that contains the keyboard focus. The content of the Cue is |
| 22 | +based on the widget or gadget that currently has the keyboard focus. |
| 23 | + |
| 24 | +**Hints** are textual messages that appear in a fixed location on a window when |
| 25 | +the mouse cursor moves over a given widget or gadget contained in that window. |
| 26 | + |
| 27 | +In addition, the ToolKit provides an API that allows a developer to plug-in |
| 28 | +virtually any on-line help system, such as the Help system provided through |
| 29 | +CDE. In fact, a sample CDE Help system plug-in is provided with the |
| 30 | +registered version of the ToolKit. The Help ToolKit also provides a rich |
| 31 | +API allowing help to be controlled and manipulated programmatically. |
| 32 | + |
| 33 | +## History |
| 34 | + |
| 35 | +The Help Toolkit was written in the late 1990s. It was originally licensed as |
| 36 | +shareware controlled by my company Software Components, Inc. -- that's why it is |
| 37 | +called **Xsc**Help. The company is now defunct and the software has been dormant for well over a decade. I recently noticed it on an old backup, so I am now making |
| 38 | +it available to the general community for whatever purpose under the MIT license. |
| 39 | + |
| 40 | +There were a couple of articles published about XscHelp in The X Advisor which |
| 41 | +was an early webzine for X Window System development. I do not have copies and, |
| 42 | +amazingly, all the links are dead. I would be happy if they were rediscovered |
| 43 | +somewhere. |
| 44 | +- "Providing User Feedback with Quick Help -- Part 1: Quick Help Described," *The X Advisor*, Feburary 1996 |
| 45 | +- "Providing User Feedback with Quick Help -- Part 2: Quick Help Implementation Details," *The X Advisor*, March 1996 |
| 46 | + |
| 47 | +## Caveats |
| 48 | + |
| 49 | +I have not built this software in over a decade and I do not currently have |
| 50 | +an environment to do so. |
| 51 | + |
| 52 | +I have a User's Guide in postscript and PDF which are now also licensed under |
| 53 | +the MIT License regardless of what the printed document states. |
| 54 | + |
| 55 | +## License |
| 56 | + |
| 57 | +Copywrite (c) Robert S. Werner (a.k.a Akiva Werner). All rights reserved. |
| 58 | + |
| 59 | +Licensed under the [MIT license](LICENSE). |
0 commit comments