Changeset 38 in text-formbuilder for trunk/lib/Text

Timestamp:

12/06/04 14:22:54 (20 years ago)

Author:

peter

Message:

more documentation
upped version number

File:

• trunk/lib/Text/FormBuilder.pm (modified) (6 diffs)

trunk/lib/Text/FormBuilder.pm

@@ -6 +6 @@
 use vars qw($VERSION);
 
-$VERSION = '0.06';
+$VERSION = '0.07_01';
 
 use Carp;
@@ -100 +100 @@
     
     # css, extra_css: allow for custom inline stylesheets
-    #   neat trick: extra_css => '@import(my_external_stylesheet.css);'
+    #   neat trick: css => '@import(my_external_stylesheet.css);'
     #   will let you use an external stylesheet
     #   CSS Hint: to get multiple sections to all line up their fields,
@@ -109 +109 @@
     
     # messages
+    # code pulled (with modifications) from CGI::FormBuilder
     if ($options{messages}) {
         # if its a hashref, we'll just pass it on to CGI::FormBuilder
@@ -213 +214 @@
     }
     
-    # TODO: configurable threshold for this
     foreach (@{ $self->{form_spec}{fields} }) {
         $$_{ulist} = 1 if ref $$_{options} and @{ $$_{options} } >= 3;
@@ -527 +527 @@
 =head1 DESCRIPTION
 
+This module is intended to extend the idea of making it easy to create
+web forms by allowing you to describe them with a simple langauge. These
+I<formspecs> are then passed through this module's parser and converted
+into L<CGI::FormBuilder> objects that you can easily use in your CGI
+scripts. In addition, this module can generate code for standalone modules
+which allow you to separate your form design from your script code.
+
+A simple formspec looks like this:
+
+    name//VALUE
+    email//EMAIL
+    langauge:select{English,Spanish,French,German}
+    moreinfo|Send me more information:checkbox
+    interests:checkbox{Perl,karate,bass guitar}
+
+This will produce a required C<name> test field, a required C<email> text
+field that must look like an email address, an optional select dropdown
+field C<langauge> with the choices English, Spanish, French, and German,
+an optional C<moreinfo> checkbox labeled ``Send me more information'', and
+finally a set of checkboxes named C<interests> with the choices Perl,
+karate, and bass guitar.
+
 =head2 new
+
+    my $parser = Text::FormBuilder->new;
 
 =head2 parse
@@ -573 +597 @@
 appended to the CSS. If both options are given, then the CSS that is
 used will be C<css> concatenated with C<extra_css>.
+
+If you want to use an external stylesheet, a quick way to get this is
+to set the C<css> parameter to import your file:
+
+    css => '@import(my_external_stylesheet.css);'
 
 =item C<messages>