Padre::Help - Padre Help Provider API

Padre documentation Contained in the Padre distribution.

Index

Code Index:

NAME

Top

Padre::Help - Padre Help Provider API

DESCRIPTION

Top

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.

Padre documentation Contained in the Padre distribution. 
package Padre::Help;

use 5.008;
use strict;
use warnings;

our $VERSION = '0.86';

# Constructor.
# No need to override this, just override help_init
sub new {
	my $self = bless {}, $_[0];

	# Initialize
	$self->help_init;

	return $self;
}

# Initialize help
sub help_init {
	warn "help_init, You need to override this to do something useful with help search";
}

# Renders the help topic content into XHTML
sub help_render {
	warn "help_render, You need to override this to do something useful with help search";
}

# Returns the help topic list
sub help_list {
	warn "help_list, You need to override this to do something useful with help search";
}

1;

__END__



# Copyright 2008-2011 The Padre development team as listed in Padre.pm.
# LICENSE
# This program is free software; you can redistribute it and/or
# modify it under the same terms as Perl 5 itself.