X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalystX%2FHelpText.pm;h=f6abd11d10fe71dd8602f337ab3fdf784ad27554;hb=e94c600fc5f438dcc8eb04feaa9dee257136da95;hp=f1357cb33aaef2cb58f39ebb386f22b9b8f30579;hpb=734ae5f8bff8523d504d1c76ed8675ddc9ee7c99;p=catagits%2FCatalystX-HelpText.git

diff --git a/lib/CatalystX/HelpText.pm b/lib/CatalystX/HelpText.pm
index f1357cb..f6abd11 100644
--- a/lib/CatalystX/HelpText.pm
+++ b/lib/CatalystX/HelpText.pm
@@ -1,12 +1,14 @@
 package CatalystX::HelpText;
-use Moose;
-use namespace::autoclean;
+use strict;
+use warnings;
+
+our $VERSION = '0.001';
 
 1;
 
 =head1 NAME
 
-CatalystX::HelpText - Helper to include text/html snippets in Catalyst TT View templates
+CatalystX::HelpText - Helper to include text/html snippets in Catalyst View templates
 
 =head1 SYNOPSIS
 
@@ -20,27 +22,55 @@ Create a model class in your Catalyst project like:
     1;
 
 Configure it setting value for:
- - help_files_path: where the help files will be found
- - help_files_ext: what is the extension for the help files (default: html)
- - wrapper_tag: what tag will be used to wrap the shippet (default: span)
- - wrapper_css_class: what css class will be applied to the wrapper tag (default: help_text)
+
+=over
+
+=item help_files_path
+
+Where the help files will be found
+
+=item help_files_ext
+
+What is the extension for the help files (default: html)
+
+=item wrapper_tag
+
+What tag will be used to wrap the shippet (default: span)
+
+=item wrapper_css_class
+
+What css class will be applied to the wrapper tag (default: help_text)
+
+=back
 
 Create files with the text/html to be included and store them at help_files_path.
 
-Apply the CatalystX::HelpText::ViewRole in your TT View.
+Apply the L<CatalystX::HelpText::ViewRole> in your View.
+
+Uses the C<< [% helptext('SomeHelpTopic') %] >>in your templates to include the
+file C<SomeHelpTopic.html> in the page.
+
+Uses the script C<search_undocumented_templates.pl> to find the missing help text files.
 
-Uses the [% helptext('SomeHelpTopic') %] in your templates to include the file SomeHelpTopic.html in the page.
+=head1 SEE ALSO
 
-Uses the script bin/search_undocumented_templates.pl to find the missing help text files.
+=over
+
+=item L<CatalystX::HelpText::Model>
+
+=item L<CatalystX::HelpText::ViewRole>
+
+=back
 
 =head1 AUTHOR
 
-Thomas Doran,C<t0m at state51.co.uk>
-Cinxgler Mariaca Minda,C<cinxgler at ci-info.com>
+Toomas Doran, C<< t0m at state51.co.uk >>
+
+Cinxgler Mariaca Minda, C<< cinxgler at ci-info.com >>
 
 =head1 COPYRIGHT
 
-Copyright state51.
+Copyright Oscar Music and Media 2011.
 
 =head1 LICENSE