This tool is a set of one custom tag, CSS and Javascript files, which makes adding online help in a ColdFusion application as easy as just typing text. Any HTML object can be "Help enabled" by just adding an attribute with an identificator to the tag. Then an online help popup can be added anywhere in the page using a simple custom tag. The text inside the custom tag can contain any HTML codes.
When the mouse passes over an help enabled element, the cursor chages for the help cursor ( ). The user just has to right click on the element to get an online pop up containing the information.
The popup is not a new window, but an absolute positioned table in the page, then its display is immediate.
The online help system may be implemented in two ways:
Static help: This is the type described above. The help is always available, the user cannot turn it on or off. Note that help enabled elements can still use an onclick event, CF_onlineHelp preserve previous events defined on them.
User controlled type: In this mode, you provide some control device, like an image or a button, to allow the user to turn on or off the help system. When it is off, the cursor is not changed when the mouse passes over help enabled elements, and right clicking on them produces no action. With this type of help system, the user has a choice of two modes of operation:
Standard:This is the mode decribed above. It is intended to be used in normal operation.
Touring mode: In this mode, the popup opens immediately when the mouse enters the help enabled element, and closes when the the mouse leaves it. This mode is especially intended for a first glance at the application. |