Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Bigtop::Docs::FullKeywUser(Contributed Perl DocumBigtop::Docs::FullKeywords(3)

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

Intro
       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.

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.

       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.

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

       app_literal
	   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.'

       controller_literal
	   Just	like app_literals, but appearing inside	controller blocks.

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

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

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

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

       method
	   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).

   app
       no_gen
	   Skip	this app completely

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

       location
	   Base	Location of the	app [defaults to /] Do not use if you have a
	   Base	Controller.

       authors
	   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.

	   You may supply a comma separated list of values for authors
	   statements.

	   This	statement is only occasionally used.

       contact_us
	   How to send complaints or join the project

       copyright_holder
	   Who owns the	app [defaults to 1st author]

	   You may supply a comma separated list of values for
	   copyright_holder statements.

       license_text
	   Restrictions	[defaults to Perl license]

       uses
	   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.

       label
	   Documentation label for app

       email
	   DEPRECATED

	   Where to send complaints (think mailing list)

   app_literal
       Conf
	   top level of	Gantry::Conf file

       PerlTop
	   immediately after shebang line in httpd.conf	<Perl> block and in
	   the CGI scripts

       PerlBlock
	   in the httpd.conf <Perl> block (in order with controllers)

       HttpdConf
	   between location directives in httpd.conf

       Location
	   in the base Location	directive for the app

       SQL dumped directly into	all schemas

   config
       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:

	   MP13
	       mod_perl	1.3

	   MP20
	       mod_perl	2.0

	   CGI CGI/FastCGI

       template_engine
	   Template Toolkit, Mason, etc.

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

	   TT  Template	Toolkit

	   Default
	       No Templating

       plugins
	   List	of Plugins i.e.	AuthCookie Static

       base_dir
	   DEPRECATED

	   parent of build dir

       app_dir
	   DEPRECATED

	   build dir. relative to parent dir

   controller
       no_gen
	   Skip	this controller	completely

	   Applies to all controller types.

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

       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.

       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.

       controls_table
	   Table this controller manages

	   Applies to all controller types.

	   This	statement is virtually required.

       gen_uses
	   List	of modules used	in gen module use list ex: qw( :default	)

	   Applies to all controller types.

	   Values for gen_uses statements may be individual values or pairs
	   like:

	       name => optional_value

	   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.

       stub_uses
	   List	of modules used	in stub	module

	   Applies to all controller types.

	   Values for stub_uses	statements may be individual values or pairs
	   like:

	       name => optional_value

	   where "name"	is a module and	"optional_value" is a literal use
	   list.

	   You may supply a comma separated list of values for stub_uses
	   statements.

       uses
	   List	of modules used	by gen and stub	modules

	   Applies to all controller types.

	   Values for uses statements may be individual	values or pairs	like:

	       name => optional_value

	   where "name"	is a module and	"optional_value" is a literal use
	   list.

	   You may supply a comma separated list of values for uses
	   statements.

       plugins
	   List	of plugins used	by gen module

	   Applies to all controller types.

	   You may supply a comma separated list of values for plugins
	   statements.

       text_description
	   Required for	Gantry's AutoCRUD

	   Applies to controllers of type: AutoCRUD and	base_controller.

	   This	statement is frequently	used.

       page_link_label
	   Link	text in	navigation bar [use only for navigable controllers]

	   Applies to all controller types.

	   This	statement is frequently	used.

       autocrud_helper
	   Gantry::Plugins::AutoCRUDHelper for your ORM

	   Applies to controllers of type: AutoCRUD and	base_controller.

       skip_test
	   Skip	default	page hit test of this controller

	   Applies to all controller types.

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

       soap_name
	   Base	of all WSDL names

	   Applies to controllers of type: SOAP	and SOAPDoc.

	   This	statement is required.

       namespace_base
	   Base	URL of WSDL namespace including	domain

	   Applies to controllers of type: SOAP	and SOAPDoc.

	   This	statement is required.

   controller_literal
       Location
	   in Location block for this controller

       GantryLocation
	   in GantryLocation block for this controller

   extra_sql
       sql Literal SQL,	use bind parameters, see below.

	   This	statement is required.

       expects
	   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:

	       name => optional_value

	   where "name"	is a name and "optional_value" is a type.

	   You may supply a comma separated list of values for expects
	   statements.

	   This	statement is virtually required.

       returns
	   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:

	       name => optional_value

	   where "name"	is a name and "optional_value" is a type.

	   You may supply a comma separated list of values for returns
	   statements.

	   This	statement is virtually required.

   field
       no_gen
	   Skip	this field completely

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

       not_for
	   Tell	Model and/or SQL to skip this field

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

	   SQL SQL

	   Model
	       Model

	   You may supply a comma separated list of values for not_for
	   statements.

       is  SQL type clause phrases, e.g.:

	       int4
	       varchar
	       primary_key
	       auto

	   You may supply a comma separated list of values for is statements.

	   This	statement is required.

       accessor
	   DBIx::Class alternate accessor name for this	column

	   You may supply a comma separated list of values for accessor
	   statements.

       add_columns
	   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.

	   You may supply a comma separated list of values for add_columns
	   statements.

       refers_to
	   Where this foreign key points

	   Values for refers_to	statements may be individual values or pairs
	   like:

	       name => optional_value

	   where "name"	is a table and "optional_value"	is a column.

	   This	statement is only occasionally used.

       quasi_refers_to
	   Where this column usually points

	   Values for quasi_refers_to statements may be	individual values or
	   pairs like:

	       name => optional_value

	   where "name"	is a table and "optional_value"	is a column.

       on_delete
	   What	to do when foreign key column's	row dies

       on_update
	   What	to do when foreign key column's	row changes

       label
	   Default on-screen label for field

	   This	statement is virtually required.

       searchable
	   Include this	field in searches?

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

       html_form_type
	   form	type: text, textarea, select

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

	   undefined
	       -- Choose One --

	   text
	       text

	   textarea
	       textarea

	   select
	       select

	   display
	       display

	   This	statement is virtually required.

       html_form_optional
	   May user skip this field?

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

       html_form_constraint
	   Data::FormValidator constraint, e.g.:

	       qr{^\d$}

       html_form_default_value
	   Form	element	value when no other is available

       html_form_cols
	   cols	attribute of text area

	   Applies only	to fields of type textarea.

       html_form_rows
	   rows	attribute of text area

	   Applies only	to fields of type textarea.

       html_form_display_size
	   width attribute if type is text

	   Applies only	to fields of type text.

       html_form_class
	   class attribute for the form	field

	   Applies only	to fields of type text.

       html_form_hint
	   form	field hint

       html_form_options
	   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:

	       name => its_value

	   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.

       html_form_foreign
	   Display field is a foreign key

	   Applies only	to fields of type display.

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

       html_form_onchange
	   Name	of Javascript function to call on change

	   Applies only	to fields of type select.

       html_form_fieldset
	   Name	of fieldset to group this field	into

       date_select_text
	   link	text for date popup window

	   Applies only	to fields of type text.

       html_form_raw_html
	   appears before this field's table row

       non_essential
	   Tells modeler: retrieve only	when accessed

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

       pseudo_value
	   This	is the definition for a	pseudo field. By defining it, you're
	   declaring the field as a pseudo field

       unique_name
	   Declare this	field as unique, and use the value for the constraint
	   name

   join_table
       joins
	   Which tables	does this one join?

	   All values for joins	statements must	be pairs like:

	       name => its_value

	   where "name"	is a table and "its_value" is a	table.

	   This	statement is required.

       names
	   What	should I call each has many?

	   All values for names	statements must	be pairs like:

	       name => its_value

	   where "name"	is a has many name and "its_value" is a	has many name.

       data
	   What	to INSERT INTO table upon initial creation

	   All values for data statements must be pairs	like:

	       name => its_value

	   You may supply a comma separated list of values for data
	   statements.

	   You may use multiple	data statements.

   method
       no_gen
	   Skip	this method completely

	   Applies to all method types.

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

       extra_args
	   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.

       order_by
	   Exact text of SQL order by

	   Applies to methods of type: main_listing.

       rows
	   How many rows should	appear per listing page?

	   Applies to methods of type: main_listing.

	   This	statement is frequently	used.

       paged_conf
	   Take	rows per page from this	(conf var) accessor

	   Applies to methods of type: main_listing.

       cols
	   Fields to include in	main_listing

	   Applies to methods of type: main_listing.

	   You may supply a comma separated list of values for cols
	   statements.

	   This	statement is virtually required.

       col_labels
	   Labels for fields on	main_listing [optional default uses field
	   labels]

	   Applies to methods of type: main_listing.

	   You may supply a comma separated list of values for col_labels
	   statements.

       pseudo_cols
	   Pseudo Fields to include in main_listing

	   Applies to methods of type: main_listing.

	   You may supply a comma separated list of values for pseudo_cols
	   statements.

	   This	statement is virtually required.

       livesearch
	   Places a search box on results page

	   Applies to methods of type: main_listing.

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

       header_options
	   User	actions	affecting the table [like Add]

	   Applies to methods of type: main_listing.

	   Values for header_options statements	may be individual values or
	   pairs like:

	       name => optional_value

	   where "name"	is a label and "optional_value"	is a location.

	   You may supply a comma separated list of values for header_options
	   statements.

	   This	statement is virtually required.

       header_option_perms
	   The table permission	which controls options Pick from create,
	   retrieve, update, or	delete

	   Applies to methods of type: main_listing.

	   All values for header_option_perms statements must be pairs like:

	       name => its_value

	   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.

       row_options
	   User	actions	affecting rows [like Edit] Locations should not	end
	   with	/ or include $id

	   Applies to methods of type: main_listing.

	   Values for row_options statements may be individual values or pairs
	   like:

	       name => optional_value

	   where "name"	is a label and "optional_value"	is a location.

	   You may supply a comma separated list of values for row_options
	   statements.

	   This	statement is virtually required.

       row_option_perms
	   The table permission	which controls options Pick from create,
	   retrieve, update, or	delete

	   Applies to methods of type: main_listing.

	   All values for row_option_perms statements must be pairs like:

	       name => its_value

	   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.

       limit_by
	   If an arg is	supplied, show only matching rows

	   Applies to methods of type: main_listing.

       where_terms
	   Where clause	will include these equality tests

	   Applies to methods of type: main_listing.

	   All values for where_terms statements must be pairs like:

	       name => its_value

	   where "name"	is a table and "its_value" is a	table.

	   You may supply a comma separated list of values for where_terms
	   statements.

       title
	   Browser title bar title for main_listing

	   Applies to methods of type: base_links and main_listing.

	   This	statement is frequently	used.

       html_template
	   Template to use for main_listing [defaults to results.tt or
	   main.tt]

	   Applies to methods of type: base_links and main_listing.

       authed_methods
	   Controller methods that require auth

	   Applies to methods of type: hashref.

	   Values for authed_methods statements	may be individual values or
	   pairs like:

	       name => optional_value

	   where "name"	is a method and	"optional_value" is a group.

	   You may supply a comma separated list of values for authed_methods
	   statements.

       permissions
	   Set table permissions e.g. crudcr--cr--

	   Applies to methods of type: hashref.

	   Values for permissions statements may be individual values or pairs
	   like:

	       name => optional_value

	   where "name"	is a bits and "optional_value" is a group.

       literal
	   Supply a custom perl	hashref

	   Applies to methods of type: hashref.

	   You may supply a comma separated list of values for literal
	   statements.

       all_fields_but
	   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.

	   This	statement is virtually required.

       fields
	   Fields to include on	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 fields
	   statements.

	   This	statement is virtually required.

       extra_keys
	   Extra keys to put in	the form method	hash

	   Applies to methods of type: AutoCRUD_form and CRUD_form.

	   All values for extra_keys statements	must be	pairs like:

	       name => its_value

	   where "name"	is a key and "its_value" is a value.

	   You may supply a comma separated list of values for extra_keys
	   statements.

       form_name
	   Form	name [used with	date selections]

	   Applies to methods of type: AutoCRUD_form and CRUD_form.

       expects
	   Things your SOAP method receives

	   Applies to methods of type: SOAP and	SOAPDoc.

	   Values for expects statements may be	individual values or pairs
	   like:

	       name => optional_value

	   where "name"	is a name and "optional_value" is a type.

	   You may supply a comma separated list of values for expects
	   statements.

	   This	statement is required.

       returns
	   Things your SOAP method returns

	   Applies to methods of type: SOAP and	SOAPDoc.

	   Values for returns statements may be	individual values or pairs
	   like:

	       name => optional_value

	   where "name"	is a name and "optional_value" is a type.

	   You may supply a comma separated list of values for returns
	   statements.

	   This	statement is required.

   table
       no_gen
	   Skip	this table completely

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

       not_for
	   Tell	Model and/or SQL to skip this table

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

	   SQL SQL

	   Model
	       Model

	   You may supply a comma separated list of values for not_for
	   statements.

       foreign_display
	   Pattern string for other tables: %last, %first

	   This	statement is frequently	used.

       refered_to_by
	   Table has many rows from this other table

	   Values for refered_to_by statements may be individual values	or
	   pairs like:

	       name => optional_value

	   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.

       model_base_class
	   Models inherit from this [has good default]

       sequence
	   Which sequence to take default keys from

	   This	statement is only occasionally used.

       label
	   Documentation label for table

       data
	   What	to INSERT INTO table upon initial creation

	   Values for data statements may be individual	values or pairs	like:

	       name => optional_value

	   You may supply a comma separated list of values for data
	   statements.

	   You may use multiple	data statements.

AUTHOR
       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 and LICENSE
       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.

perl v5.24.1			  2017-07-03	 Bigtop::Docs::FullKeywords(3)

NAME | Intro | Categories | AUTHOR | COPYRIGHT and LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Bigtop::Docs::FullKeywords&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help