From: David Kamholz Date: Mon, 26 Jun 2006 20:42:45 +0000 (+0000) Subject: Plugins.pod cleanup X-Git-Tag: 5.7099_04~459 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=commitdiff_plain;h=41d5da66615f17db3919de6e5d2a20e3b832af37 Plugins.pod cleanup --- diff --git a/lib/Catalyst/Manual/Plugins.pod b/lib/Catalyst/Manual/Plugins.pod index e3030e0..b1569c0 100644 --- a/lib/Catalyst/Manual/Plugins.pod +++ b/lib/Catalyst/Manual/Plugins.pod @@ -9,553 +9,513 @@ 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. -This list is almost certainly outdated by the time you read this and some -plugins may even be deprecated or now part of core L. Be sure +This list may well be outdated by the time you read this and some +plugins may be deprecated or now part of core L. Be sure to check the Catalyst::Plugin namespace for additional plugins and consult the mailing list ( L ) for advice on the current status or preferred use of your chosen plugin/framework. =head1 PLUGINS -=head2 Catalyst::Plugin::Account::AutoDiscovery +=head2 L -L provides Account Auto-Discovery -for Catalyst. +Provides Account Auto-Discovery for Catalyst. -=head2 Catalyst::Plugin::Acme::Scramble +=head2 L -L Implements a potent meme about how easily -we can read scrambled text if the first and last letters remain constant. -Operates on text/plain and text/html served by your Catalyst application. +Implements a potent meme about how easily we can read scrambled text if the +first and last letters remain constant. Operates on text/plain and +text/html served by your Catalyst application. -=head2 Catalyst::Plugin::AtomPP +=head2 L -L allows you to dispatch AtomPP methods. +=head2 L -=head2 Catalyst::Plugin::AtomServer +Allows you to dispatch AtomPP methods. -L is a plugin that implements the necessary -bits to make it easy to build an Atom API server for any Catalyst-based -application. +=head2 L -=head2 Catalyst::Plugin::Authentication +A plugin that implements the necessary bits to make it easy to build an +Atom API server for any Catalyst-based application. -L is a infrastructure plugin for the -Catalyst authentication framework. Now the recommended way to do any form -of Authentication. +=head2 L -=head2 Catalyst::Plugin::Authentication::Basic::Remote +An infrastructure plugin for the Catalyst authentication framework. Now the +recommended way to do any form of Authentication. -L is a authentication plugin -that allows you to use a remote host's Basic authentication. - -=head2 Catalyst::Plugin::Authentication::CDBI - -L is a CDBI (C) -authentication plugin. Note that it requires a session plugin. - -=head2 Catalyst::Plugin::Authentication::CDBI::Basic - -L provides Basic Authorization -for Catalyst. -Replaced by L - -=head2 Catalyst::Plugin::Authentication::Credential::Atom +=head2 L L is a plugin which implements WSSE and Basic authentication for Catalyst applications using L -=head2 Catalyst::Plugin::Authentication::Credential::Flickr - -L is a plugin which -provides authentication via Flickr, using it's API - -=head2 Catalyst::Plugin::Authentication::Credential::HTTP - -L is a plugin that -lets you do HTTP Basic authentication for Catalyst. +=head2 L -=head2 Catalyst::Plugin::Authentication::Credential::Password +=head2 L -L takes a username -(or userid) and a password, and tries various methods of comparing a -password based on what the chosen store's user objects support. -Part of the Authentication Framework +Provides authentication via Flickr, using its API. +=head2 L -=head2 Catalyst::Plugin::Authentication::Credential::TypeKey +=head2 L -L integrates -L with L +Implements HTTP Basic authentication for Catalyst. -=head2 Catalyst::Plugin::Authentication::LDAP +=head2 L -L is a plugin allowing you -to authenticate your web users using an LDAP server. Replaced -by L +=head2 L -=head2 Catalyst::Plugin::Authentication::OpenID +=head2 L -L is a plugin that implements -support for OpenID authentication. For more information on OpenID, take -a look at L. +Takes a username (or userid) and a password, and tries various methods of +comparing a password based on what the chosen store's user objects support. +Part of the Authentication Framework L. -=head2 Catalyst::Plugin::Authentication::Simple +=head2 L -Replaced by new L framework +Integrates L with L. -=head2 Catalyst::Plugin::Authentication::Store +=head2 L -L is the core store documentation +The core authentication store documentation. -=head2 Catalyst::Plugin::Authentication::Store::DBIC +=head2 L -L is a plugin that lets -you do authentication and authorization against a DBIx::Class or -Class::DBI model. +Does authentication and authorization against a L or +L model. -=head2 Catalyst::Plugin::Authentication::Store::Htpasswd +=head2 L -L uses L -to let your application use C<.htpasswd> files for it's +Uses L to let your application use C<.htpasswd> files for its authentication storage. -=head2 Catalyst::Plugin::Authentication::Store::LDAP - -L the new LDAP store. Use this -instead of L +=head2 L -=head2 Catalyst::Plugin::Authentication::Store::Minimal +=head2 L -L lets you create a very -quick and dirty user database in your application's config hash. -Great for getting up and running quickly. +Authenticates users using an LDAP server. -=head2 Catalyst::Plugin::Authentication::User::Hash +=head2 L -L is an easy authentication -user object based on hashes. -See L for more info. +Lets you create a very quick and dirty user database in your application's +config hash. Great for getting up and running quickly. -=head2 Catalyst::Plugin::Authorization::ACL +=head2 L -L This module provides Access Control -List style path protection, with arbitrary rules for L applications. -It operates only on the Catalyst private namespace, at least at the moment. +An easy authentication user object based on hashes. +See L for more info. -=head2 Catalyst::Plugin::Authorization::CDBI::GroupToken +=head2 L -No longer on the CPAN +This module provides Access Control List style path protection, with arbitrary +rules for L applications. It operates only on the Catalyst private +namespace, at least at the moment. -=head2 Catalyst::Plugin::Authorization::Roles +=head2 L L provides role based authorization for Catalyst based on L. -=head2 Catalyst::Plugin::Browser +=head2 L -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 L -=head2 Catalyst::Plugin::Cache::FastMmap, FileCache, and Memcached +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, BerkeleyDB, and Memcached L, -L, and +L, +L, and L all provide a cache method enabling easy access to a shared cache. -=head2 Catalyst::Plugin::CDBI::Transaction - - -=head2 Catalyst::Plugin::Charsets::Japanese - - -=head2 Catalyst::Plugin::Compress::Bzip2 - -L compresses a response using -bzip compression. - -=head2 Catalyst::Plugin::Compress::Deflate - - -=head2 Catalyst::Plugin::Compress::Gzip - - -=head2 Catalyst::Plugin::Compress::Zlib - -L supplies Zlib compression for -Catalyst. - -=head2 Catalyst::Plugin::Config::JSON - - -=head2 Catalyst::Plugin::ConfigLoader - - -=head2 Catalyst::Plugin::ConfigLoader::INI +=head2 L +=head2 L -=head2 Catalyst::Plugin::ConfigLoader::JSON +=head2 L +=head2 L -=head2 Catalyst::Plugin::ConfigLoader::Perl +=head2 L +=head2 L -=head2 Catalyst::Plugin::ConfigLoader::XML +=head2 L +=head2 L -=head2 Catalyst::Plugin::ConfigLoader::YAML +Provides a standard method for loading config files. Support +exists for various formats. See +L, +L, +L, +L, and +L +=head2 L -=head2 Catalyst::Plugin::Config::YAML +=head2 L +=head2 L -=head2 Catalyst::Plugin::DateTime +=head2 L +Creates a sane, standard end method for your application. -=head2 Catalyst::Plugin::DefaultEnd +=head2 L -L creates a sane, standard end method for -your application. +=head2 L -=head2 Catalyst::Plugin::Devel::InPageLogs +=head2 L +=head2 L -=head2 Catalyst::Plugin::Devel::InPageLogs::Log +=head2 L +Sends email with L and L. -=head2 Catalyst::Plugin::Dumper +=head2 L +=head2 L -=head2 Catalyst::Plugin::Email +=head2 L -L sends email with Catalyst and L -and L. +=head2 L -=head2 Catalyst::Plugin::Email::Japanese +A plugin 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 L -=head2 Catalyst::Plugin::Email::Page +=head2 L +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::EmailValid +=head2 L +=head2 L -=head2 Catalyst::Plugin::FillInForm +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. -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 L -=head2 Catalyst::Plugin::Flavour +=head2 L +=head2 L -=head2 Catalyst::Plugin::FormValidator +=head2 L -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 L -=head2 Catalyst::Plugin::FormValidator::Simple +An internationalization plugin for Catalyst. Supports C/C files +and Maketext classes under your application's I18N namespace. +=head2 L -=head2 Catalyst::Plugin::Geography +=head2 L -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 L -=head2 Catalyst::Plugin::Geography::Implementation +=head2 L +=head2 L -=head2 Catalyst::Plugin::HashedCookies +Provides the ability to register AOP-like callbacks to specific Engine +events. Subclasses L. +=head2 L -=head2 Catalyst::Plugin::HTML::Scrubber +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 L -=head2 Catalyst::Plugin::HTML::Widget +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 L -=head2 Catalyst::Plugin::I18N +=head2 L -L is an internationalization plugin for -Catalyst. Supports C/C files and Maketext classes under your -application's I18N namespace. +=head2 L -=head2 Catalyst::Plugin::JSONRPC +A plugin for pluggable Catalyst applications. +=head2 L -=head2 Catalyst::Plugin::Message +A plugin for the Prototype JavaScript library. This Plugin allows you to +easily implement AJAX functionality without actually knowing Javascript. +=head2 L -=head2 Catalyst::Plugin::MobileAgent +=head2 L +=head2 L -=head2 Catalyst::Plugin::Observe +Use this 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 login pages, shopping carts, user +registration forms, and other sensitive data. -L provides the ability to register AOP-like -callbacks to specific Engine events. Subclasses L. +=head2 L -=head2 Catalyst::Plugin::OrderedParams +=head2 L -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::Params::Nested - - -=head2 Catalyst::Plugin::Params::Nested::Expander - - -=head2 Catalyst::Plugin::Pluggable - -L is a plugin for pluggable Catalyst -applications. - -=head2 Catalyst::Plugin::Prototype - -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::Redirect - - -=head2 Catalyst::Plugin::RequestToken +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 L -=head2 Catalyst::Plugin::RequireSSL +=head2 L -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 -login pages, shopping carts, user registration forms, and other -sensitive data. +=head2 L -=head2 Catalyst::Plugin::SanitizeUrl +=head2 L +=head2 L -=head2 Catalyst::Plugin::SanitizeUrl::PrepAction +=head2 L +=head2 L -=head2 Catalyst::Plugin::Scheduler +=head2 L +=head2 L -=head2 Catalyst::Plugin::Session +=head2 L -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 L -=head2 Catalyst::Plugin::Session::CGISession +=head2 L +=head2 L -=head2 Catalyst::Plugin::Session::FastMmap +=head2 L -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 L -=head2 Catalyst::Plugin::Session::Flex +=head2 L +Allows your controller class to dispatch SRU actions (C, C, +and C) from its own class. -=head2 Catalyst::Plugin::Session::Manager +=head2 L +=head2 L -=head2 Catalyst::Plugin::Session::Manager::Client::Cookie +L is a plugin to serve static files from +C<< $c->config->{root} >>. Intended chiefly for development +purposes. +=head2 L -=head2 Catalyst::Plugin::Session::Manager::Client::Rewrite +Serves static files in your application without requiring a single line of +code. This plugin is now included in the core Catalyst distribution. +=head2 L -=head2 Catalyst::Plugin::Session::Manager::Client::StickyQuery +A plugin to allow subrequests to actions to be made within Catalyst. Nice +for portal software and such. +=head2 L -=head2 Catalyst::Plugin::Session::Manager::Storage::CDBI +An interface to the L module, enabling easy HTML form +creation. +=head2 L -=head2 Catalyst::Plugin::Session::Manager::Storage::FastMmap +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 L -=head2 Catalyst::Plugin::Session::Manager::Storage::File +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 L -=head2 Catalyst::Plugin::Session::PerUser +=head2 L +=head2 L -=head2 Catalyst::Plugin::Session::State +=head2 L +=head2 L -=head2 Catalyst::Plugin::Session::State::Cookie +=head2 L +Allows your Controller class to dispatch XMLRPC methods from its own class. -=head2 Catalyst::Plugin::Session::State::URI +=head1 CONTROLLERS +=head2 L -=head2 Catalyst::Plugin::Session::Store +Lets you mark lexical variables with a C attribute, automatically +passing them to the stash. +=head1 MODELS -=head2 Catalyst::Plugin::Session::Store::CDBI +=head2 L +The C (CDBI) model 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::Plugin::Session::Store::DBI +=head2 L +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::Plugin::Session::Store::Dummy +=head2 L +A L model class that can use either an explicit +L or one automatically loaded from your database via +L. -=head2 Catalyst::Plugin::Session::Store::FastMmap +=head2 L +=head2 L -=head2 Catalyst::Plugin::Session::Store::File +=head2 L +=head2 L -=head2 Catalyst::Plugin::Session::Store::Memcached +=head2 L +=head2 L -=head2 Catalyst::Plugin::Session::Test::Store +A model class for the Plucene search engine. +=head2 L -=head2 Catalyst::Plugin::Singleton +=head2 L +=head2 L -=head2 Catalyst::Plugin::SRU +A model class for the Xapian search engine. -L allows your controller class to dispatch SRU -actions (C, C, and C) from its own class. +=head1 VIEWS -=head2 Catalyst::Plugin::StackTrace +=head2 L +=head2 L -=head2 Catalyst::Plugin::Static +=head2 L -L is a plugin to serve static files from -C<$c-Econfig-E{root}>. Intended chiefly for development -purposes. +=head2 L -=head2 Catalyst::Plugin::Static::Simple +=head2 L -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 L -=head2 Catalyst::Plugin::SubRequest +=head2 L -L is a plugin to allow subrequests to -actions to be made within Catalyst. Nice for portal software and such. +A view component for rendering pages with L. -=head2 Catalyst::Plugin::SuperForm +=head2 L -L is an interface to the L -module, enabling easy HTML form creation. +=head2 L -=head2 Catalyst::Plugin::Textile +=head2 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). +A view component for rendering pages with L. -=head2 Catalyst::Plugin::Unicode +=head2 L -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 L -=head2 Catalyst::Plugin::Unicode::Encoding +=head2 L +A view component for rendering pages using PSP, a Perl extension +implementing a JSP-like templating system. See L. -=head2 Catalyst::Plugin::Upload::Basename +=head2 L +A view component for rendering pages using Petal, the Perl Template +Attribute Language, an XML-based templating system. See L. -=head2 Catalyst::Plugin::Upload::MD5 +=head2 L +A view component for rendering pages with Template Toolkit. See +L. -=head2 Catalyst::Plugin::Upload::MIME +=head2 L +=head2 L -=head2 Catalyst::Plugin::XMLRPC +=head1 OBSOLETE MODULES -L plugin allows your Controller class to -dispatch XMLRPC methods from its own class. +=head2 L -=head1 COMPONENT MODULES +Replaced by L. -=head2 Catalyst::Model::CDBI +=head2 L -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. +Replaced by L. -=head2 Catalyst::Model::CDBI::Plain +=head2 L -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. +Replaced by L. -=head2 Catalyst::Model::DBIC::Schema +=head2 L -L is a L model class that can -use either an explicit DBIx::Class::Schema or one automatically loaded from -your database via DBIx::Class::Schema::Loader +Replaced by L. -=head2 Catalyst::Model::Plucene +=head2 L -L is a model class for the Plucene search -engine. +Replaced by L. -=head2 Catalyst::Model::Xapian +=head2 L -L is a model class for the Xapian search -engine. +L is a plugin that implements +support for OpenID authentication. For more information on OpenID, take +a look at L. -=head2 Catalyst::View::HTML::Template +=head2 L -L is a View component for -displaying your stash with L. +Replaced by L. -=head2 Catalyst::View::Mason +=head2 L -L is a View component for displaying your stash -with L. +=head2 L -=head2 Catalyst::View::PSP +=head2 Catalyst::Plugin::Config::* -L is a View component for displaying your stash -using PSP, a Perl extension implementing a JSP-like templating system; -see L. +The L and L +modules have been replaced by their corresponding L +modules. -=head2 Catalyst::View::Petal +=head2 L -L is a View component for displaying -your stash using Petal, the Perl Template Attribute Language, -an XML-based templating system; see L. +=head2 L -=head2 Catalyst::View::TT +=head2 Catalyst::Plugin::Session::* -L is a Template Toolkit view. See L. +The L, +L, +L, and +L +modules have been replaced by the framework. =head1 AUTHORS @@ -567,9 +527,10 @@ Jesse Sheidlower Ejester@panix.comE Marcus Ramberg Emramberg@cpan.orgE +David Kamholz Edkamholz@cpan.orgE + =head1 COPYRIGHT This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself. -