view release on metacpan or  search on metacpan

lib/Bigtop/Docs/FullKeywords.pod  view on Meta::CPAN

=head1 NAME

Bigtop::Docs::FullKeywords - Descriptions of all Bigtop keywords

=head1 Intro

This document is generated from C<Bigtop::Docs::Keywords>.  It lists
each supported keyword available in the Bigtop language, just as tentmaker
would, but in POD form.  See the beginning of C<Bigtop::Docs::Syntax>
for a general description of Bigtop source file structure.  See
also C<Bigtop::Docs::TentTut>, which -- like this file -- draws from
C<Bigtop::Keywords>.  You might also find C<Bigtop::Docs::Cookbook> useful.

=head1 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.

=over 4

=item config

These keywords appear in the Bigtop config block that begins each bigtop
file.

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.

=item app

These keywords appear at the top level of the app block.

=item app_literal

Literals are not blocks and do not have statements like blocks.  They have
this form:

    literal type `whatever string you like`;

where C<literal> introduces the literal and C<type> is one of the
C<app_literal> keywords listed below.  So, for these 'keyword' should
really be called 'type.'

=item controller_literal

Just like app_literals, but appearing inside controller blocks.

=item table

These keywords appear at the top level of table blocks, which in turn
appear at the top level of the app block.

=item join_table

These keywords appear at the top level of join_table blocks, which appear
at top level of the app block.

=item field

These keywords appear in field blocks, which in turn appear inside table
or join_table blocks.

=item controller

These keywords appear in controller blocks, which are at the top level of
the app block.

=item method

lib/Bigtop/Docs/FullKeywords.pod  view on Meta::CPAN

=item SQL

dumped directly into all schemas


=back

=head2 config

=over 4

=item engine

mod_perl 1.3, mod_perl 2.0, CGI, etc.


Only certain values are legal for statement.keyword statements.
Please choose from these options:

=over 4

=item MP13

mod_perl 1.3

=item MP20

mod_perl 2.0

=item CGI

CGI/FastCGI


=back

=item template_engine

Template Toolkit, Mason, etc.


Only certain values are legal for statement.keyword statements.
Please choose from these options:

=over 4

=item TT

Template Toolkit

=item Default

No Templating


=back

=item plugins

List of Plugins i.e. AuthCookie Static


=item base_dir

DEPRECATED


parent of build dir


=item app_dir

DEPRECATED


build dir. relative to parent dir


=back

=head2 controller

=over 4

=item no_gen

Skip this controller completely


Applies to all controller types.


This field is boolean, use 1 for true or 0 for false.


=item location

Absolute Location of this controller [non-base controllers
must have either a location or a rel_location.]


Applies to all controller types.


This statement is virtually required.

=item rel_location

Location of this controller relative to app location
[non-base controllers must have location or rel_location.]

Applies to controllers of type: AutoCRUD, CRUD, SOAP, SOAPDoc, and stub.


This statement is virtually required.

=item controls_table

Table this controller manages