Bigtop::Docs::FullKeywords - Descriptions of all Bigtop keywords
This document is generated from 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 Bigtop::Docs::Syntax for a general description of Bigtop source file structure. See also Bigtop::Docs::TentTut, which -- like this file -- draws from Bigtop::Keywords. You might also find Bigtop::Docs::Cookbook useful.
Bigtop::Docs::Keywords
Bigtop::Docs::Syntax
Bigtop::Docs::TentTut
Bigtop::Keywords
Bigtop::Docs::Cookbook
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.
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.
These keywords appear at the top level of the app block.
Literals are not blocks and do not have statements like blocks. They have this form:
literal type `whatever string you like`;
where literal introduces the literal and type is one of the app_literal keywords listed below. So, for these 'keyword' should really be called 'type.'
literal
type
app_literal
Just like app_literals, but appearing inside controller blocks.
These keywords appear at the top level of table blocks, which in turn appear at the top level of the app block.
These keywords appear at the top level of join_table blocks, which appear at top level of the app block.
These keywords appear in field blocks, which in turn appear inside table or join_table blocks.
These keywords appear in controller blocks, which are at the top level of the app block.
These keywords appear in method blocks, which appear inside controller blocks.
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).
Skip this app completely
This field is boolean, use 1 for true or 0 for false.
Base Location of the app [defaults to /] Do not use if you have a Base Controller.
Who to blame for the app
Values for authors statements may be individual values or pairs like:
name => optional_value
where name is a name and optional_value is a email address.
name
optional_value
You may supply a comma separated list of values for authors statements.
This statement is only occasionally used.
How to send complaints or join the project
Who owns the app [defaults to 1st author]
You may supply a comma separated list of values for copyright_holder statements.
Restrictions [defaults to Perl license]
List of modules used by base module Do not use if you have a Base Controller.
You may supply a comma separated list of values for uses statements.
Documentation label for app
DEPRECATED
Where to send complaints (think mailing list)
top level of Gantry::Conf file
immediately after shebang line in httpd.conf <Perl> block and in the CGI scripts
in the httpd.conf <Perl> block (in order with controllers)
between location directives in httpd.conf
in the base Location directive for the app
dumped directly into all schemas
mod_perl 1.3, mod_perl 2.0, CGI, etc.
Only certain values are legal for statement.keyword statements. Please choose from these options:
mod_perl 1.3
mod_perl 2.0
CGI/FastCGI
Template Toolkit, Mason, etc.
Template Toolkit
No Templating
List of Plugins i.e. AuthCookie Static
parent of build dir
build dir. relative to parent dir
Skip this controller completely
Applies to all controller types.
Absolute Location of this controller [non-base controllers must have either a location or a rel_location.]
This statement is virtually required.
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.
Table this controller manages
List of modules used in gen module use list ex: qw( :default )
Values for gen_uses statements may be individual values or pairs like:
where name is a module and optional_value is a literal use list.
You may supply a comma separated list of values for gen_uses statements.
List of modules used in stub module
Values for stub_uses statements may be individual values or pairs like:
You may supply a comma separated list of values for stub_uses statements.
List of modules used by gen and stub modules
Values for uses statements may be individual values or pairs like:
List of plugins used by gen module
You may supply a comma separated list of values for plugins statements.
Required for Gantry's AutoCRUD
Applies to controllers of type: AutoCRUD and base_controller.
This statement is frequently used.
Link text in navigation bar [use only for navigable controllers]
Gantry::Plugins::AutoCRUDHelper for your ORM
Skip default page hit test of this controller
Base of all WSDL names
Applies to controllers of type: SOAP and SOAPDoc.
This statement is required.
Base URL of WSDL namespace including domain
in Location block for this controller
in GantryLocation block for this controller
Literal SQL, use bind parameters, see below.
What your SQL needs for positional binding. [optional, omit if you have no bound parameters]
Values for expects statements may be individual values or pairs like:
where name is a name and optional_value is a type.
You may supply a comma separated list of values for expects statements.
Names of columns in SQL output. [optional, omit if you expect no returned rows]
Values for returns statements may be individual values or pairs like:
You may supply a comma separated list of values for returns statements.
Skip this field completely
Tell Model and/or SQL to skip this field
SQL
Model
You may supply a comma separated list of values for not_for statements.
SQL type clause phrases, e.g.:
int4 varchar primary_key auto
You may supply a comma separated list of values for is statements.
DBIx::Class alternate accessor name for this column
You may supply a comma separated list of values for accessor statements.
DBIx::Class alternate column addition
All values for add_columns statements must be pairs like:
name => its_value
where name is a key and its_value is a value.
its_value
You may supply a comma separated list of values for add_columns statements.
Where this foreign key points
Values for refers_to statements may be individual values or pairs like:
where name is a table and optional_value is a column.
Where this column usually points
Values for quasi_refers_to statements may be individual values or pairs like:
What to do when foreign key column's row dies
What to do when foreign key column's row changes
Default on-screen label for field
Include this field in searches?
form type: text, textarea, select
-- Choose One --
text
textarea
select
display
May user skip this field?
Data::FormValidator constraint, e.g.:
qr{^\d$}
Form element value when no other is available
cols attribute of text area
Applies only to fields of type textarea.
rows attribute of text area
width attribute if type is text
Applies only to fields of type text.
class attribute for the form field
form field hint
Choices for fields of type select [ignored for refers_to fields]
Applies only to fields of type select.
All values for html_form_options statements must be pairs like:
where name is a label and its_value is a database value.
You may supply a comma separated list of values for html_form_options statements.
Display field is a foreign key
Applies only to fields of type display.
Name of Javascript function to call on change
Name of fieldset to group this field into
link text for date popup window
appears before this field's table row
Tells modeler: retrieve only when accessed
This is the definition for a pseudo field. By defining it, you're declaring the field as a pseudo field
Declare this field as unique, and use the value for the constraint name
Which tables does this one join?
All values for joins statements must be pairs like:
where name is a table and its_value is a table.
What should I call each has many?
All values for names statements must be pairs like:
where name is a has many name and its_value is a has many name.
What to INSERT INTO table upon initial creation
All values for data statements must be pairs like:
You may supply a comma separated list of values for data statements.
You may use multiple data statements.
Skip this method completely
Applies to all method types.
Extra args for any method
Applies to methods of type: AutoCRUD_form, CRUD_form, base_links, links, main_listing, and stub.
You may supply a comma separated list of values for extra_args statements.
Exact text of SQL order by
Applies to methods of type: main_listing.
How many rows should appear per listing page?
Take rows per page from this (conf var) accessor
Fields to include in main_listing
You may supply a comma separated list of values for cols statements.
Labels for fields on main_listing [optional default uses field labels]
You may supply a comma separated list of values for col_labels statements.
Pseudo Fields to include in main_listing
You may supply a comma separated list of values for pseudo_cols statements.
Places a search box on results page
User actions affecting the table [like Add]
Values for header_options statements may be individual values or pairs like:
where name is a label and optional_value is a location.
You may supply a comma separated list of values for header_options statements.
The table permission which controls options Pick from create, retrieve, update, or delete
All values for header_option_perms statements must be pairs like:
where name is a header option label and its_value is a controlling permission.
You may supply a comma separated list of values for header_option_perms statements.
User actions affecting rows [like Edit] Locations should not end with / or include $id
Values for row_options statements may be individual values or pairs like:
You may supply a comma separated list of values for row_options statements.
All values for row_option_perms statements must be pairs like:
where name is a row option label and its_value is a controlling permission.
You may supply a comma separated list of values for row_option_perms statements.
If an arg is supplied, show only matching rows
Where clause will include these equality tests
All values for where_terms statements must be pairs like:
You may supply a comma separated list of values for where_terms statements.
Browser title bar title for main_listing
Applies to methods of type: base_links and main_listing.
Template to use for main_listing [defaults to results.tt or main.tt]
Controller methods that require auth
Applies to methods of type: hashref.
Values for authed_methods statements may be individual values or pairs like:
where name is a method and optional_value is a group.
You may supply a comma separated list of values for authed_methods statements.
Set table permissions e.g. crudcr--cr--
Values for permissions statements may be individual values or pairs like:
where name is a bits and optional_value is a group.
Supply a custom perl hashref
You may supply a comma separated list of values for literal statements.
Fields to exclude from a form [either all_fields_but or fields is REQUIRED]
Applies to methods of type: AutoCRUD_form and CRUD_form.
You may supply a comma separated list of values for all_fields_but statements.
Fields to include on a form [either all_fields_but or fields is REQUIRED]
You may supply a comma separated list of values for fields statements.
Extra keys to put in the form method hash
All values for extra_keys statements must be pairs like:
You may supply a comma separated list of values for extra_keys statements.
Form name [used with date selections]
Things your SOAP method receives
Applies to methods of type: SOAP and SOAPDoc.
Things your SOAP method returns
Skip this table completely
Tell Model and/or SQL to skip this table
Pattern string for other tables: %last, %first
Table has many rows from this other table
Values for refered_to_by statements may be individual values or pairs like:
where name is a foreign table and optional_value is a name of has many.
You may supply a comma separated list of values for refered_to_by statements.
Models inherit from this [has good default]
Which sequence to take default keys from
Documentation label for table
Values for data statements may be individual values or pairs like:
The skip/podsyntax script generated this file Sat Jul 10 17:04:08 2010. The script was written by Phil Crow <crow.phil\@gmail.com>.
Copyright (C) 2007 by Phil Crow
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.
But keep in mind that it was generated. Make modifications to the generting script.
To install Bigtop, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Bigtop
CPAN shell
perl -MCPAN -e shell install Bigtop
For more information on module installation, please visit the detailed CPAN module installation guide.