Name

CatalystX::Usul::Model::Help - Provides data for help pages

Version

0.6.$Revision: 1165 $

Synopsis

   package MyApp::Model::Help;

   use base qw(CatalystX::Usul::Model::Help);

   1;

   package MyApp::Controller::Foo;

   sub bar {
      my ($self, $c) = @_;

      $c->model( q(Help) )->get_help( $c->stash, q(Foo) );
   }

Description

Provides context sensitive help. Help text comes from running Pod::Html on the controller source

Subroutines/Methods

COMPONENT

Constructor sets attributes for: default CSS filename and the application name from the application config

about_form

Provides information about the application. Content is implemented in a template

add_debug_info

Adds some useful information to the footer if debug is turned on

add_footer

Calls "add_debug_info" and "add_select_language"

add_select_language

Adds a form containing a popup menu that allows the user to select from the list of supported languages. Called from "add_footer"

documentation

   $self->model( q(Help) )->documentation( $uri );

Adds a file type field to the form. Displays as an iframe containing the HTML document referenced by $uri

feedback_form

Adds the fields and button data to the stash for the user feedback form

feedback_send

Sends an email to the site administrators

get_help

Add a field of type POD

module_docs

Extract the POD for a given module and renders it as HTML

module_list

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

Generate the data for an XML response to a Javascript XMLHttpRequest()

Diagnostics

None

Configuration and Environment

None

Dependencies

CatalystX::Usul::Model

CatalystX::Usul::Table

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) 2008 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

cpanm CatalystX::Usul

perl -MCPAN -e shell
install CatalystX::Usul