cwHHGlobal extension template

Top 

The cwHHGlobal extension template is a requirement for any application that will utilize Clarion's HTML Help support. This extension simply includes the necessary equates and Classes needed to compile the application and defines the applications default help file.

Requirements

This global extension template has no template requirements.

Populating the Template

1.

From the Application Tree, select the Global Extensions tab.

2.

Press the INSERT button and select the cwHHGlobal extension.

Note: Depending on the Application Template your application uses (Clarion or ABC) the cwHHGlobal extension will be available beneath the Class cwHH – HTML Help for Clarion or Class cwHHABC – HTML Help for Clarion.

Template Prompts

The cwHHGlobal template extension provides the following prompts:

Default Help File Name

Specify the name of the application's compiled help (.chm) file. The filename should not be enclosed in quotes. A variable name can be used, but you must prepend an exclamation point to the variable name (i.e., !HelpFileName)

Append to Help Ids

Check this box to indicate that existing help IDs defined in the application will have a extension appended to them. This is useful when converting applications that use standard help ids to the HTML help standard.

This check box also makes it possible to have a WinHelp and HTML Help project maintained by the same application. The HTML Help template will strip out the leading tilde (~) from a WinHelp ID.

There is also a Utility template that will generate all HTML Help Ids to an output text file. See: ListHLPIds Utility Template.

Allow STD:Help on buttons to call HTML Help

Check this box if you wish to redirect the standard call for all buttons that use the STD:Help STD ID from a WinHelp (.HLP) file to the HTML help file named by the template. Clear this box if you need to have a dual-help application.

Allow STD:HelpIndex to call HTML Help Index

Check this box if you wish to redirect the standard call on any menu item or button that use the STD:HelpIndex STD ID from a WinHelp (.HLP) file to the Index of the HTML help file named by the template.

Allow STD:HelpSearch on buttons to call HTML Help Search

Check this box if you wish to redirect the standard call on any menu item or button that uses the STD:HelpSearch STD ID from a WinHelp (.HLP) file to the Search tab of the HTML help file named by the template.

Allow STD:HelponHelp on buttons to call HTML Help on…

Check this box if you wish to redirect the standard call on any menu item or button that uses the STD:HelponHelp STD ID from a WinHelp (.HLP) file to the Help on… section of the HTML help file named by the template.

Alternate 'TRAP' Key

Ordinarily the F12 (the trap key) or the F1 key initiates the call to an HTML help file. The trap key can be changed by entering the equate for the new keystroke to initiate the call to the help file. This allows developers who use the F12 for other reasons can continue to do so. You can also override this global trap key on the procedure level.