.\" 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::QuickKeywords 3" .TH Bigtop::Docs::QuickKeywords 3 "2008-01-18" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" Bigtop::Docs::QuickKeywords \- Short descriptions of all Bigtop keywords .SH "Intro" .IX Header "Intro" This document is generated from \f(CW\*(C`Bigtop::Docs::Keywords\*(C'\fR. It is designed to be compact. See \f(CW\*(C`Bigtop::Docs::FullKeywords\*(C'\fR for more details. See \f(CW\*(C`Bigtop::Docs::TOC\*(C'\fR for an annotated list of all doc files. .PP .Vb 7 \& config {} \& engine - mod_perl 1.3, mod_perl 2.0, CGI, etc. \& template_engine - Template Toolkit, Mason, etc. \& plugins - List of Plugins i.e. AuthCookie Static \& Example Backend Block: \& SQL SQLite {} \& See Bigtop::Docs::Backends for the backends whose blocks can go here. .Ve .PP .Vb 10 \& app name {} \& no_gen - Skip this app completely \& location - Base Location of the app [defaults to /] \& Do not use if you have a Base Controller. \& authors - Who to blame for the app \& contact_us - How to send complaints or join the project \& copyright_holder - Who owns the app [defaults to 1st author] \& license_text - Restrictions [defaults to Perl license] \& uses - List of modules used by base module \& Do not use if you have a Base Controller. .Ve .PP .Vb 7 \& config {} \& any_keyword its_value; - creates: \& (1) config variable value pair in Gantry::Conf (or moral equiv.) \& (2) a statement to retrieve the set var in the base init method, \& (3) an accessor in the base module \& OR \& key value => no_accessor; - just does #1 from above .Ve .PP .Vb 8 \& literal Conf `...`; - top level of Gantry::Conf file \& literal PerlTop `...`; - immediately after shebang line in httpd.conf \& block and in the CGI scripts \& literal PerlBlock `...`; - in the httpd.conf block (in order \& with controllers) \& literal HttpdConf `...`; - between location directives in httpd.conf \& literal Location `...`; - in the base Location directive for the app \& literal SQL `...`; - dumped directly into all schemas .Ve .PP .Vb 34 \& table name {} \& no_gen - Skip this table completely \& not_for - Tell Model and/or SQL to skip this table \& foreign_display - Pattern string for other tables: %last, %first \& refered_to_by - Table has many rows from this other table \& model_base_class - Models inherit from this [has good default] \& sequence - Which sequence to take default keys from \& data - What to INSERT INTO table upon initial creation \& field name {} \& no_gen - Skip this field completely \& not_for - Tell Model and/or SQL to skip this field \& is - SQL type clause phrases, e.g.:int4, varchar, primary_key, auto \& accessor - DBIx::Class alternate accessor name for this column \& refers_to - Where this foreign key points \& 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 \& searchable - Include this field in searches? \& html_form_type - form type: text, textarea, select \& html_form_optional - May user skip this field? \& html_form_constraint - Data::FormValidator constraint, e.g.: qr{^\ed$} \& html_form_default_value - Form element value when no other is available \& html_form_cols - cols attribute of text area \& html_form_rows - rows attribute of text area \& html_form_display_size - width attribute if type is text \& html_form_class - class attribute for the form field \& html_form_hint - form field hint \& html_form_options - Choices for fields of type select \& [ignored for refers_to fields] \& html_form_foreign - Display field is a foreign key \& html_form_onchange - Name of Javascript function to call on change \& date_select_text - link text for date popup window \& html_form_raw_html - appears before this field's table row \& non_essential - Tells modeler: retrieve only when accessed .Ve .PP .Vb 5 \& join_table name {} \& joins - Which tables does this one join? \& names - What should I call each has many? \& data - What to INSERT INTO table upon initial creation \& fields as for regular tables .Ve .PP .Vb 22 \& controller name is [type] {} type defaults to stub \& no_gen - Skip this controller completely \& location - Absolute Location of this controller [non-base controllers \& must have either a location or a rel_location.] \& rel_location - Location of this controller relative to app location \& [non-base controllers must have location or rel_location.] \& controls_table - Table this controller manages \& gen_uses - List of modules used in gen module \& use list ex: qw( :default ) \& stub_uses - List of modules used in stub module \& uses - List of modules used by gen and stub modules \& plugins - List of plugins used by gen module \& text_description - Required for Gantry's AutoCRUD \& page_link_label - Link text in navigation bar \& [use only for navigable controllers] \& autocrud_helper - Gantry::Plugins::AutoCRUDHelper for your ORM \& skip_test - Skip default page hit test of this controller \& soap_name - Base of all WSDL names \& namespace_base - Base URL of WSDL namespace including domain \& config [name] {} same as at app level, but overrides it for one controller \& literal Location `...`; - in Location block for this controller \& literal GantryLocation `...`; - in GantryLocation block for this controller .Ve .PP .Vb 5 \& There are three types with meaning (saying 'is stub' does nothing): \& AutoCRUD - adds Gantry::Plugins::AutoCRUD to your uses list \& CRUD - adds Gantry::Plugins::CRUD to your uses list \& generates various helper code for using CRUD in the stub \& base_controller - governs the app's main module (and its GEN partner) .Ve .PP .Vb 42 \& method name is type {} \& Types: \& all \& no_gen - Skip this method completely \& all but SOAP \& extra_args - Extra args for any method \& main listing \& order_by - Exact text of SQL order by \& rows - How many rows should appear per listing page? \& paged_conf - Take rows per page from this (conf var) accessor \& cols - Fields to include in main_listing \& col_labels - Labels for fields on main_listing \& [optional default uses field labels] \& livesearch - Places a search box on results page \& header_options - User actions affecting the table [like Add] \& header_option_perms - The table permission which controls options \& Pick from create, retrieve, update, or delete \& row_options - User actions affecting rows [like Edit] \& Locations should not end with / or \& include $id \& row_option_perms - The table permission which controls options \& Pick from create, retrieve, update, or delete \& limit_by - If an arg is supplied, show only matching rows \& where_terms - Where clause will include these equality tests \& main listing and links \& title - Browser title bar title for main_listing \& html_template - Template to use for main_listing \& [defaults to results.tt or main.tt] \& hashref \& authed_methods - Controller methods that require auth \& permissions - Set table permissions e.g. crudcr--cr-- \& literal - Supply a custom perl hashref \& form \& all_fields_but - Fields to exclude from a form \& [either all_fields_but or fields is REQUIRED] \& fields - Fields to include on a form \& [either all_fields_but or fields is REQUIRED] \& extra_keys - Extra keys to put in the form method hash \& form_name - Form name [used with date selections] \& SOAP \& expects - Things your SOAP method receives \& returns - Things your SOAP method returns .Ve .SH "AUTHOR" .IX Header "AUTHOR" The skip/keywords script generated this file Tue Aug 14 17:16:34 2007. The script was written by Phil Crow . .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.