X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FManual%2FPlugins.pod;h=17b4e33428564196ec10d756d238d58c4951ff3f;hb=e8af4edb30efce91f190c54a016bc2a96a9c2465;hp=037fa0cee2f77355608f7ec1ec4ea180ecc82a8a;hpb=4911f47ae3636f9fa6b9933dcb11a4e3e5a3f050;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Manual/Plugins.pod b/lib/Catalyst/Manual/Plugins.pod index 037fa0c..17b4e33 100644 --- a/lib/Catalyst/Manual/Plugins.pod +++ b/lib/Catalyst/Manual/Plugins.pod @@ -4,111 +4,205 @@ Catalyst::Manual::Plugins - Catalyst Plugins (and Components) =head1 DESCRIPTION -This section lists the some of the plugins and components that are -available to extend the runtime functionality of the Catalyst. The -plugins are not distributed with Catalyst but should be available from -CPAN. They mostly required additional modules from CPAN. +This section lists the some of the plugins and components that are +available to extend the runtime functionality of Catalyst. The plugins +are not distributed with Catalyst but should be available from CPAN. +They typically require additional modules from CPAN. We will try to +keep this document up to date, but please check CPAN directly for +the latest and greatest. =head1 PLUGINS =head2 Catalyst::Plugin::Authentication::CDBI -This is a CDBI (C) authentication plugin. Note that it -requires a session plugin. +L is a CDBI (C) +authentication plugin. Note that it requires a session plugin. + +=head2 Catalyst::Plugin::Authentication::LDAP + +L is a plugin allowing you +to authenticate your web users using an LDAP server. =head2 Catalyst::Plugin::Email -Send emails with Catalyst and L and -L. +L sends email with Catalyst and L +and L. + +=head2 Catalyst::Plugin::Browser + +L extends L by adding the +capability of browser detection. It returns an instance of +L, which lets you get information from the client's +user agent. + +=head2 Catalyst::Plugin::Compress::Zlib + +L supplies Zlib compression for +Catalyst. + +=head2 Catalyst::Plugin::Compress::Bzip2 + +L compresses a response using +bzip compression. =head2 Catalyst::Plugin::FillInForm -Fill-in form plugin for Catalyst based on C, which -describes itself as a module to automatically insert data from a -previous HTML form into the HTML input, textarea, radio buttons, -checkboxes and select tags. -C is a subclass of C and uses it to -parse the HTML and insert the values into the form tags. +L is plugin for Catalyst based on +C, which describes itself as a module to automatically +insert data from a previous HTML form into the HTML input, textarea, +radio buttons, checkboxes, and select tags. C is a +subclass of C and uses it to parse the HTML and insert the +values into the form tags. =head2 Catalyst::Plugin::FormValidator -A form validator plugin that uses L to validate -and set up form data from your request parameters. It's a quite thin -wrapper around that module, so most of the relevant information can be -found there. +L is a form validator plugin that uses +L to validate and set up form data from your +request parameters. It's a quite thin wrapper around that module, so +most of the relevant information can be found there. + +=head2 Catalyst::Plugin::Geography +L allows you to retrieve various kinds +of geographical information. You can retrieve the country or code from +the current user, from a given IP address, or from a given hostname. =head2 Catalyst::Plugin::I18N -An internationalization plugin for Catalyst. Supports C/C -files and Maketext classes under your applications I18N namespace. +L is an internationalization plugin for +Catalyst. Supports C/C files and Maketext classes under your +application's I18N namespace. + +=head2 Catalyst::Plugin::Observe + +L provides the ability to register AOP-like +callbacks to specific Engine events. Subclasses L. +=head2 Catalyst::Plugin::PageCache + +L helps improve the performance of slow or +frequently accessed pages by caching the entire output of your page. +Subsequent requests to the page will receive the page very quickly from +cache. Note: At the moment it should be regarded as I. =head2 Catalyst::Plugin::Pluggable -A plugin for pluggable Catalyst applications. +L is a plugin for pluggable Catalyst +applications. =head2 Catalyst::Plugin::Prototype -Plugin for the Prototype JavaScript library. This Plugin allows you -to easily implement AJAX functionality without actually knowing -Javascript. +L is a plugin for the Prototype JavaScript +library. This Plugin allows you to easily implement AJAX functionality +without actually knowing Javascript. + +=head2 Catalyst::Plugin::RequireSSL + +Use L if you would like to force visitors +to access certain pages using only SSL mode. An attempt to access the +page in non-SSL mode will receive a redirect into SSL mode. Useful for +shopping carts, user registration forms, and other sensitive data. =head2 Catalyst::Plugin::Session::FastMmap -A session plugin for Catalyst based on C, which uses -an mmap'ed file to act as a shared memory interprocess cache. +L is a session plugin for Catalyst +based on C, which uses an mmap'ed file to act as a +shared memory interprocess cache. + +=head2 Catalyst::Plugin::Session =head2 Catalyst::Plugin::Static -A plugin to serve static files from C<< $c->config->{root} ->>/<< action >>/. +L is a plugin to serve static files from +C<$c-Econfig-E{root}>. Intended chiefly for development +purposes. =head2 Catalyst::Plugin::SubRequest -Plugin to allow subrequests to actions to be made within Catalyst. -Nice for portal software and such. - +L is a plugin to allow subrequests to +actions to be made within Catalyst. Nice for portal software and such. =head2 Catalyst::Plugin::Textile -A persistent Textile processor for Catalyst that uses C, -a Perl-based implementation of Dean Allen's Textile syntax. Textile is -shorthand for doing common formatting tasks (see L). +L is a persistent Textile processor for +Catalyst that uses C, a Perl-based implementation of Dean +Allen's Textile syntax. Textile is shorthand for doing common formatting +tasks (see L). +=head2 Catalyst::Plugin::Unicode + +L provides a Unicode-aware Catalyst. On +request, it decodes all params from UTF-8 octets into a sequence of +logical characters. On response, it encodes the body into UTF-8 octets. =head2 Catalyst::Plugin::XMLRPC -This plugin allows your controller class to dispatch XMLRPC methods -from its own class. +L plugin allows your Controller class to +dispatch XMLRPC methods from its own class. =head1 COMPONENT MODULES =head2 Catalyst::Model::CDBI -C is the C (CDBI) moduel class. It +L is the C (CDBI) module class. It is built on top of C, which automates the definition of C sub-classes by scanning the underlying table schemas, setting up columns and primary keys. +=head2 Catalyst::Model::CDBI::Plain + +L is a neutral interface to the +C module, which does not attempt to automate table +setup. It allows the user to manually set up C +classes, either by doing so within the Catalyst model classes +themselves, or by inheriting from existing C +classes. + =head2 Catalyst::Model::CDBI::CRUD -C is a subclass of C with -additional CRUD (create, replace, update, delete) methods. +L is a subclass of +C with additional CRUD (create, retrieve, +update, delete) methods. +=head2 Catalyst::Model::Plucene +L is the model class for the Plucene +search engine. -=head2 Catalyst::View::TT +=head2 Catalyst::View::HTML::Template + +L is a View component for +displaying your stash with L. -A Template Toolkit view. See L +=head2 Catalyst::View::PSP + +L is a View component for displaying your +stash using PSP, a Perl extension implementing a JSP-like +templating system; see L. + +=head2 Catalyst::View::Petal +L is a View component for displaying +your stash using Petal, the Perl Template Attribute Language, +an XML-based templating system; see L. + +=head2 Catalyst::View::Mason + +L is a View component for displaying your stash +with L. + +=head2 Catalyst::View::TT +L is a Template Toolkit view. See +L. =head1 AUTHOR Andrew Ford EA.Ford@ford-mason.co.ukE Marcus Ramberg Emramberg@cpan.orgE +Jesse Sheidlower Ejester@panix.comE =head1 COPYRIGHT