hlp_cal_txt

Initiates the DataView-internal help trigger and executes the program functions in the help trigger stack.


Parameters:

[parameter]

parameter
Any parameter, e.g. starting page for a HTML information system. The parameter can be evaluated by program functions installed at the DataView-internal help trigger.


Usage as:

On_Select userexit in each menu/button-area or On_Event userexit in each state of the user interface.


Explanation:

An application-specific program function for calling the online help must be created using functions of the DataView programming interface and then added to the function stack at the help trigger via hlp_fnc_url (-> cf. API, module hlp). The standard userexit hlp_cal_txt initiates the help trigger and executes the program functions in the stack. If no application-specific program function is installed, hlp_cal_txt calls the DataView information system in the HTML browser (-> cf. example).

An application-specific program function in the help-trigger can for instance evaluate states of the application (state the user interface, active object, variables, etc....) to create corresponding file names or URL-addresses for a context sensitive help system. With the function hlp_set_url or hlp_set_msh (-> cf. API, module hlp) the URL-address can be directly passed from DataView to an HTML browser (Microsoft Explorer, Netscape Navigator) or to the MS-HTML-API.

In multi-level applications (several program functions in the function stack required) URLs can be formed with individual rules. After checking the object membership and output of a valid URL address the execution of the function stack is cancelled. With hlp_cal_txt the interactive help call can be used with the same button/selection/event independent of the application.

Example: In DataView itself the online help is called as follows:

The program function installed in the help trigger stack for DataView creates a URL-address and passes it to the HTML standard browser of the system. This is done according to the following rules:

Invoked via [F1]:

Invoked via help button in the Info-toolbar:

The path is set by checking the client environment variable DATAVIEW_CHLP and points to the < hlp> directory. According to the shortcut of the system data language it will be automatically completed by a sub-directory, e.g. < GER> , < FRA> , < ENG> ....