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

Timestamp:

10/06/04 13:44:15 (20 years ago)

Author:

peter

Message:

removed dependecies on YAML and Parse::RecDescent
renamed _dump to dump; now only tries to load YAML if it is called; non-fatal error if YAML cannot be loaded
modified bin/fb-cgi.pl
expanded docs

File:

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

trunk/lib/Text/FormBuilder.pm

@@ -4 +4 @@
 use warnings;
 
-our $VERSION = '0.01';
+our $VERSION = '0.02';
 
 use Text::FormBuilder::Parser;
 use CGI::FormBuilder;
-use YAML;
 
 sub new {
@@ -153 +152 @@
 }
 
-sub _dump { print YAML::Dump(shift->{form_spec}); }
+sub dump { 
+    eval "use YAML;";
+    unless ($@) {
+        print YAML::Dump(shift->{form_spec});
+    } else {
+        warn "Can't dump form spec structure: $@";
+    }
+}
 
 
@@ -170 +176 @@
     # returns a new CGI::FormBuilder object with the fields
     # from the input form spec
-    my $form = $parser->build_form;
+    my $form = $parser->form;
 
 =head1 DESCRIPTION
@@ -178 +184 @@
 =head2 parse
 
+    $parser->parse($src_file);
+    
+    # or as a class method
+    my $parser = Txt::FormBuilder->parse($src_file);
+
+=head2 parse_text
+
 =head2 build
 
+Options passed to build are passed on verbatim to the L<CGI::FormBuilder>
+constructor. Any options given here override the defaults that this module
+uses.
+
+=head2 form
+
+    my $form = $parser->form;
+
+Returns the L<CGI::FormBuilder> object.
+
 =head2 write
 
+    $parser->write($out_file);
+    # or just print to STDOUT
+    $parser->write;
+
+Calls C<render> on the FormBuilder form, and either writes the resulting HTML
+to a file, or to STDOUT if no filename is given.
+
+=head2 dump
+
+Uses L<YAML> to print out a human-readable representaiton of the parsed
+form spec.
+
 =head1 LANGUAGE
 
-    name[size]|descriptive label[hint]:type=default{option1(display string),option2(display string),...}//validate
+    name[size]|descriptive label[hint]:type=default{option1[display string],option2[display string],...}//validate
     
     !title ...
@@ -190 +225 @@
     !pattern name /regular expression/
     !list name {
-        option1(display string),
-        option2(display string),
+        option1[display string],
+        option2[display string],
         ...
     }
@@ -204 +239 @@
 
 =item C<!title>
+
+=item C<!author>
 
 =back
@@ -220 +257 @@
 Any line beginning with a C<#> is considered a comment.
 
+=head1 TODO
+
+=head2 Langauge
+
+Directive for a descriptive or explanatory paragraph about the form
+
+Subsection headers?
+
 =head1 SEE ALSO