.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "CGI::FormBuilder::Template::Fast 3"
.TH CGI::FormBuilder::Template::Fast 3 2023-07-25 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
CGI::FormBuilder::Template::Fast \- FormBuilder interface to CGI::FastTemplate
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 10
\& my $form = CGI::FormBuilder\->new(
\& fields => \e@whatever,
\& template => {
\& type => \*(AqFast\*(Aq,
\& root => \*(Aq/path/to/templates\*(Aq,
\& # use external files
\& define => {
\& form => \*(Aqform.txt\*(Aq,
\& field => \*(Aqfield.txt\*(Aq,
\& invalid_field => \*(Aqinvalid_field.txt\*(Aq,
\& },
\& # or define inline
\& define_nofile => {
\& form => \*(Aq$START_FORM
\& $SUBMIT $END_FORM\*(Aq,
\& # etc.
\& },
\& },
\& );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This engine adapts \fBFormBuilder\fR to use \f(CW\*(C`CGI::FastTemplate\*(C'\fR. Please
read these docs carefully, as the usage differs from other template
adapters in several important ways.
.PP
You will need to define three templates: \f(CW\*(C`form\*(C'\fR, \f(CW\*(C`field\*(C'\fR, and
\&\f(CW\*(C`invalid_field\*(C'\fR. You can use \f(CW\*(C`define\*(C'\fR to point to external files
(which is the recommended \f(CW\*(C`CGI::FastTemplate\*(C'\fR style), or \f(CW\*(C`define_nofile\*(C'\fR/
\&\f(CW\*(C`define_raw\*(C'\fR to define them inline. The templates in \f(CW\*(C`define_nofile\*(C'\fR
take precedence over \f(CW\*(C`define_raw\*(C'\fR, and both of these take precedence
over \f(CW\*(C`define\*(C'\fR.
.PP
.Vb 10
\& my $form = CGI::FormBuilder\->new(
\& # ...
\& template => {
\& type => \*(AqFastTemplate\*(Aq,
\& root => \*(Aq/path/to/templates\*(Aq,
\& define => {
\& form => \*(Aqform.txt\*(Aq,
\& field => \*(Aqfield.txt\*(Aq,
\& invalid_field => \*(Aqinvalid_field.txt\*(Aq,
\& },
\& # or, you can define templates directly
\& define_nofile => {
\& form => \*(Aq$START_FORM$SUBMIT $END_FORM\*(Aq,
\& # etc.
\& },
\& },
\& # ...
\& );
.Ve
.PP
If you use \f(CW\*(C`define\*(C'\fR with external templates, you will probably
also want to define your template root directory with the \f(CW\*(C`root\*(C'\fR
parameter.
.PP
Within each of the field templates, the following variables
are available:
.PP
.Vb 7
\& $NAME # $field\->name
\& $FIELD # $field\->tag (HTML input tag)
\& $VALUE # $field\->value (first value only!)
\& $LABEL # $field\->label
\& $COMMENT # $field\->comment
\& $ERROR # $field\->error
\& $REQUIRED # $field\->required ? \*(Aqrequired\*(Aq : \*(Aqoptional\*(Aq
.Ve
.PP
All the fields are processed in sequence; valid fields use the
\&\f(CW\*(C`field\*(C'\fR template, and invalid fields the \f(CW\*(C`invalid_field\*(C'\fR template.
The result from each of these is appended into the \f(CW$FIELDS\fR
variable, which you should use in your \f(CW\*(C`form\*(C'\fR template. In the
\&\f(CW\*(C`form\*(C'\fR template, you also have access to these variables:
.PP
.Vb 6
\& $TITLE # title of the form
\& $START_FORM # opening form tag
\& $SUBMIT # the submit button
\& $RESET # the reset button
\& $END_FORM # closing form tag
\& $JS_HEAD # validation JavaScript
.Ve
.PP
Note that since \f(CW\*(C`CGI::FastTemplate\*(C'\fR doesn't use anything other than
simple scalar variables, there are no variables corrosponding to
the lists that other engines have (e.g. \f(CW\*(C`fields\*(C'\fR or \f(CW\*(C`options\*(C'\fR
lists in \f(CW\*(C`TT2\*(C'\fR or \f(CW\*(C`Text::Template\*(C'\fR).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
CGI::FormBuilder, CGI::FormBuilder::Template, CGI::FastTemplate
.SH AUTHOR
.IX Header "AUTHOR"
Copyright (c) 2005\-2006 Peter Eichman . All Rights Reserved.
.PP
Maintained as part of \f(CW\*(C`CGI::FormBuilder\*(C'\fR by Nate Wiger .
.PP
This module is free software; you may copy this under the terms of
the GNU General Public License, or the Artistic License, copies of
which should have accompanied your Perl kit.