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