various formatting cleanups
[catagits/Catalyst-Manual.git] / lib / Catalyst / Manual / Components.pod
index 3641ade..45283e6 100644 (file)
@@ -18,15 +18,20 @@ status or preferred use of your chosen plugin/framework.
 
 =head1 PLUGINS
 
+Take care with plugins!  In general with a plugin ask "should this be
+acting globally on my application?".  If not it should be a
+Controller Role (e.g. see L<Catalyst::TraitFor::Controller::reCAPTCHA>.
+
 =head2 L<Catalyst::Plugin::Account::AutoDiscovery>
 
 Provides Account Auto-Discovery for Catalyst.
 
 =head2 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.
+Implements a demonstration showing how easily fluent speakers can read
+scrambled text if the first and last letters remain constant but the middle
+. Operates on text/plain and text/html served by your Catalyst application.
+This should really be a controller role, or even a View these days.
 
 =head2 L<Catalyst::Plugin::Alarm>
 
@@ -48,9 +53,9 @@ Note that newer versions of the authentication plugin allow multiple
 C<realms>, so that you can authenticate users in different ways in different
 parts of your application.
 
-This, however, has involved deprecated all classes in the
-C<Catalyst::Plugin::Authentication::Credential::XXX> and
-C<Catalyst::Plugin::Authentication::Store::XXX> namespaces.
+This, however, has involved deprecating all classes in the
+C<Catalyst::Plugin::Authentication::Credential::> and
+C<Catalyst::Plugin::Authentication::Store::> namespaces.
 
 These plugins are still usable, but they have mostly been replaced with
 new modules in the new namespace which will work together.
@@ -138,7 +143,7 @@ This module implements the Catalyst::Authentication API for L<Apache::AuthTkt>.
 
 =head4 L<Catalyst::Authentication::Store::DBI>
 
-Allows you to use a plain L<DBI> database connection to identify users. 
+Allows you to use a plain L<DBI> database connection to identify users.
 
 =head4 L<Catalyst::Authentication::Store::Htpasswd>
 
@@ -156,7 +161,7 @@ Authenticates users using an LDAP server.
 =head4 L<Catalyst::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.
+config hash. Great for testing or getting up and running quickly.
 
 =head4 L<Catalyst::Authentication::Store::Null>
 
@@ -230,10 +235,10 @@ the C<< Cache:: >> APO, such as:
 
 =head2 L<Catalyst::Plugin::CGI::Untaint>
 
-Provides specific charset handlers for the Japanese charsets.
-
 =head2 L<Catalyst::Plugin::Charsets::Japanese>
 
+Provides specific charset handlers for the Japanese charsets.
+
 =head2 L<Catalyst::Plugin::Compress::Bzip2>
 
 =head2 L<Catalyst::Plugin::Compress::Deflate>
@@ -263,16 +268,10 @@ L<Catalyst::Plugin::ConfigLoader::YAML>
 
 =head2 L<Catalyst::Plugin::Dumper>
 
-=head2 L<Catalyst::Plugin::Email>
-
-Sends email with L<Email::Send> and L<Email::MIME::Creator>.
-
 =head2 L<Catalyst::Plugin::Email::Japanese>
 
 =head2 L<Catalyst::Plugin::Email::Page>
 
-=head2 L<Catalyst::Plugin::EmailValid>
-
 =head2 L<Catalyst::Plugin::FillInForm>
 
 A plugin based on C<HTML::FillInForm>, which describes itself as a module
@@ -446,23 +445,23 @@ Allows your Controller class to dispatch XMLRPC methods from its own class.
 
 =head2 L<Catalyst::Controller::HTML::FormFu>
 
-Catalyst integration for <HTML::FormFu>.
+Catalyst integration for L<HTML::FormFu>.
 
 =head1 MODELS
 
 =head2 L<Catalyst::Model::CDBI>
 
-The C<Class::DBI> (CDBI) model class.  It is built on top of
-C<Class::DBI::Loader>, which automates the definition of C<Class::DBI>
+The L<Class::DBI> (CDBI) model class.  It is built on top of
+L<Class::DBI::Loader>, which automates the definition of L<Class::DBI>
 sub-classes by scanning the underlying table schemas, setting up columns
 and primary keys.
 
 =head2 L<Catalyst::Model::CDBI::Plain>
 
-A neutral interface to the C<Class::DBI> module which does not attempt
+A neutral interface to the L<Class::DBI> module which does not attempt
 to automate table setup. It allows the user to manually set up
-C<Class::DBI> classes, either by doing so within the Catalyst model
-classes themselves, or by inheriting from existing C<Class::DBI>
+L<Class::DBI> classes, either by doing so within the Catalyst model
+classes themselves, or by inheriting from existing L<Class::DBI>
 classes.
 
 =head2 L<Catalyst::Model::DBIC::Schema>