Name
CatalystX::Usul::Model::Help - Provides data for help pages
Version
Describes v0.16.$Rev: 1 $
Synopsis
package YourApp;
use Catalyst qw(ConfigComponents...);
__PACKAGE__->config(
'Model::Help' => {
parent_classes => q(CatalystX::Usul::Model::Help) }, );Description
Provides context sensitive help. Help text comes from running Pod::Html on the controller source
Configuration and Environment
Defined the following list of attributes
- cpan_dist_uri
-
A non empty simple string which defaults to http://search.cpan.org/dist/. The uri prefix for a distributions online documentation
- name
-
A required non empty simple string. The name of the application
Subroutines/Methods
COMPONENT
Constructor sets attributes for the application name from the application config
about_form
$self->about_form;Provides information about the application. Content is implemented in a template
add_language_selector
$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"
company_form
$self->company_form;Provides information about the company. Content is implemented in a template
documentation_form
$self->documentation_form( $uri );Adds a file type field to the form. Displays as an iframe containing the HTML document referenced by $uri
feedback_form
$self->feedback_form( @args );Adds the fields and button data to the stash for the user feedback form
feedback_send
$self->feedback_send;Sends an email to the site administrators
footer_form
$self->footer_form;Calls "stash_debug_info" and "add_language_selector"
help_form
$self->help_form( $module );Extract the POD for a given controller and renders it as HTML
modules_form
$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
overview
$self->overview;Generate the data for an XML response to a Javascript XMLHttpRequest()
stash_debug_info
$self->stash_debug_info( $prefix );Stashes some useful information if debug is turned on
Diagnostics
None
Dependencies
- CatalystX::Usul::Model
- CatalystX::Usul::TraitFor::Model::StashHelper
- CatalystX::Usul::TraitFor::Model::QueryingRequest
- CatalystX::Usul::TraitFor::Email
- CatalystX::Usul::Moose
- Class::Usul::Time
- Time::Elapsed
Incompatibilities
There are no known incompatibilities in this module
Bugs and Limitations
There are no known bugs in this module. Please report problems to the address below. Patches are welcome
Author
Peter Flanigan, <Support at RoxSoft.co.uk>
License and Copyright
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