Hi,

I added some documentation to html_formfu_peploy.pl so it gets a more
helpful man page.

Also I changed the NAME section in some modules so that man page
indexers can get useful information from it.  Some modules with POD
still miss this information (I did not find a useful short description
for those): H::F::Attribute, H::F::E::_DateSelect, H::F::QueryType::*,
and H::F::UploadParam.  It would be nice if these could also get a short
description.

Regards,
Ansgar

-- 
PGP: 1024D/595FAD19  739E 2D09 0969 BEA9 9797  B055 DDB0 2FF7 595F AD19

--- libhtml-formfu-perl.orig/bin/html_formfu_deploy.pl
+++ libhtml-formfu-perl/bin/html_formfu_deploy.pl
@@ -17,3 +17,26 @@
 }
 
 HTML::FormFu::Deploy::deploy( $ARGV[0] );
+
+__END__
+
+=head1 NAME
+
+html_formfu_deploy.pl - deploy local copy of HTML::FormFu template files
+
+=head1 SYNOPSIS
+
+html_formfu_deploy.pl F<target-directory>
+
+=head1 DESCRIPTION
+
+The "html_formfu_deploy.pl" script creates a local copy of the HTML::FormFu
+template files for customization in the directory F<target-directory>.
+
+If no customization is needed, HTML::FormFu should use the system-wide
+installation of the template files.
+
+=head1 SEE ALSO
+
+HTML::FormFu::Deploy
+
--- libhtml-formfu-perl.orig/lib/HTML/FormFu/Element/Hr.pm
+++ libhtml-formfu-perl/lib/HTML/FormFu/Element/Hr.pm
@@ -18,7 +18,7 @@
 
 =head1 NAME
 
-HTML::FormFu::Element::Hr
+HTML::FormFu::Element::Hr - horizontal-rule element
 
 =head1 DESCRIPTION
 
--- libhtml-formfu-perl.orig/lib/HTML/FormFu/Element/Src.pm
+++ libhtml-formfu-perl/lib/HTML/FormFu/Element/Src.pm
@@ -18,7 +18,7 @@
 
 =head1 NAME
 
-HTML::FormFu::Element::Src
+HTML::FormFu::Element::Src - custom HTML element
 
 =head1 DESCRIPTION
 
--- libhtml-formfu-perl.orig/lib/HTML/FormFu/Filter/HTMLEscape.pm
+++ libhtml-formfu-perl/lib/HTML/FormFu/Filter/HTMLEscape.pm
@@ -22,7 +22,7 @@
 
 =head1 NAME
 
-HTML::FormFu::Filter::HTMLEscape
+HTML::FormFu::Filter::HTMLEscape - filter escaping HTML
 
 =head1 DESCRIPTION
 
--- libhtml-formfu-perl.orig/lib/HTML/FormFu/Filter/HTMLScrubber.pm
+++ libhtml-formfu-perl/lib/HTML/FormFu/Filter/HTMLScrubber.pm
@@ -39,7 +39,7 @@
 
 =head1 NAME
 
-HTML::FormFu::Filter::HTMLScrubber
+HTML::FormFu::Filter::HTMLScrubber - filter removing HTML markup
 
 =head1 DESCRIPTION
 
--- libhtml-formfu-perl.orig/lib/HTML/FormFu/Filter/LowerCase.pm
+++ libhtml-formfu-perl/lib/HTML/FormFu/Filter/LowerCase.pm
@@ -17,7 +17,7 @@
 
 =head1 NAME
 
-HTML::FormFu::Filter::LowerCase
+HTML::FormFu::Filter::LowerCase - filter transforming to lower case
 
 =head1 DESCRIPTION
 
--- libhtml-formfu-perl.orig/lib/HTML/FormFu/Filter/NonNumeric.pm
+++ libhtml-formfu-perl/lib/HTML/FormFu/Filter/NonNumeric.pm
@@ -11,7 +11,7 @@
 
 =head1 NAME
 
-HTML::FormFu::Filter::NonNumeric
+HTML::FormFu::Filter::NonNumeric - filter removing all non-numeric characters
 
 =head1 DESCRIPTION
 
--- libhtml-formfu-perl.orig/lib/HTML/FormFu/Filter/Regex.pm
+++ libhtml-formfu-perl/lib/HTML/FormFu/Filter/Regex.pm
@@ -26,7 +26,7 @@
 
 =head1 NAME
 
-HTML::FormFu::Filter::Regex
+HTML::FormFu::Filter::Regex - regexp-based match/replace filter
 
 =head1 SYNOPSIS
 
--- libhtml-formfu-perl.orig/lib/HTML/FormFu/Filter/Split.pm
+++ libhtml-formfu-perl/lib/HTML/FormFu/Filter/Split.pm
@@ -26,7 +26,7 @@
 
 =head1 NAME
 
-HTML::FormFu::Filter::Split
+HTML::FormFu::Filter::Split - filter splitting a singe valut into an arrayref
 
 =head1 SYNOPSIS
 
--- libhtml-formfu-perl.orig/lib/HTML/FormFu/Filter/TrimEdges.pm
+++ libhtml-formfu-perl/lib/HTML/FormFu/Filter/TrimEdges.pm
@@ -20,7 +20,7 @@
 
 =head1 NAME
 
-HTML::FormFu::Filter::TrimEdges
+HTML::FormFu::Filter::TrimEdges - filter timming whitespace
 
 =head1 DESCRIPTION
 
--- libhtml-formfu-perl.orig/lib/HTML/FormFu/Filter/UpperCase.pm
+++ libhtml-formfu-perl/lib/HTML/FormFu/Filter/UpperCase.pm
@@ -17,7 +17,7 @@
 
 =head1 NAME
 
-HTML::FormFu::Filter::UpperCase
+HTML::FormFu::Filter::UpperCase - filter transforming to upper case
 
 =head1 DESCRIPTION
 
--- libhtml-formfu-perl.orig/lib/HTML/FormFu/Filter/Whitespace.pm
+++ libhtml-formfu-perl/lib/HTML/FormFu/Filter/Whitespace.pm
@@ -11,7 +11,7 @@
 
 =head1 NAME
 
-HTML::FormFu::Filter::Whitespace
+HTML::FormFu::Filter::Whitespace - filter stripping all whitespace
 
 =head1 DESCRIPTION
 
--- libhtml-formfu-perl.orig/lib/HTML/FormFu/Element/SimpleTable.pm
+++ libhtml-formfu-perl/lib/HTML/FormFu/Element/SimpleTable.pm
@@ -115,7 +115,7 @@
 
 =head1 NAME
 
-HTML::FormFu::Element::SimpleTable
+HTML::FormFu::Element::SimpleTable - simple table element
 
 =head1 SYNOPSIS
 
--- libhtml-formfu-perl.orig/lib/HTML/FormFu/Element/_Field.pm
+++ libhtml-formfu-perl/lib/HTML/FormFu/Element/_Field.pm
@@ -1041,7 +1041,7 @@
 
 =head1 NAME
 
-HTML::FormFu::Element::_Field
+HTML::FormFu::Element::_Field - base class for all form-field elements
 
 =head1 DESCRIPTION
 
--- libhtml-formfu-perl.orig/lib/HTML/FormFu/Element/_NonBlock.pm
+++ libhtml-formfu-perl/lib/HTML/FormFu/Element/_NonBlock.pm
@@ -51,7 +51,7 @@
 
 =head1 NAME
 
-HTML::FormFu::Element::_NonBlock
+HTML::FormFu::Element::_NonBlock - base class for single-tag elements
 
 =head1 DESCRIPTION
 
--- libhtml-formfu-perl.orig/lib/HTML/FormFu/Upload.pm
+++ libhtml-formfu-perl/lib/HTML/FormFu/Upload.pm
@@ -45,7 +45,7 @@
 
 =head1 NAME
 
-HTML::FormFu::Upload
+HTML::FormFu::Upload - uploaded file
 
 =head1 DESCRIPTION
 
_______________________________________________
HTML-FormFu mailing list
HTML-FormFu@lists.scsys.co.uk
http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/html-formfu

Reply via email to