GPE simple help

GPE simple help — Call external help browser.

Synopsis




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

Description

Simple interface to provide a call for an external application to display help information. Currently this is fixed to a list of HTML browsers (gpe-helpviewer, dillo, minimo).

Details

gpe_show_help ()

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

This function creates a filename and topic information from supplied parameters and calls an external application to display it. The filename is created from the 'book' parameter, the 'topic' parameter is passed as index for the help file. The resulting URL that is opened is constructed in this way: file://usr/share/doc/gpe/<book>.html#<topic>

book :String describing help book file.
topic :String describing help topic.
Returns :TRUE if an error occured, FALSE otherwise.