.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Bigtop::Docs::FullKeywords 3"
.TH Bigtop::Docs::FullKeywords 3 "2008-01-18" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Bigtop::Docs::FullKeywords \- Descriptions of all Bigtop keywords
.SH "Intro"
.IX Header "Intro"
This document is generated from \f(CW\*(C`Bigtop::Docs::Keywords\*(C'\fR.  It lists
each supported keyword available in the Bigtop language, just as tentmaker
would, but in \s-1POD\s0 form.  See the beginning of \f(CW\*(C`Bigtop::Docs::Syntax\*(C'\fR
for a general description of Bigtop source file structure.  See
also \f(CW\*(C`Bigtop::Docs::TentTut\*(C'\fR, which \*(-- like this file \*(-- draws from
\&\f(CW\*(C`Bigtop::Keywords\*(C'\fR.  You might also find \f(CW\*(C`Bigtop::Docs::Cookbook\*(C'\fR useful.
.SH "Categories"
.IX Header "Categories"
Bigtop keywords come in many categories.  Each subsection below describes
one category.  Here is a brief description of where the keywords
from each categories appear in the Bigtop source file.
.IP "config" 4
.IX Item "config"
These keywords appear in the Bigtop config block that begins each bigtop
file.
.Sp
This is not to be confused with the app level config block which
appears inside the app block.  There are no defined keywords in the app
config blocks, use whatever conf variable names you like there.  The
same goes for controller level config blocks.
.IP "app" 4
.IX Item "app"
These keywords appear at the top level of the app block.
.IP "app_literal" 4
.IX Item "app_literal"
Literals are not blocks and do not have statements like blocks.  They have
this form:
.Sp
.Vb 1
\&    literal type `whatever string you like`;
.Ve
.Sp
where \f(CW\*(C`literal\*(C'\fR introduces the literal and \f(CW\*(C`type\*(C'\fR is one of the
\&\f(CW\*(C`app_literal\*(C'\fR keywords listed below.  So, for these 'keyword' should
really be called 'type.'
.IP "controller_literal" 4
.IX Item "controller_literal"
Just like app_literals, but appearing inside controller blocks.
.IP "table" 4
.IX Item "table"
These keywords appear at the top level of table blocks, which in turn
appear at the top level of the app block.
.IP "join_table" 4
.IX Item "join_table"
These keywords appear at the top level of join_table blocks, which appear
at top level of the app block.
.IP "field" 4
.IX Item "field"
These keywords appear in field blocks, which in turn appear inside table
or join_table blocks.
.IP "controller" 4
.IX Item "controller"
These keywords appear in controller blocks, which are at the top level of
the app block.
.IP "method" 4
.IX Item "method"
These keywords appear in method blocks, which appear inside controller blocks.
.PP
Now that you know where the keywords may appear, here they are.  The
categories appear in alphabetical order.  The keywords themselves are
grouped logically (or so it seems to me).  The keyword order within
the category is shared with tentmaker (though tentmaker excludes
keywords which don't apply to the controller or method type).
.Sh "app"
.IX Subsection "app"
.IP "no_gen" 4
.IX Item "no_gen"
Skip this app completely
.Sp
This field is boolean, use 1 for true or 0 for false.
.IP "location" 4
.IX Item "location"
Base Location of the app [defaults to /]
Do not use if you have a Base Controller.
.IP "authors" 4
.IX Item "authors"
Who to blame for the app
.Sp
Values for authors statements may be individual values
or pairs like:
.Sp
.Vb 1
\&    name => optional_value
.Ve
.Sp
where \f(CW\*(C`name\*(C'\fR is a name and \f(CW\*(C`optional_value\*(C'\fR is a email address.
.Sp
You may supply a comma separated list of values for
authors statements.
.Sp
This statement is only occasionally used.
.IP "contact_us" 4
.IX Item "contact_us"
How to send complaints or join the project
.IP "copyright_holder" 4
.IX Item "copyright_holder"
Who owns the app [defaults to 1st author]
.Sp
You may supply a comma separated list of values for
copyright_holder statements.
.IP "license_text" 4
.IX Item "license_text"
Restrictions [defaults to Perl license]
.IP "uses" 4
.IX Item "uses"
List of modules used by base module
Do not use if you have a Base Controller.
.Sp
You may supply a comma separated list of values for
uses statements.
.IP "email" 4
.IX Item "email"
\&\s-1DEPRECATED\s0
.Sp
Where to send complaints (think mailing list)
.Sh "app_literal"
.IX Subsection "app_literal"
.IP "Conf" 4
.IX Item "Conf"
top level of Gantry::Conf file
.IP "PerlTop" 4
.IX Item "PerlTop"
immediately after shebang line in httpd.conf
<Perl> block and in the \s-1CGI\s0 scripts
.IP "PerlBlock" 4
.IX Item "PerlBlock"
in the httpd.conf <Perl> block (in order
with controllers)
.IP "HttpdConf" 4
.IX Item "HttpdConf"
between location directives in httpd.conf
.IP "Location" 4
.IX Item "Location"
in the base Location directive for the app
.IP "\s-1SQL\s0" 4
.IX Item "SQL"
dumped directly into all schemas
.Sh "config"
.IX Subsection "config"
.IP "engine" 4
.IX Item "engine"
mod_perl 1.3, mod_perl 2.0, \s-1CGI\s0, etc.
.Sp
Only certain values are legal for statement.keyword statements.
Please choose from these options:
.RS 4
.IP "\s-1MP13\s0" 4
.IX Item "MP13"
mod_perl 1.3
.IP "\s-1MP20\s0" 4
.IX Item "MP20"
mod_perl 2.0
.IP "\s-1CGI\s0" 4
.IX Item "CGI"
CGI/FastCGI
.RE
.RS 4
.RE
.IP "template_engine" 4
.IX Item "template_engine"
Template Toolkit, Mason, etc.
.Sp
Only certain values are legal for statement.keyword statements.
Please choose from these options:
.RS 4
.IP "\s-1TT\s0" 4
.IX Item "TT"
Template Toolkit
.IP "Default" 4
.IX Item "Default"
No Templating
.RE
.RS 4
.RE
.IP "plugins" 4
.IX Item "plugins"
List of Plugins i.e. AuthCookie Static
.IP "base_dir" 4
.IX Item "base_dir"
\&\s-1DEPRECATED\s0
.Sp
parent of build dir
.IP "app_dir" 4
.IX Item "app_dir"
\&\s-1DEPRECATED\s0
.Sp
build dir. relative to parent dir
.Sh "controller"
.IX Subsection "controller"
.IP "no_gen" 4
.IX Item "no_gen"
Skip this controller completely
.Sp
Applies to all controller types.
.Sp
This field is boolean, use 1 for true or 0 for false.
.IP "location" 4
.IX Item "location"
Absolute Location of this controller [non\-base controllers
must have either a location or a rel_location.]
.Sp
Applies to all controller types.
.Sp
This statement is virtually required.
.IP "rel_location" 4
.IX Item "rel_location"
Location of this controller relative to app location
[non\-base controllers must have location or rel_location.]
.Sp
Applies to controllers of type: AutoCRUD, \s-1CRUD\s0, \s-1SOAP\s0, and stub.
.Sp
This statement is virtually required.
.IP "controls_table" 4
.IX Item "controls_table"
Table this controller manages
.Sp
Applies to all controller types.
.Sp
This statement is virtually required.
.IP "gen_uses" 4
.IX Item "gen_uses"
List of modules used in gen module
use list ex: qw( :default )
.Sp
Applies to all controller types.
.Sp
Values for gen_uses statements may be individual values
or pairs like:
.Sp
.Vb 1
\&    name => optional_value
.Ve
.Sp
where \f(CW\*(C`name\*(C'\fR is a module and \f(CW\*(C`optional_value\*(C'\fR is a literal use list.
.Sp
You may supply a comma separated list of values for
gen_uses statements.
.IP "stub_uses" 4
.IX Item "stub_uses"
List of modules used in stub module
.Sp
Applies to all controller types.
.Sp
Values for stub_uses statements may be individual values
or pairs like:
.Sp
.Vb 1
\&    name => optional_value
.Ve
.Sp
where \f(CW\*(C`name\*(C'\fR is a module and \f(CW\*(C`optional_value\*(C'\fR is a literal use list.
.Sp
You may supply a comma separated list of values for
stub_uses statements.
.IP "uses" 4
.IX Item "uses"
List of modules used by gen and stub modules
.Sp
Applies to all controller types.
.Sp
Values for uses statements may be individual values
or pairs like:
.Sp
.Vb 1
\&    name => optional_value
.Ve
.Sp
where \f(CW\*(C`name\*(C'\fR is a module and \f(CW\*(C`optional_value\*(C'\fR is a literal use list.
.Sp
You may supply a comma separated list of values for
uses statements.
.IP "plugins" 4
.IX Item "plugins"
List of plugins used by gen module
.Sp
Applies to all controller types.
.Sp
You may supply a comma separated list of values for
plugins statements.
.IP "text_description" 4
.IX Item "text_description"
Required for Gantry's AutoCRUD
.Sp
Applies to controllers of type: AutoCRUD and base_controller.
.Sp
This statement is frequently used.
.IP "page_link_label" 4
.IX Item "page_link_label"
Link text in navigation bar
[use only for navigable controllers]
.Sp
Applies to all controller types.
.Sp
This statement is frequently used.
.IP "autocrud_helper" 4
.IX Item "autocrud_helper"
Gantry::Plugins::AutoCRUDHelper for your \s-1ORM\s0
.Sp
Applies to controllers of type: AutoCRUD and base_controller.
.IP "skip_test" 4
.IX Item "skip_test"
Skip default page hit test of this controller
.Sp
Applies to all controller types.
.Sp
This field is boolean, use 1 for true or 0 for false.
.IP "soap_name" 4
.IX Item "soap_name"
Base of all \s-1WSDL\s0 names
.Sp
Applies to controllers of type: \s-1SOAP\s0.
.Sp
This statement is required.
.IP "namespace_base" 4
.IX Item "namespace_base"
Base \s-1URL\s0 of \s-1WSDL\s0 namespace including domain
.Sp
Applies to controllers of type: \s-1SOAP\s0.
.Sp
This statement is required.
.Sh "controller_literal"
.IX Subsection "controller_literal"
.IP "Location" 4
.IX Item "Location"
in Location block for this controller
.IP "GantryLocation" 4
.IX Item "GantryLocation"
in GantryLocation block for this controller
.Sh "field"
.IX Subsection "field"
.IP "no_gen" 4
.IX Item "no_gen"
Skip this field completely
.Sp
This field is boolean, use 1 for true or 0 for false.
.IP "not_for" 4
.IX Item "not_for"
Tell Model and/or \s-1SQL\s0 to skip this field
.Sp
Only certain values are legal for statement.keyword statements.
Please choose from these options:
.RS 4
.IP "\s-1SQL\s0" 4
.IX Item "SQL"
\&\s-1SQL\s0
.IP "Model" 4
.IX Item "Model"
Model
.RE
.RS 4
.Sp
You may supply a comma separated list of values for
not_for statements.
.RE
.IP "is" 4
.IX Item "is"
\&\s-1SQL\s0 type clause phrases, e.g.:
.Sp
.Vb 4
\&    int4
\&    varchar
\&    primary_key
\&    auto
.Ve
.Sp
You may supply a comma separated list of values for
is statements.
.Sp
This statement is required.
.IP "accessor" 4
.IX Item "accessor"
DBIx::Class alternate accessor name for this column
.Sp
You may supply a comma separated list of values for
accessor statements.
.IP "refers_to" 4
.IX Item "refers_to"
Where this foreign key points
.Sp
Values for refers_to statements may be individual values
or pairs like:
.Sp
.Vb 1
\&    name => optional_value
.Ve
.Sp
where \f(CW\*(C`name\*(C'\fR is a table and \f(CW\*(C`optional_value\*(C'\fR is a column.
.Sp
This statement is only occasionally used.
.IP "on_delete" 4
.IX Item "on_delete"
What to do when foreign key column's row dies
.IP "on_update" 4
.IX Item "on_update"
What to do when foreign key column's row changes
.IP "label" 4
.IX Item "label"
Default on-screen label for field
.Sp
This statement is virtually required.
.IP "searchable" 4
.IX Item "searchable"
Include this field in searches?
.Sp
This field is boolean, use 1 for true or 0 for false.
.IP "html_form_type" 4
.IX Item "html_form_type"
form type: text, textarea, select
.Sp
Only certain values are legal for statement.keyword statements.
Please choose from these options:
.RS 4
.IP "undefined" 4
.IX Item "undefined"
\&\-\- Choose One \*(--
.IP "text" 4
.IX Item "text"
text
.IP "textarea" 4
.IX Item "textarea"
textarea
.IP "select" 4
.IX Item "select"
select
.IP "display" 4
.IX Item "display"
display
.RE
.RS 4
.Sp
This statement is virtually required.
.RE
.IP "html_form_optional" 4
.IX Item "html_form_optional"
May user skip this field?
.Sp
This field is boolean, use 1 for true or 0 for false.
.IP "html_form_constraint" 4
.IX Item "html_form_constraint"
Data::FormValidator constraint, e.g.: 
.Sp
.Vb 1
\&    qr{^\ed$}
.Ve
.IP "html_form_default_value" 4
.IX Item "html_form_default_value"
Form element value when no other is available
.IP "html_form_cols" 4
.IX Item "html_form_cols"
cols attribute of text area
.Sp
Applies only to fields of type textarea.
.IP "html_form_rows" 4
.IX Item "html_form_rows"
rows attribute of text area
.Sp
Applies only to fields of type textarea.
.IP "html_form_display_size" 4
.IX Item "html_form_display_size"
width attribute if type is text
.Sp
Applies only to fields of type text.
.IP "html_form_class" 4
.IX Item "html_form_class"
class attribute for the form field
.Sp
Applies only to fields of type text.
.IP "html_form_hint" 4
.IX Item "html_form_hint"
form field hint
.IP "html_form_options" 4
.IX Item "html_form_options"
Choices for fields of type select 
[ignored for refers_to fields]
.Sp
Applies only to fields of type select.
.Sp
All values for html_form_options statements must be pairs like:
.Sp
.Vb 1
\&    name => its_value
.Ve
.Sp
where \f(CW\*(C`name\*(C'\fR is a label and \f(CW\*(C`its_value\*(C'\fR is a database value.
.Sp
You may supply a comma separated list of values for
html_form_options statements.
.IP "html_form_foreign" 4
.IX Item "html_form_foreign"
Display field is a foreign key
.Sp
Applies only to fields of type display.
.Sp
This field is boolean, use 1 for true or 0 for false.
.IP "html_form_onchange" 4
.IX Item "html_form_onchange"
Name of Javascript function to call on change
.Sp
Applies only to fields of type select.
.IP "date_select_text" 4
.IX Item "date_select_text"
link text for date popup window
.Sp
Applies only to fields of type text.
.IP "html_form_raw_html" 4
.IX Item "html_form_raw_html"
appears before this field's table row
.IP "non_essential" 4
.IX Item "non_essential"
Tells modeler: retrieve only when accessed
.Sp
This field is boolean, use 1 for true or 0 for false.
.Sh "join_table"
.IX Subsection "join_table"
.IP "joins" 4
.IX Item "joins"
Which tables does this one join?
.Sp
All values for joins statements must be pairs like:
.Sp
.Vb 1
\&    name => its_value
.Ve
.Sp
where \f(CW\*(C`name\*(C'\fR is a table and \f(CW\*(C`its_value\*(C'\fR is a table.
.Sp
This statement is required.
.IP "names" 4
.IX Item "names"
What should I call each has many?
.Sp
All values for names statements must be pairs like:
.Sp
.Vb 1
\&    name => its_value
.Ve
.Sp
where \f(CW\*(C`name\*(C'\fR is a has many name and \f(CW\*(C`its_value\*(C'\fR is a has many name.
.IP "data" 4
.IX Item "data"
What to \s-1INSERT\s0 \s-1INTO\s0 table upon initial creation
.Sp
All values for data statements must be pairs like:
.Sp
.Vb 1
\&    name => its_value
.Ve
.Sp
You may supply a comma separated list of values for
data statements.
.Sp
You may use multiple data statements.
.Sh "method"
.IX Subsection "method"
.IP "no_gen" 4
.IX Item "no_gen"
Skip this method completely
.Sp
Applies to all method types.
.Sp
This field is boolean, use 1 for true or 0 for false.
.IP "extra_args" 4
.IX Item "extra_args"
Extra args for any method
.Sp
Applies to methods of type: AutoCRUD_form, CRUD_form, base_links, links, main_listing, and stub.
.Sp
You may supply a comma separated list of values for
extra_args statements.
.IP "order_by" 4
.IX Item "order_by"
Exact text of \s-1SQL\s0 order by
.Sp
Applies to methods of type: main_listing.
.IP "rows" 4
.IX Item "rows"
How many rows should appear per listing page?
.Sp
Applies to methods of type: main_listing.
.Sp
This statement is frequently used.
.IP "paged_conf" 4
.IX Item "paged_conf"
Take rows per page from this (conf var) accessor
.Sp
Applies to methods of type: main_listing.
.IP "cols" 4
.IX Item "cols"
Fields to include in main_listing
.Sp
Applies to methods of type: main_listing.
.Sp
You may supply a comma separated list of values for
cols statements.
.Sp
This statement is virtually required.
.IP "col_labels" 4
.IX Item "col_labels"
Labels for fields on main_listing
[optional default uses field labels]
.Sp
Applies to methods of type: main_listing.
.Sp
You may supply a comma separated list of values for
col_labels statements.
.IP "livesearch" 4
.IX Item "livesearch"
Places a search box on results page
.Sp
Applies to methods of type: main_listing.
.Sp
This field is boolean, use 1 for true or 0 for false.
.IP "header_options" 4
.IX Item "header_options"
User actions affecting the table [like Add]
.Sp
Applies to methods of type: main_listing.
.Sp
Values for header_options statements may be individual values
or pairs like:
.Sp
.Vb 1
\&    name => optional_value
.Ve
.Sp
where \f(CW\*(C`name\*(C'\fR is a label and \f(CW\*(C`optional_value\*(C'\fR is a location.
.Sp
You may supply a comma separated list of values for
header_options statements.
.Sp
This statement is virtually required.
.IP "header_option_perms" 4
.IX Item "header_option_perms"
The table permission which controls options
Pick from create, retrieve, update, or delete
.Sp
Applies to methods of type: main_listing.
.Sp
All values for header_option_perms statements must be pairs like:
.Sp
.Vb 1
\&    name => its_value
.Ve
.Sp
where \f(CW\*(C`name\*(C'\fR is a header option label and \f(CW\*(C`its_value\*(C'\fR is a controlling permission.
.Sp
You may supply a comma separated list of values for
header_option_perms statements.
.IP "row_options" 4
.IX Item "row_options"
User actions affecting rows [like Edit]
Locations should not end with / or 
include \f(CW$id\fR
.Sp
Applies to methods of type: main_listing.
.Sp
Values for row_options statements may be individual values
or pairs like:
.Sp
.Vb 1
\&    name => optional_value
.Ve
.Sp
where \f(CW\*(C`name\*(C'\fR is a label and \f(CW\*(C`optional_value\*(C'\fR is a location.
.Sp
You may supply a comma separated list of values for
row_options statements.
.Sp
This statement is virtually required.
.IP "row_option_perms" 4
.IX Item "row_option_perms"
The table permission which controls options
Pick from create, retrieve, update, or delete
.Sp
Applies to methods of type: main_listing.
.Sp
All values for row_option_perms statements must be pairs like:
.Sp
.Vb 1
\&    name => its_value
.Ve
.Sp
where \f(CW\*(C`name\*(C'\fR is a row option label and \f(CW\*(C`its_value\*(C'\fR is a controlling permission.
.Sp
You may supply a comma separated list of values for
row_option_perms statements.
.IP "limit_by" 4
.IX Item "limit_by"
If an arg is supplied, show only matching rows
.Sp
Applies to methods of type: main_listing.
.IP "where_terms" 4
.IX Item "where_terms"
Where clause will include these equality tests
.Sp
Applies to methods of type: main_listing.
.Sp
All values for where_terms statements must be pairs like:
.Sp
.Vb 1
\&    name => its_value
.Ve
.Sp
where \f(CW\*(C`name\*(C'\fR is a table and \f(CW\*(C`its_value\*(C'\fR is a table.
.Sp
You may supply a comma separated list of values for
where_terms statements.
.IP "title" 4
.IX Item "title"
Browser title bar title for main_listing
.Sp
Applies to methods of type: base_links and main_listing.
.Sp
This statement is frequently used.
.IP "html_template" 4
.IX Item "html_template"
Template to use for main_listing
[defaults to results.tt or main.tt]
.Sp
Applies to methods of type: base_links and main_listing.
.IP "authed_methods" 4
.IX Item "authed_methods"
Controller methods that require auth
.Sp
Applies to methods of type: hashref.
.Sp
Values for authed_methods statements may be individual values
or pairs like:
.Sp
.Vb 1
\&    name => optional_value
.Ve
.Sp
where \f(CW\*(C`name\*(C'\fR is a method and \f(CW\*(C`optional_value\*(C'\fR is a group.
.Sp
You may supply a comma separated list of values for
authed_methods statements.
.IP "permissions" 4
.IX Item "permissions"
Set table permissions e.g. crudcr\*(--cr\-\-
.Sp
Applies to methods of type: hashref.
.Sp
Values for permissions statements may be individual values
or pairs like:
.Sp
.Vb 1
\&    name => optional_value
.Ve
.Sp
where \f(CW\*(C`name\*(C'\fR is a bits and \f(CW\*(C`optional_value\*(C'\fR is a group.
.IP "literal" 4
.IX Item "literal"
Supply a custom perl hashref
.Sp
Applies to methods of type: hashref.
.Sp
You may supply a comma separated list of values for
literal statements.
.IP "all_fields_but" 4
.IX Item "all_fields_but"
Fields to exclude from a form
[either all_fields_but or fields is \s-1REQUIRED\s0]
.Sp
Applies to methods of type: AutoCRUD_form and CRUD_form.
.Sp
You may supply a comma separated list of values for
all_fields_but statements.
.Sp
This statement is virtually required.
.IP "fields" 4
.IX Item "fields"
Fields to include on a form
[either all_fields_but or fields is \s-1REQUIRED\s0]
.Sp
Applies to methods of type: AutoCRUD_form and CRUD_form.
.Sp
You may supply a comma separated list of values for
fields statements.
.Sp
This statement is virtually required.
.IP "extra_keys" 4
.IX Item "extra_keys"
Extra keys to put in the form method hash
.Sp
Applies to methods of type: AutoCRUD_form and CRUD_form.
.Sp
All values for extra_keys statements must be pairs like:
.Sp
.Vb 1
\&    name => its_value
.Ve
.Sp
where \f(CW\*(C`name\*(C'\fR is a key and \f(CW\*(C`its_value\*(C'\fR is a value.
.Sp
You may supply a comma separated list of values for
extra_keys statements.
.IP "form_name" 4
.IX Item "form_name"
Form name [used with date selections]
.Sp
Applies to methods of type: AutoCRUD_form and CRUD_form.
.IP "expects" 4
.IX Item "expects"
Things your \s-1SOAP\s0 method receives
.Sp
Applies to methods of type: \s-1SOAP\s0.
.Sp
Values for expects statements may be individual values
or pairs like:
.Sp
.Vb 1
\&    name => optional_value
.Ve
.Sp
where \f(CW\*(C`name\*(C'\fR is a name and \f(CW\*(C`optional_value\*(C'\fR is a type.
.Sp
You may supply a comma separated list of values for
expects statements.
.Sp
This statement is required.
.IP "returns" 4
.IX Item "returns"
Things your \s-1SOAP\s0 method returns
.Sp
Applies to methods of type: \s-1SOAP\s0.
.Sp
Values for returns statements may be individual values
or pairs like:
.Sp
.Vb 1
\&    name => optional_value
.Ve
.Sp
where \f(CW\*(C`name\*(C'\fR is a name and \f(CW\*(C`optional_value\*(C'\fR is a type.
.Sp
You may supply a comma separated list of values for
returns statements.
.Sp
This statement is required.
.Sh "table"
.IX Subsection "table"
.IP "no_gen" 4
.IX Item "no_gen"
Skip this table completely
.Sp
This field is boolean, use 1 for true or 0 for false.
.IP "not_for" 4
.IX Item "not_for"
Tell Model and/or \s-1SQL\s0 to skip this table
.Sp
Only certain values are legal for statement.keyword statements.
Please choose from these options:
.RS 4
.IP "\s-1SQL\s0" 4
.IX Item "SQL"
\&\s-1SQL\s0
.IP "Model" 4
.IX Item "Model"
Model
.RE
.RS 4
.Sp
You may supply a comma separated list of values for
not_for statements.
.RE
.IP "foreign_display" 4
.IX Item "foreign_display"
Pattern string for other tables: \f(CW%last\fR, \f(CW%first\fR
.Sp
This statement is frequently used.
.IP "refered_to_by" 4
.IX Item "refered_to_by"
Table has many rows from this other table
.Sp
Values for refered_to_by statements may be individual values
or pairs like:
.Sp
.Vb 1
\&    name => optional_value
.Ve
.Sp
where \f(CW\*(C`name\*(C'\fR is a foreign table and \f(CW\*(C`optional_value\*(C'\fR is a name of has many.
.Sp
You may supply a comma separated list of values for
refered_to_by statements.
.IP "model_base_class" 4
.IX Item "model_base_class"
Models inherit from this [has good default]
.IP "sequence" 4
.IX Item "sequence"
Which sequence to take default keys from
.Sp
This statement is only occasionally used.
.IP "data" 4
.IX Item "data"
What to \s-1INSERT\s0 \s-1INTO\s0 table upon initial creation
.Sp
Values for data statements may be individual values
or pairs like:
.Sp
.Vb 1
\&    name => optional_value
.Ve
.Sp
You may supply a comma separated list of values for
data statements.
.Sp
You may use multiple data statements.
.SH "AUTHOR"
.IX Header "AUTHOR"
The skip/podsyntax script generated this file Tue Aug 14 17:16:34 2007.
The script was written by Phil Crow <crow.phil\e@gmail.com>.
.SH "COPYRIGHT and LICENSE"
.IX Header "COPYRIGHT and LICENSE"
Copyright (C) 2007 by Phil Crow
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.6 or,
at your option, any later version of Perl 5 you may have available.
.PP
But keep in mind that it was generated.  Make modifications to the
generting script.