/ 
Padre-0.53
River stage two • 56 direct dependents • 56 total dependents
/ Padre::HelpProvider

NAME

Padre::HelpProvider - Padre Help Provider API

DESCRIPTION

The Padre::HelpProvider class provides a base class, default implementation and API documentation for help provision support in Padre.

In order to setup a help system for a document type called XYZ one has to do the following: Create a module called Padre::HelpProvider::XYZ that subclasses the Padre::HelpProvider module and override 3 methods: help_init, help_list and help_render.

In the class representing the Document (Padre::Document::XYX) one should override the get_help_provider method and return an object of the help provide module. In our case it should contain

require Padre::HelpProvider::XYZ;
return Padre::HelpProvider::XYZ->new;

(TODO: Maybe it should only return the name of the module)

The help_init method is called by the new method of Padre::HelpProvider once for every document of XYZ kind. (TODO: maybe it should be only once for every document type, and not once for every document of that type).

help_list should return a reference to an array holding the possible strings the system can provide help for.

help_render is called by one of the keywords, it should return the HTML to be displayed as help and another string which is the location of the help. Usually a path to a file that will be used in the title of the window.