CatalystX::Usul::Model::Help - Create HTML from POD

0.3.$Revision: 576 $

   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) );
   }

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

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

   $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

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

Sends an email to the site administrators

Add the field to the stash that is the rendered HTML created by calling retrieve

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

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

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

Calls Pod::Html to create the help text from the controller POD

None

None

CatalystX::Usul::Model

CatalystX::Usul::Table

Pod::Html

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>

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