X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FManual%2FPlugins.pod;h=16da1ef2288e116b02cac210dfedab7e815ccd01;hb=24d0c6d2eca02cc36ceae9e7fc4747b0150e8bcd;hp=8391b03a3608c97d9a352fc751f66b1dccd84f2e;hpb=c74caf1d4e65d9d142e350f158828340483ac3ab;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Manual/Plugins.pod b/lib/Catalyst/Manual/Plugins.pod index 8391b03..16da1ef 100644 --- a/lib/Catalyst/Manual/Plugins.pod +++ b/lib/Catalyst/Manual/Plugins.pod @@ -5,11 +5,12 @@ 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 Catalyst. The plugins +available to extend the runtime functionality of Catalyst. Most 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. +They typically require additional modules from CPAN. + +This list is almost certainly outdated by the time you read this, so be +sure to check the Catalyst::Plugin namespace for additional plugins. =head1 PLUGINS @@ -23,11 +24,6 @@ authentication plugin. Note that it requires a session plugin. L is a plugin allowing you to authenticate your web users using an LDAP server. -=head2 Catalyst::Plugin::Email - -L sends email with Catalyst and L -and L. - =head2 Catalyst::Plugin::Browser L extends L by adding the @@ -35,6 +31,13 @@ capability of browser detection. It returns an instance of L, which lets you get information from the client's user agent. +=head2 Catalyst::Plugin::Cache::FastMmap, FileCache, and Memcached + +L, +L, and +L all provide a cache method +enabling easy access to a shared cache. + =head2 Catalyst::Plugin::Compress::Zlib L supplies Zlib compression for @@ -45,6 +48,16 @@ Catalyst. L compresses a response using bzip compression. +=head2 Catalyst::Plugin::DefaultEnd + +L creates a sane, standard end method for +your application. + +=head2 Catalyst::Plugin::Email + +L sends email with Catalyst and L +and L. + =head2 Catalyst::Plugin::FillInForm L is plugin for Catalyst based on @@ -58,7 +71,7 @@ values into the form tags. 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 +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 @@ -78,13 +91,18 @@ application's I18N namespace. L provides the ability to register AOP-like callbacks to specific Engine events. Subclasses L. +=head2 Catalyst::Plugin::OrderedParams + +L adjusts the way that parameters operate, +causing them to appear in the same order they were submitted by the browser. +This can be useful for creating things such as email forms. + =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. +cache. =head2 Catalyst::Plugin::Pluggable @@ -102,14 +120,33 @@ without actually knowing Javascript. 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. +login pages, shopping carts, user registration forms, and other +sensitive data. + +=head2 Catalyst::Plugin::Session + +The L series of modules provide an easy way to +include session handling in an application. You can choose from several +different backend storage methods and combine that with your choice of +client-side storage methods. =head2 Catalyst::Plugin::Session::FastMmap L is a session plugin for Catalyst based on C, which uses an mmap'ed file to act as a -shared memory interprocess cache. +shared memory interprocess cache. This is an older session plugin; you may +wish to look at L instead. + +=head2 Catalyst::Plugin::SRU + +L allows your controller class to dispatch SRU +actions (C, C, and C) from its own class. +=head2 Catalyst::Plugin::Static::Simple + +L serves static files in your +application without requiring a single line of code. This plugin is now +included in the core Catalyst distribution. =head2 Catalyst::Plugin::Static @@ -117,11 +154,15 @@ L is a plugin to serve static files from C<$c-Econfig-E{root}>. Intended chiefly for development purposes. - =head2 Catalyst::Plugin::SubRequest L is a plugin to allow subrequests to -actions to be made within Catalyst. Nice for portal software and such. +actions to be made within Catalyst. Nice for portal software and such. + +=head2 Catalyst::Plugin::SuperForm + +L is an interface to the L +module, enabling easy HTML form creation. =head2 Catalyst::Plugin::Textile @@ -141,7 +182,6 @@ logical characters. On response, it encodes the body into UTF-8 octets. L plugin allows your Controller class to dispatch XMLRPC methods from its own class. - =head1 COMPONENT MODULES =head2 Catalyst::Model::CDBI @@ -160,46 +200,53 @@ classes, either by doing so within the Catalyst model classes themselves, or by inheriting from existing C classes. -=head2 Catalyst::Model::CDBI::CRUD +=head2 Catalyst::Model::DBIC -L is a subclass of -C with additional CRUD (create, retrieve, -update, delete) methods. +L is a L model class built on top of +L. =head2 Catalyst::Model::Plucene -L is the model class for the Plucene -search engine. + +L is a model class for the Plucene search +engine. + +=head2 Catalyst::Model::Xapian + +L is a model class for the Xapian search +engine. =head2 Catalyst::View::HTML::Template L is a View component for displaying your stash with L. +=head2 Catalyst::View::Mason + +L is a View component for displaying your stash +with 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. +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. +L is a Template Toolkit view. See L. -=head1 AUTHOR +=head1 AUTHORS Andrew Ford EA.Ford@ford-mason.co.ukE + Marcus Ramberg Emramberg@cpan.orgE + Jesse Sheidlower Ejester@panix.comE =head1 COPYRIGHT