X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FManual%2FPlugins.pod;h=13acd0fef4aab99598290603fd2d236609814b54;hb=4427ee06faecbb7a080ca98d2f5ed191ad6dfccf;hp=0510d2ef768f77f846c415f207d3c8d0848f791d;hpb=665dadd46c8d9e56c30d345530462bd846bbd721;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Manual/Plugins.pod b/lib/Catalyst/Manual/Plugins.pod index 0510d2e..13acd0f 100644 --- a/lib/Catalyst/Manual/Plugins.pod +++ b/lib/Catalyst/Manual/Plugins.pod @@ -4,104 +4,247 @@ 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. + +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 =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::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::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 +Catalyst. + +=head2 Catalyst::Plugin::Compress::Bzip2 + +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 -Send emails with Catalyst and L and L. +L sends email with Catalyst and L +and L. =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::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. =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. +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 + +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 -A session plugin for Catalyst based on C, which uses an -mmap'ed file to act as a shared memeory 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. This is an older session plugin; you may +wish to look at L instead. +=head2 Catalyst::Plugin::SRU -=head2 Catalyst::Plugin::Static +L allows your controller class to dispatch SRU +actions (C, C, and C) from its own class. + +=head2 Catalyst::Plugin::Static::Simple -A plugin to serve static files from C<< $c->config->{root} >>. +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 + +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. +L is a plugin to allow subrequests to +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 -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 -=head2 Catalyst::Plugin::XMLRPC +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. -This plugin allows your controller class to dispatch XMLRPC methods -from its own class. +=head2 Catalyst::Plugin::XMLRPC +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 iss -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. +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::DBIC -=head2 Catalyst::Model::CDBI::CRUD +L is a L model class built on top of +L. -C is a subclass of C with -additional CRUD (create, replace, update, delete) methods. +=head2 Catalyst::Model::Plucene +L is a model class for the Plucene search engine. -=head2 Catalyst::View::Template +=head2 Catalyst::Model::Xapian -A Template Toolkit view class. +L is a model class for the Xapian search engine. +=head2 Catalyst::View::HTML::Template -=head1 AUTHOR +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. + +=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::TT + +L is a Template Toolkit view. See L. + +=head1 AUTHORS Andrew Ford EA.Ford@ford-mason.co.ukE +Marcus Ramberg Emramberg@cpan.orgE + +Jesse Sheidlower Ejester@panix.comE + =head1 COPYRIGHT This program is free software, you can redistribute it and/or modify it under