GPE simple help

GPE simple help — Call external help browser.

Synopsis




gboolean            gpe_show_help                       (const char *appname,
                                                         const char *topic);
char*               gpe_check_for_help                  (const char *appname);

Description

Simple interface to provide a call for an external application to display help information. Currently this is fixed to a list of help browsers (gpe-helpviewer, gpe-mini-browser, dillo, minimo). The help system is configured in /etc/gpe/gpe-help.conf. For an example how to provide help for applications check out gpe-edit.

Details

gpe_show_help ()

gboolean            gpe_show_help                       (const char *appname,
                                                         const char *topic);

This function provides a generic interface for displaying full text online help. It is intended to be independent from file format and location. Return value is FALSE if help is found and displayed, TRUE if an error occurs.

appname :

Name of the application to show help about.

topic :

String describing help topic.

Returns :

TRUE if an error occured, FALSE otherwise.

gpe_check_for_help ()

char*               gpe_check_for_help                  (const char *appname);

Checks for the existance of any installed help. Returns NULL if no help, or if the help for that particular application is not installed. If the help is found it returns the filename to that help.

appname :

Name of the application.

Returns :

Filename if help is installed.