source: text-formbuilder/trunk/lib/Text/FormBuilder.html @ 1

Last change on this file since 1 was 1, checked in by peter, 20 years ago

initial import
File size: 2.7 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<title>Text::FormBuilder - Parser for a minilanguage describing web forms</title>
5<link rev="made" href="mailto:" />
6</head>
7
8<body style="background-color: white">
9
10<p><a name="__index__"></a></p>
11<!-- INDEX BEGIN -->
12
13<ul>
14
15        <li><a href="#name">NAME</a></li>
16        <li><a href="#synopsis">SYNOPSIS</a></li>
17        <li><a href="#description">DESCRIPTION</a></li>
18        <ul>
19
20                <li><a href="#new">new</a></li>
21                <li><a href="#parse">parse</a></li>
22                <li><a href="#build">build</a></li>
23                <li><a href="#write">write</a></li>
24        </ul>
25
26        <li><a href="#language">LANGUAGE</a></li>
27        <ul>
28
29                <li><a href="#directives">Directives</a></li>
30                <li><a href="#fields">Fields</a></li>
31                <li><a href="#comments">Comments</a></li>
32        </ul>
33
34        <li><a href="#see_also">SEE ALSO</a></li>
35</ul>
36<!-- INDEX END -->
37
38<hr />
39<p>
40</p>
41<h1><a name="name">NAME</a></h1>
42<p>Text::FormBuilder - Parser for a minilanguage describing web forms</p>
43<p>
44</p>
45<hr />
46<h1><a name="synopsis">SYNOPSIS</a></h1>
47<pre>
48    my $parser = Text::FormBuilder-&gt;new;
49    $parser-&gt;parse($src_file);
50   
51    # returns a new CGI::FormBuilder object with the fields
52    # from the input form spec
53    my $form = $parser-&gt;build_form;</pre>
54<p>
55</p>
56<hr />
57<h1><a name="description">DESCRIPTION</a></h1>
58<p>
59</p>
60<h2><a name="new">new</a></h2>
61<p>
62</p>
63<h2><a name="parse">parse</a></h2>
64<p>
65</p>
66<h2><a name="build">build</a></h2>
67<p>
68</p>
69<h2><a name="write">write</a></h2>
70<p>
71</p>
72<hr />
73<h1><a name="language">LANGUAGE</a></h1>
74<pre>
75    name[size]|descriptive label[hint]:type=default{option1(display string),option2(display string),...}//validate
76   
77    !title ...
78   
79    !pattern name /regular expression/
80    !list name {
81        option1(display string),
82        option2(display string),
83        ...
84    }</pre>
85<p>
86</p>
87<h2><a name="directives">Directives</a></h2>
88<dl>
89<dt><strong><a name="item__21pattern"><code>!pattern</code></a></strong><br />
90</dt>
91<dt><strong><a name="item__21list"><code>!list</code></a></strong><br />
92</dt>
93<dt><strong><a name="item__21title"><code>!title</code></a></strong><br />
94</dt>
95</dl>
96<p>
97</p>
98<h2><a name="fields">Fields</a></h2>
99<p>Form fields are each described on a single line.
100
101</p>
102<p>
103</p>
104<h2><a name="comments">Comments</a></h2>
105<pre>
106    # comment ...
107
108</pre>
109<p>Any line beginning with a <code>#</code> is considered a comment.
110
111</p>
112<p>
113</p>
114<hr />
115<h1><a name="see_also">SEE ALSO</a></h1>
116<p><a href="/CGI/FormBuilder.html">the CGI::FormBuilder manpage</a>
117
118</p>
119
120</body>
121
122</html>
Note: See TracBrowser for help on using the repository browser.