Commit | Line | Data |
fc7ec1d9 |
1 | =head1 NAME |
2 | |
3 | Catalyst::Manual - User guide and reference for Catalyst |
4 | |
5 | =head1 DESCRIPTION |
6 | |
de91d41b |
7 | This is the (table of contents page of the) comprehensive user guide and |
8 | reference for Catalyst. |
9 | |
c8870b8c |
10 | =head1 IMPORTANT NOTE |
11 | |
12 | If you need to read the Catalyst Manual make sure that you have |
5c351af1 |
13 | Catalyst::Manual installed from cpan. To check that it is installed |
14 | run the following command from a unix (bash) prompt: |
c8870b8c |
15 | |
16 | $ perldoc -t Catalyst::Manual::Tutorial::CatalystBasics 2>&1 >/dev/null && echo OK || echo MISSING |
17 | |
18 | If you see "OK" as the output, it's there, if you see "MISSING" you |
2f381252 |
19 | need to install the L<Catalyst::Manual> distribution |
20 | (L<http://search.cpan.org/dist/Catalyst-Manual/>). |
c8870b8c |
21 | |
babd1e28 |
22 | =over 4 |
23 | |
de91d41b |
24 | =item * |
fc7ec1d9 |
25 | |
aa2b0d97 |
26 | L<Catalyst::Manual::About> |
aa2b0d97 |
27 | |
de91d41b |
28 | Explanation (without code) of what Catalyst is and why to use it. |
29 | |
30 | =item * |
31 | |
ab1007f0 |
32 | L<Catalyst::Manual::Intro> |
33 | |
34 | Introduction to Catalyst. This is a detailed, if unsystematic, look at |
35 | the basic concepts of Catalyst and what the best practices are for |
36 | writing applications with it. |
de91d41b |
37 | |
38 | =item * |
fc7ec1d9 |
39 | |
a0bb847e |
40 | L<Catalyst::Manual::Tutorial> |
de91d41b |
41 | |
42 | A detailed step-by-step tutorial going through a single application |
43 | thoroughly. |
44 | |
45 | =item * |
a0bb847e |
46 | |
f4e62d6f |
47 | L<Catalyst::Manual::Plugins> |
de91d41b |
48 | |
49 | Catalyst Plugins and Components. A brief look at some of the very many |
50 | modules for extending Catalyst. |
51 | |
52 | =item * |
f4e62d6f |
53 | |
fc7ec1d9 |
54 | L<Catalyst::Manual::Cookbook> |
de91d41b |
55 | |
56 | Cooking with Catalyst. Recipes and solutions that you might want to use |
57 | in your code. |
58 | |
59 | =item * |
60 | |
61 | L<Catalyst::Manual::Installation> |
62 | |
63 | How to install Catalyst, in a variety of different ways. A closer look |
64 | at one of the more difficult issues of using the framework--getting it. |
65 | |
66 | =item * |
20ef3d59 |
67 | |
68 | L<Catalyst::Manual::WritingPlugins> |
de91d41b |
69 | |
70 | Writing plugins for Catalyst; the use of L<NEXT>. |
71 | |
72 | =item * |
fc7ec1d9 |
73 | |
74 | L<Catalyst::Manual::Internals> |
de91d41b |
75 | |
76 | Here be dragons! A very brief explanation of the Catalyst request cycle, |
77 | the major components of Catalyst, and how you can use this knowledge |
78 | when writing applications under Catalyst. |
fc7ec1d9 |
79 | |
0d201f15 |
80 | =back |
81 | |
3cb1db8c |
82 | =head1 SUPPORT |
83 | |
84 | IRC: |
85 | |
86 | Join #catalyst on irc.perl.org. |
87 | |
88 | Mailing-Lists: |
89 | |
6d4c3368 |
90 | http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst |
91 | http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev |
3cb1db8c |
92 | |
2f381252 |
93 | =head1 AUTHORS |
fc7ec1d9 |
94 | |
2f381252 |
95 | Catalyst Contributors, see Catalyst.pm |
fc7ec1d9 |
96 | |
97 | =head1 COPYRIGHT |
98 | |
de91d41b |
99 | This program is free software, you can redistribute it and/or modify it |
100 | under the same terms as Perl itself. |
2f381252 |
101 | |
102 | =cut |