Changeset 90 in text-formbuilder for trunk/lib/Text/FormBuilder.pm

Timestamp:

04/24/08 21:47:43 (17 years ago)

Author:

peichman

Message:

• documentation patch from Ron Pero
• added shebang line to the fb.pl script
• added documentation about field hints
• upped version to 0.13
• changed all line endings in FormBuilder.pm to be unix-style

File:

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

trunk/lib/Text/FormBuilder.pm

@@ -7 +7 @@
 use vars qw($VERSION @EXPORT);
 
-$VERSION = '0.12';
+$VERSION = '0.13';
 @EXPORT = qw(create_form);
 
@@ -710 +710 @@
     name//VALUE
     email//EMAIL
-    langauge:select{English,Spanish,French,German}
+    language: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
+This will produce a required C<name> text 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,
+field C<language> 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,
@@ -732 +732 @@
     $parser->parse($filename);
     
-    # or pass a scalar ref for parse a literal string
+    # or pass a scalar ref to parse a literal string
     $parser->parse(\$string);
     
@@ -791 +791 @@
 
 If you want to use multiple external stylesheets, or an external stylesheet
-in conojunction with the default styles, use the C<external_css> option:
+in conjunction with the default styles, use the C<external_css> option:
 
     # single external sheet
@@ -1070 +1070 @@
 =item C<!title>
 
-Line directive contianing the title of the form.
+Line directive containing the title of the form.
 
 =item C<!author>
@@ -1078 +1078 @@
 =item C<!description>
 
-A block directive containing a brief description of the form. Suitable for 
+A block directive containing a brief description of the form. Appears at the top of the form. Suitable for 
 special instructions on how to fill out the form. All of the text within the
-block is folded into a single paragraph.
-
-=item C<!section>
+block is folded into a single paragraph. If you add a second !description, it will override the first.
+
+=item C<!section id Your section text goes here>
 
 A line directive that starts a new section. Each section has its own heading
-and id, which by default are rendered into spearate tables.
+and id, which by default are rendered into separate tables.
 
 =item C<!head>
@@ -1171 +1171 @@
 
     color|'Fav. color'
+
+To add a descriptive hint that should appear to the right of the form field,
+put the hint in square brackets after the label, but before the field type:
+
+    # hint for a field without a label
+    color[select from a list]
+
+    # hint together with a label
+    color|Favorite color[select from this list]
 
 To use a different input type:
@@ -1394 +1403 @@
 sections.
 
+To Ron Pero for a documentation patch, and for letting me know that software
+I wrote several years ago is still of use to people.
+
 And of course, to Nathan Wiger, for giving us CGI::FormBuilder in the
 first place. Thanks Nate!