doc: updated Intro.pod (minor) and Plugins.pod (significant additions)
Jesse Sheidlower [Wed, 4 May 2005 01:51:50 +0000 (01:51 +0000)]
lib/Catalyst/Manual/Intro.pod
lib/Catalyst/Manual/Plugins.pod

index bc1358d..af4cb99 100644 (file)
@@ -24,7 +24,7 @@ Access and modify content (data). L<Class::DBI>, L<Plucene>, L<Net::LDAP>...
 
 =item * B<View>
 
-Present content to the user. L<Template Toolkit|Template>, L<Mason|HTML::Mason>...
+Present content to the user. L<Template Toolkit|Template>, L<Mason|HTML::Mason>, L<HTML::Template>...
 
 =item * B<Controller>
 
@@ -131,7 +131,7 @@ Let's see how Catalyst works, by taking a closer look at the components and othe
 
 =head3 Application Class
 
-In addition to the Model, View, and Controller components, there's a single class that represents your application itself. This is where you configure your application, load plugins, define application-wide actions and extend Catalyst.
+In addition to the Model, View, and Controller components, there's a single class that represents your application itself. This is where you configure your application, load plugins, define application-wide actions, and extend Catalyst.
 
     package MyApp;
 
@@ -171,7 +171,9 @@ However, you can define as many parameters as you want for plugins or whatever y
 
 =head3 Context
 
-Catalyst automatically blesses a Context object into your application class and makes it available everywhere in your application. Use the Context to directly interact with Catalyst and glue your L<Components> together. 
+Catalyst automatically blesses a Context object into your application class and makes it available everywhere in your application. Use the Context to directly interact with Catalyst and glue your L<Components> together. For example, if you need to use the Context from within a Template Toolkit template, it's already there:
+
+    <h1>Welcome to [% c.config.name %]!</h1>
 
 As illustrated earlier in our URL-to-Action dispatching example, the Context is always the second method parameter, behind the Component object reference or class name itself. Previously we called it C<$context> for clarity, but most Catalyst developers just call it C<$c>:
 
index ccf04df..e5720a7 100644 (file)
@@ -7,7 +7,9 @@ Catalyst::Manual::Plugins - Catalyst Plugins (and Components)
 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.
+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.
 
 =head1 PLUGINS
 
@@ -16,11 +18,33 @@ They typically require additional modules from CPAN.
 L<Catalyst::Plugin::Authentication::CDBI> is a CDBI (C<Class::DBI>)
 authentication plugin.  Note that it requires a session plugin.
 
+=head2 Catalyst::Plugin::Authentication::LDAP
+
+L<Catalyst::Plugin::Authentication::LDAP> is a plugin allowing you 
+to authenticate your web users using an LDAP server. 
+
 =head2 Catalyst::Plugin::Email
 
 L<Catalyst::Plugin::Email> sends email with Catalyst and L<Email::Send>
 and L<Email::MIME::Creator>.
 
+=head2 Catalyst::Plugin::Browser
+
+L<Catalyst::Plugin::Browser> extends L<Catalyst::Request> by adding the
+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
+
+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::FillInForm
 
 L<Catalyst::Plugin::FillInForm> is plugin for Catalyst based on
@@ -37,6 +61,11 @@ L<Data::FormValidator> 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<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::I18N
 
@@ -44,7 +73,6 @@ 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::Pluggable
 
 L<Catalyst::Plugin::Pluggable> is a plugin for pluggable Catalyst
@@ -74,7 +102,6 @@ $c->config->{root} >>/<< action >>/.
 L<Catalyst::Plugin::SubRequest> is a plugin to allow subrequests to
 actions to be made within Catalyst.  Nice for portal software and such.
 
-
 =head2 Catalyst::Plugin::Textile
 
 L<Catalyst::Plugin::Textile> is a persistent Textile processor for
@@ -82,6 +109,11 @@ Catalyst that uses C<Text::Textile>, a Perl-based implementation of Dean
 Allen's Textile syntax. Textile is shorthand for doing common formatting
 tasks (see L<http://textism.com>).
 
+=head2 Catalyst::Plugin::Unicode
+
+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::XMLRPC
 
@@ -110,24 +142,44 @@ classes.
 =head2 Catalyst::Model::CDBI::CRUD
 
 L<Catalyst::Model::CDBI::CRUD> is a subclass of 
-C<Catalyst::Model::CDBI> with additional CRUD (create, replace, 
+C<Catalyst::Model::CDBI> with additional CRUD (create, retrieve, 
 update, delete) methods.
 
+=head2 Catalyst::Model::Plucene
+L<Catalyst::Model::Plucene> is the model class for the Plucene
+search engine.
 
-=head2 Catalyst::View::TT
+=head2 Catalyst::View::HTML::Template
 
-L<Catalyst::View::TT> is a Template Toolkit view. See
-L<Template::Manual>.
+L<Catalyst::View::HTML::Template> is a View component for
+displaying your stash with L<HTML::Template>.
+
+=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>.
+
+=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> allows you to render your stash using
-L<HTML::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>.
 
 =head1 AUTHOR
 
 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
 Marcus Ramberg E<lt>mramberg@cpan.orgE<gt>
+Jesse Sheidlower E<lt>jester@panix.comE<gt>
 
 =head1 COPYRIGHT