Contents Up Previous Next

Help

A 'help instance' is created to manage on-line help associated with one or more files. wxCLIPS supports both Windows Help under MS Windows, and wxHelp under all platforms.

Windows Help (.hlp) files may be created using a number of tools, such as Tex2RTF. wxHelp (.xlp) files can be created with a text editor or a tool such as Tex2RTF.

wxHelp is very limited in its capabilities and should only be used on platforms with no native help. Consider using HTML files instead (although you cannot currently access HTML files from your application).

help-create
help-delete
help-display-block
help-display-contents
help-display-section
help-keyword-search
help-load-file


help-create

long ( help-create optional long native = 1)

Creates a help instance. If native is 1, the native help system will be invoked (such as WinHelp under MS Windows). If 0, wxHelp will be invoked.


help-delete

long ( help-delete long id)

Deletes the help instance.


help-display-block

long ( help-display-block long id long blockId)

Displays the help file at the given block identifier (system dependent).


help-display-contents

long ( help-display-contents long id string filename)

Displays the contents of the help file currently loaded.


help-display-section

long ( help-display-section long id long section)

Displays the help file at the given section (system dependent).


help-keyword-search

long ( help-keyword-search long id string keyword)

Positions the help file at a section matching the given string.


help-load-file

long ( help-load-file long id string filename)

Attempts to load the given file into the help instance. Use a function like help-display-contents to display the file.