1Padre::Help(3)        User Contributed Perl Documentation       Padre::Help(3)
2
3
4

NAME

6       Padre::Help - Padre Help Provider API
7

DESCRIPTION

9       The "Padre::Help" class provides a base class, default implementation
10       and API documentation for help provision support in Padre.
11
12       In order to setup a help system for a document type called "XYZ" one
13       has to do the following: Create a module called "Padre::Help::XYZ" that
14       subclasses the "Padre::Help" module and override 3 methods:
15       "help_init", "help_list" and "help_render".
16
17       In the class representing the Document ("Padre::Document::XYZ") one
18       should override the "get_help_provider" method and return an object of
19       the help provide module.  In our case it should contain
20
21               require Padre::Help::XYZ;
22               return Padre::Help::XYZ->new;
23
24       (TO DO: Maybe it should only return the name of the module)
25
26       The "help_init" method is called by the new method of "Padre::Help"
27       once for every document of "XYZ" kind. (TO DO: maybe it should be only
28       once for every document type, and not once for every document of that
29       type).
30
31       "help_list" should return a reference to an array holding the possible
32       strings the system can provide help for.
33
34       "help_render" is called by one of the keywords, it should return the
35       HTML to be displayed as help and another string which is the location
36       of the help. Usually a path to a file that will be used in the title of
37       the window.
38
39
40
41perl v5.28.1                      2011-08-16                    Padre::Help(3)