CatalystX::Usul::Model::Help - Provides data for help pages
Describes v0.17.$Rev: 1 $
package YourApp; use Catalyst qw(ConfigComponents...); __PACKAGE__->config( 'Model::Help' => { parent_classes => q(CatalystX::Usul::Model::Help) }, );
Provides context sensitive help. Help text comes from running Pod::Html on the controller source
Defined the following list of attributes
A non empty simple string which defaults to http://search.cpan.org/dist/. The uri prefix for a distributions online documentation
A required non empty simple string. The name of the application
Constructor sets attributes for the application name from the application config
$self->about_form;
Provides information about the application. Content is implemented in a template
$self->add_language_selector( $prefix, $name );
Adds a form containing a popup menu that allows the user to select from the list of supported languages. Called from "add_footer"
$self->company_form;
Provides information about the company. Content is implemented in a template
$self->documentation_form( $uri );
Adds a file type field to the form. Displays as an iframe containing the HTML document referenced by $uri
$uri
$self->feedback_form( @args );
Adds the fields and button data to the stash for the user feedback form
$self->feedback_send;
Sends an email to the site administrators
$self->footer_form;
Calls "stash_debug_info" and "add_language_selector"
$self->help_form( $module );
Extract the POD for a given controller and renders it as HTML
$self->modules_form;
Generates the data for a table that shows all the modules the application is using. Links allow the source code and the POD to be viewed
$self->overview;
Generate the data for an XML response to a Javascript XMLHttpRequest()
XMLHttpRequest()
$self->stash_debug_info( $prefix );
Stashes some useful information if debug is turned on
None
There are no known incompatibilities in this module
There are no known bugs in this module. Please report problems to the address below. Patches are welcome
Peter Flanigan, <Support at RoxSoft.co.uk>
<Support at RoxSoft.co.uk>
Copyright (c) 2014 Peter Flanigan. All rights reserved
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic
This program is distributed in the hope that it will be useful, but WITHOUT WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
To install CatalystX::Usul, copy and paste the appropriate command in to your terminal.
cpanm
cpanm CatalystX::Usul
CPAN shell
perl -MCPAN -e shell install CatalystX::Usul
For more information on module installation, please visit the detailed CPAN module installation guide.