updated Catalyst::Manual::Plugins doc to cover C:P:SubRequest
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Manual / Plugins.pod
1 =head1 NAME
2
3 Catalyst::Manual::Plugins - Catalyst Plugins (and Components)
4
5 =head1 DESCRIPTION
6
7 This section lists the some of the plugins and components that are available
8 to extend the runtime functionality of the Catalyst. The plugins are not
9 distributed with Catalyst but should be available from CPAN.  They mostly
10 required additional modules from CPAN.
11
12 =head1 PLUGINS
13
14 =head2 Catalyst::Plugin::Authentication::CDBI
15
16 This is a CDBI (C<Class::DBI>) authentication plugin.  Note that it requires a
17 session plugin.
18
19 =head2 Catalyst::Plugin::Email
20
21 Send emails with Catalyst and L<Email::Send> and L<Email::MIME::Creator>.
22
23 =head2 Catalyst::Plugin::FillInForm
24
25 Fill-in form plugin for Catalyst based on C<HTML::FillInForm>, which describes
26 itself as a module to automatically insert data from a previous HTML form into
27 the HTML input, textarea, radio buttons, checkboxes and select tags.
28 C<HTML::FillInForm> is a subclass of C<HTML::Parser> and uses it to parse the
29 HTML and insert the values into the form tags.
30
31 =head2 Catalyst::Plugin::FormValidator
32
33 A form validator plugin that uses L<Data::FormValidator> to validate and set up
34 form data from your request parameters.  It's a quite thin wrapper around that
35 module, so most of the relevant information can be found there.
36
37
38 =head2 Catalyst::Plugin::I18N
39
40 An internationalization plugin for Catalyst.  Supports C<mo>/C<po> files and
41 Maketext classes under your applications I18N namespace.
42
43
44 =head2 Catalyst::Plugin::Pluggable
45
46 A plugin for pluggable Catalyst applications.
47
48 =head2 Catalyst::Plugin::Prototype
49
50 Plugin for the Prototype JavaScript library.
51
52 =head2 Catalyst::Plugin::Session::FastMmap
53
54 A session plugin for Catalyst based on C<Cache::FastMMap>, which uses an
55 mmap'ed file to act as a shared memeory interprocess cache.
56
57
58 =head2 Catalyst::Plugin::Static
59
60 A plugin to serve static files from C<< $c->config->{root} >>.
61
62
63 =head2 Catalyst::Plugin::SubRequest
64
65 Plugin to allow subrequests to actions to be made within Catalyst.
66
67
68 =head2 Catalyst::Plugin::Textile
69
70 A persistent Textile processor for Catalyst that uses C<Text::Textile>, a
71 Perl-based implementation of Dean Allen's Textile syntax. Textile is shorthand
72 for doing common formatting tasks (see L<http://textism.com>).
73
74
75 =head2 Catalyst::Plugin::XMLRPC
76
77 This plugin allows your controller class to dispatch XMLRPC methods
78 from its own class.
79
80
81 =head1 COMPONENT MODULES
82
83 =head2 Catalyst::Model::CDBI
84
85 C<Catalyst::Model::CDBI> is the C<Class::DBI> (CDBI) moduel class.  It iss
86 built on top of C<Class::DBI::Loader>, which automates the definition of
87 C<Class::DBI> sub-classes by scanning the underlying table schemas, setting up
88 columns and primary keys.
89
90 =head2 Catalyst::Model::CDBI::CRUD
91
92 C<Catalyst::Model::CDBI::CRUD> is a subclass of C<Catalyst::Model::CDBI> with
93 additional CRUD (create, replace, update, delete) methods.
94
95
96 =head2 Catalyst::View::Template
97
98 A Template Toolkit view class.
99
100
101 =head1 AUTHOR
102
103 Andrew Ford E<lt>A.Ford@ford-mason.co.ukE<gt>
104
105 =head1 COPYRIGHT
106
107 This program is free software, you can redistribute it and/or modify it under
108 the same terms as Perl itself.