GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PADRE::HELP (3)

.ds Aq ’

NAME

Padre::Help - Padre Help Provider API

CONTENTS

DESCRIPTION

The Padre::Help 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::Help::XYZ that subclasses the Padre::Help module and override 3 methods: help_init, help_list and help_render.

In the class representing the Document (Padre::Document::XYZ) 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::Help::XYZ;
        return Padre::Help::XYZ->new;



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

The help_init method is called by the new method of Padre::Help once for every document of XYZ kind. (TO DO: 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.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PADRE::HELP (3) 2013-11-09

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.