X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FManual%2FPlugins.pod;h=e3030e0b28a11cb5f1176e1d88959c427c3e785f;hb=34d28dfd33574ce30aca69fb8700b61111d97b92;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..e3030e0 100644
--- a/lib/Catalyst/Manual/Plugins.pod
+++ b/lib/Catalyst/Manual/Plugins.pod
@@ -5,28 +5,153 @@ 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 and some
+plugins may even be deprecated or now part of core L<Catalyst>. Be sure 
+to check the Catalyst::Plugin namespace for additional plugins and consult 
+the mailing list ( L<http://dev.catalyst.perl.org/wiki/Support> ) for advice 
+on the current status or preferred use of your chosen plugin/framework.
 
 =head1 PLUGINS
 
+=head2 Catalyst::Plugin::Account::AutoDiscovery
+
+L<Catalyst::Plugin::Account::AutoDiscovery> provides Account Auto-Discovery
+for Catalyst.
+
+=head2 Catalyst::Plugin::Acme::Scramble
+
+L<Catalyst::Plugin::Acme::Scramble> 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
+
+L<Catalyst::Plugin::AtomPP> allows you to dispatch AtomPP methods.
+
+=head2 Catalyst::Plugin::AtomServer
+
+L<Catalyst::Plugin::AtomServer> is a plugin that implements the necessary 
+bits to make it easy to build an Atom API server for any Catalyst-based 
+application.
+
+=head2 Catalyst::Plugin::Authentication
+
+L<Catalyst::Plugin::Authentication> is a infrastructure plugin for the 
+Catalyst authentication framework. Now the recommended way to do any form
+of Authentication.
+
+=head2 Catalyst::Plugin::Authentication::Basic::Remote
+
+L<Catalyst::Plugin::Authentication::Basic::Remote> is a authentication plugin 
+that allows you to use a remote host's Basic authentication.
+
 =head2 Catalyst::Plugin::Authentication::CDBI
 
 L<Catalyst::Plugin::Authentication::CDBI> is a CDBI (C<Class::DBI>)
 authentication plugin.  Note that it requires a session plugin.
 
+=head2 Catalyst::Plugin::Authentication::CDBI::Basic
+
+L<Catalyst::Plugin::Authentication::CDBI::Basic> provides Basic Authorization 
+for Catalyst. 
+Replaced by L<Catalyst::Plugin::Authentication::Credential::HTTP>
+
+=head2 Catalyst::Plugin::Authentication::Credential::Atom
+
+L<Catalyst::Plugin::Authentication::Credential::Atom> is a plugin which
+implements WSSE and Basic authentication for Catalyst applications using 
+L<Catalyst::Plugin::AtomServer>
+
+=head2 Catalyst::Plugin::Authentication::Credential::Flickr
+
+L<Catalyst::Plugin::Authentication::Credential::Flickr> is a plugin which
+provides authentication via Flickr, using it's API
+
+=head2 Catalyst::Plugin::Authentication::Credential::HTTP
+
+L<Catalyst::Plugin::Authentication::Credential::HTTP> is a plugin that 
+lets you do HTTP Basic authentication for Catalyst.
+
+=head2 Catalyst::Plugin::Authentication::Credential::Password
+
+L<Catalyst::Plugin::Authentication::Credential::Password> 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 <Catalyst::Plugin::Authentication>
+
+
+=head2 Catalyst::Plugin::Authentication::Credential::TypeKey
+
+L<Catalyst::Plugin::Authentication::Credential::TypeKey> integrates 
+L<Authen::TypeKey> with L<Catalyst::Plugin::Authentication>
+
 =head2 Catalyst::Plugin::Authentication::LDAP
 
 L<Catalyst::Plugin::Authentication::LDAP> is a plugin allowing you 
-to authenticate your web users using an LDAP server. 
+to authenticate your web users using an LDAP server. Replaced
+by L<Catalyst::Plugin::Authentication::Store::LDAP>
 
-=head2 Catalyst::Plugin::Email
+=head2 Catalyst::Plugin::Authentication::OpenID
 
-L<Catalyst::Plugin::Email> sends email with Catalyst and L<Email::Send>
-and L<Email::MIME::Creator>.
+L<Catalyst::Plugin::Authentication::OpenID> is a plugin that implements 
+support for OpenID authentication. For more information on OpenID, take 
+a look at L<http://www.openid.net/>.
+
+=head2 Catalyst::Plugin::Authentication::Simple
+
+Replaced by new L<Catalyst::Plugin::Authentication> framework
+
+=head2 Catalyst::Plugin::Authentication::Store
+
+L<Catalyst::Plugin::Authentication::Store> is the core store documentation
+
+=head2 Catalyst::Plugin::Authentication::Store::DBIC
+
+L<Catalyst::Plugin::Authentication::Store::DBIC> is a plugin that lets 
+you do authentication and authorization against a DBIx::Class or 
+Class::DBI model.
+
+=head2 Catalyst::Plugin::Authentication::Store::Htpasswd
+
+L<Catalyst::Plugin::Authentication::Store::Htpasswd> uses L<Authen::Htpasswd> 
+to let your application use C<.htpasswd> files for it's 
+authentication storage.
+
+=head2 Catalyst::Plugin::Authentication::Store::LDAP
+
+L<Catalyst::Plugin::Authentication::Store::LDAP> the new LDAP store. Use this 
+instead of L<Catalyst::Plugin::Authentication::LDAP>
+
+=head2 Catalyst::Plugin::Authentication::Store::Minimal
+
+L<Catalyst::Plugin::Authentication::Store::Minimal> 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::Authentication::User::Hash
+
+L<Catalyst::Plugin::Authentication::User::Hash> is an easy authentication 
+user object based on hashes. 
+See L<Catalyst::Plugin::Authentication::Store::Minimal> for more info.
+
+=head2 Catalyst::Plugin::Authorization::ACL
+
+L<Catalyst::Plugin::Authorization::ACL> This module provides Access Control 
+List style path protection, with arbitrary rules for L<Catalyst> applications. 
+It operates only on the Catalyst private namespace, at least at the moment.
+
+=head2 Catalyst::Plugin::Authorization::CDBI::GroupToken
+
+No longer on the CPAN
+
+=head2 Catalyst::Plugin::Authorization::Roles
+
+L<Catalyst::Plugin::Authorization::Roles> provides role based authorization 
+for Catalyst based on L<Catalyst::Plugin::Authentication>. 
 
 =head2 Catalyst::Plugin::Browser
 
@@ -35,16 +160,90 @@ capability of browser detection. It returns an instance of
 L<HTTP::BrowserDetect>, which lets you get information from the client's
 user agent.
 
-=head2 Catalyst::Plugin::Compress::Zlib
+=head2 Catalyst::Plugin::Cache::FastMmap, FileCache, and Memcached
+
+L<Catalyst::Plugin::Cache::FastMmap>,
+L<Catalyst::Plugin::Cache::FileCache>, and
+L<Catalyst::Plugin::Cache::Memcached> all provide a cache method
+enabling easy access to a shared cache.
+
+=head2 Catalyst::Plugin::CDBI::Transaction
+
+
+=head2 Catalyst::Plugin::Charsets::Japanese
 
-L<Catalyst::Plugin::Compress::Zlib> supplies Zlib compression for
-Catalyst.
 
 =head2 Catalyst::Plugin::Compress::Bzip2
 
 L<Catalyst::Plugin::Compress::Bzip2> compresses a response using
 bzip compression.
 
+=head2 Catalyst::Plugin::Compress::Deflate
+
+
+=head2 Catalyst::Plugin::Compress::Gzip
+
+
+=head2 Catalyst::Plugin::Compress::Zlib
+
+L<Catalyst::Plugin::Compress::Zlib> supplies Zlib compression for
+Catalyst.
+
+=head2 Catalyst::Plugin::Config::JSON
+
+
+=head2 Catalyst::Plugin::ConfigLoader
+
+
+=head2 Catalyst::Plugin::ConfigLoader::INI
+
+
+=head2 Catalyst::Plugin::ConfigLoader::JSON
+
+
+=head2 Catalyst::Plugin::ConfigLoader::Perl
+
+
+=head2 Catalyst::Plugin::ConfigLoader::XML
+
+
+=head2 Catalyst::Plugin::ConfigLoader::YAML
+
+
+=head2 Catalyst::Plugin::Config::YAML
+
+
+=head2 Catalyst::Plugin::DateTime
+
+
+=head2 Catalyst::Plugin::DefaultEnd
+
+L<Catalyst::Plugin::DefaultEnd> creates a sane, standard end method for
+your application.
+
+=head2 Catalyst::Plugin::Devel::InPageLogs
+
+
+=head2 Catalyst::Plugin::Devel::InPageLogs::Log
+
+
+=head2 Catalyst::Plugin::Dumper
+
+
+=head2 Catalyst::Plugin::Email
+
+L<Catalyst::Plugin::Email> sends email with Catalyst and L<Email::Send>
+and L<Email::MIME::Creator>.
+
+=head2 Catalyst::Plugin::Email::Japanese
+
+
+=head2 Catalyst::Plugin::Email::Page
+
+
+=head2 Catalyst::Plugin::EmailValid
+
+
 =head2 Catalyst::Plugin::FillInForm
 
 L<Catalyst::Plugin::FillInForm> is plugin for Catalyst based on
@@ -54,37 +253,75 @@ radio buttons, checkboxes, and select tags.  C<HTML::FillInForm> is a
 subclass of C<HTML::Parser> and uses it to parse the HTML and insert the
 values into the form tags.
 
+=head2 Catalyst::Plugin::Flavour
+
+
 =head2 Catalyst::Plugin::FormValidator
 
 L<Catalyst::Plugin::FormValidator> is a form validator plugin that uses
 L<Data::FormValidator> 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::FormValidator::Simple
+
+
 =head2 Catalyst::Plugin::Geography
 
 L<Catalyst::Plugin::Geography> 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::Geography::Implementation
+
+
+=head2 Catalyst::Plugin::HashedCookies
+
+
+=head2 Catalyst::Plugin::HTML::Scrubber
+
+
+=head2 Catalyst::Plugin::HTML::Widget
+
+
 =head2 Catalyst::Plugin::I18N
 
 L<Catalyst::Plugin::I18N> is an internationalization plugin for
 Catalyst.  Supports C<mo>/C<po> files and Maketext classes under your
 application's I18N namespace.
 
+=head2 Catalyst::Plugin::JSONRPC
+
+
+=head2 Catalyst::Plugin::Message
+
+
+=head2 Catalyst::Plugin::MobileAgent
+
+
 =head2 Catalyst::Plugin::Observe
 
 L<Catalyst::Plugin::Observe> provides the ability to register AOP-like
 callbacks to specific Engine events. Subclasses L<Class::Publisher>.
 
+=head2 Catalyst::Plugin::OrderedParams
+
+L<Catalyst::Plugin::OrderedParams> 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<Catalyst::Plugin::PageCache> 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<highly
-experimental>.
+cache.
+
+=head2 Catalyst::Plugin::Params::Nested
+
+
+=head2 Catalyst::Plugin::Params::Nested::Expander
+
 
 =head2 Catalyst::Plugin::Pluggable
 
@@ -97,18 +334,115 @@ L<Catalyst::Plugin::Prototype> 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
+
+
 =head2 Catalyst::Plugin::RequireSSL
 
 Use L<Catalyst::Plugin::RequireSSL> 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::SanitizeUrl
+
+
+=head2 Catalyst::Plugin::SanitizeUrl::PrepAction
+
+
+=head2 Catalyst::Plugin::Scheduler
+
+
+=head2 Catalyst::Plugin::Session
+
+The L<Catalyst::Plugin::Session> 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::CGISession
+
 
 =head2 Catalyst::Plugin::Session::FastMmap
 
 L<Catalyst::Plugin::Session::FastMmap> is a session plugin for Catalyst
 based on C<Cache::FastMMap>, 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<Catalyst::Plugin::Session> instead.
+
+=head2 Catalyst::Plugin::Session::Flex
+
+
+=head2 Catalyst::Plugin::Session::Manager
+
+
+=head2 Catalyst::Plugin::Session::Manager::Client::Cookie
+
+
+=head2 Catalyst::Plugin::Session::Manager::Client::Rewrite
+
+
+=head2 Catalyst::Plugin::Session::Manager::Client::StickyQuery
+
+
+=head2 Catalyst::Plugin::Session::Manager::Storage::CDBI
+
+
+=head2 Catalyst::Plugin::Session::Manager::Storage::FastMmap
+
+
+=head2 Catalyst::Plugin::Session::Manager::Storage::File
+
+
+=head2 Catalyst::Plugin::Session::PerUser
+
+
+=head2 Catalyst::Plugin::Session::State
+
+
+=head2 Catalyst::Plugin::Session::State::Cookie
+
+
+=head2 Catalyst::Plugin::Session::State::URI
+
+
+=head2 Catalyst::Plugin::Session::Store
+
+
+=head2 Catalyst::Plugin::Session::Store::CDBI
+
+
+=head2 Catalyst::Plugin::Session::Store::DBI
+
+
+=head2 Catalyst::Plugin::Session::Store::Dummy
+
+
+=head2 Catalyst::Plugin::Session::Store::FastMmap
+
+
+=head2 Catalyst::Plugin::Session::Store::File
+
+
+=head2 Catalyst::Plugin::Session::Store::Memcached
+
+
+=head2 Catalyst::Plugin::Session::Test::Store
+
+
+=head2 Catalyst::Plugin::Singleton
+
+
+=head2 Catalyst::Plugin::SRU
+
+L<Catalyst::Plugin::SRU> allows your controller class to dispatch SRU
+actions (C<explain>, C<scan>, and C<searchRetrieve>) from its own class.
+
+=head2 Catalyst::Plugin::StackTrace
 
 
 =head2 Catalyst::Plugin::Static
@@ -117,11 +451,21 @@ L<Catalyst::Plugin::Static> is a plugin to serve static files from
 C<$c-E<gt>config-E<gt>{root}>. Intended chiefly for development
 purposes.
 
+=head2 Catalyst::Plugin::Static::Simple
+
+L<Catalyst::Plugin::Static::Simple> 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::SubRequest
 
 L<Catalyst::Plugin::SubRequest> 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<Catalyst::Plugin::SuperForm> is an interface to the L<HTML::SuperForm>
+module, enabling easy HTML form creation.
 
 =head2 Catalyst::Plugin::Textile
 
@@ -136,12 +480,23 @@ L<Catalyst::Plugin::Unicode> 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::Unicode::Encoding
+
+
+=head2 Catalyst::Plugin::Upload::Basename
+
+
+=head2 Catalyst::Plugin::Upload::MD5
+
+
+=head2 Catalyst::Plugin::Upload::MIME
+
+
 =head2 Catalyst::Plugin::XMLRPC
 
 L<Catalyst::Plugin::XMLRPC> plugin allows your Controller class to
 dispatch XMLRPC methods from its own class.
 
-
 =head1 COMPONENT MODULES
 
 =head2 Catalyst::Model::CDBI
@@ -160,49 +515,61 @@ classes, either by doing so within the Catalyst model classes
 themselves, or by inheriting from existing C<Class::DBI>
 classes.
 
-=head2 Catalyst::Model::CDBI::CRUD
+=head2 Catalyst::Model::DBIC::Schema
 
-L<Catalyst::Model::CDBI::CRUD> is a subclass of 
-C<Catalyst::Model::CDBI> with additional CRUD (create, retrieve, 
-update, delete) methods.
+L<Catalyst::Model::DBIC::Schema> is a L<DBIx::Class> model class that can
+use either an explicit DBIx::Class::Schema or one automatically loaded from
+your database via DBIx::Class::Schema::Loader
 
 =head2 Catalyst::Model::Plucene
-L<Catalyst::Model::Plucene> is the model class for the Plucene
-search engine.
+
+L<Catalyst::Model::Plucene> is a model class for the Plucene search
+engine.
+
+=head2 Catalyst::Model::Xapian
+
+L<Catalyst::Model::Xapian> is a model class for the Xapian search
+engine.
 
 =head2 Catalyst::View::HTML::Template
 
 L<Catalyst::View::HTML::Template> is a View component for
 displaying your stash with L<HTML::Template>.
 
+=head2 Catalyst::View::Mason
+
+L<Catalyst::View::Mason> is a View component for displaying your stash
+with L<HTML::Mason>.
+
 =head2 Catalyst::View::PSP
 
-L<Catalyst::View::PSP> is a View component for displaying your
-stash using PSP, a Perl extension implementing a JSP-like 
-templating system; see L<Text::PSP>.
+L<Catalyst::View::PSP> is a View component for displaying your stash
+using PSP, a Perl extension implementing a JSP-like templating system;
+see L<Text::PSP>.
 
 =head2 Catalyst::View::Petal
+
 L<Catalyst::View::Petal> is a View component for displaying 
 your stash using Petal, the Perl Template Attribute Language,
 an XML-based templating system; see L<Petal>.
 
-=head2 Catalyst::View::Mason
-
-L<Catalyst::View::Mason> is a View component for displaying your stash
-with L<HTML::Mason>.
-
 =head2 Catalyst::View::TT
 
-L<Catalyst::View::TT> is a Template Toolkit view. See
-L<Template::Manual>.
+L<Catalyst::View::TT> is a Template Toolkit view. See L<Template::Manual>.
 
-=head1 AUTHOR
+=head1 AUTHORS
 
 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
-Marcus Ramberg E<lt>mramberg@cpan.orgE<gt>
+
+Gavin Henry E<lt>ghenry@suretecsystems.comE<gt>
+
 Jesse Sheidlower E<lt>jester@panix.comE<gt>
 
+Marcus Ramberg E<lt>mramberg@cpan.orgE<gt>
+
 =head1 COPYRIGHT
 
 This program is free software, you can redistribute it and/or modify it under
 the same terms as Perl itself.
+
+