[catagits/Catalyst-Runtime.git] / lib / Catalyst / Manual.pm

=head1 NAME

Catalyst::Manual - User guide and reference for Catalyst

=head1 DESCRIPTION

This is the (table of contents page of the) comprehensive user guide and
reference for Catalyst.

=head1 IMPORTANT NOTE

If you need to read the Catalyst Manual make sure that you have
Catalyst::Manual installed from cpan.  To check that it is installed
run the following command from a unix (bash) prompt:

 $ perldoc -t Catalyst::Manual::Tutorial::CatalystBasics 2>&1 >/dev/null && echo OK || echo MISSING

If you see "OK" as the output, it's there, if you see "MISSING" you
need to install the
L<Catalyst::Manual|http://search.cpan.org/search?query=Catalyst%3A%3AManual&mode=dist>
distribution.

=over 4

=item *

L<Catalyst::Manual::About>

Explanation (without code) of what Catalyst is and why to use it.

=item *

L<Catalyst::Manual::Intro>

Introduction to Catalyst. This is a detailed, if unsystematic, look at 
the basic concepts of Catalyst and what the best practices are for 
writing applications with it.

=item *

L<Catalyst::Manual::Tutorial>

A detailed step-by-step tutorial going through a single application
thoroughly.

=item *

L<Catalyst::Manual::Plugins>

Catalyst Plugins and Components. A brief look at some of the very many
modules for extending Catalyst.

=item *

L<Catalyst::Manual::Cookbook>

Cooking with Catalyst. Recipes and solutions that you might want to use
in your code.

=item *

L<Catalyst::Manual::Installation>

How to install Catalyst, in a variety of different ways. A closer look
at one of the more difficult issues of using the framework--getting it.

=item *

L<Catalyst::Manual::WritingPlugins>

Writing plugins for Catalyst; the use of L<NEXT>.

=item *

L<Catalyst::Manual::Internals>

Here be dragons! A very brief explanation of the Catalyst request cycle,
the major components of Catalyst, and how you can use this knowledge
when writing applications under Catalyst.

=back

=head1 SUPPORT

IRC:

    Join #catalyst on irc.perl.org.

Mailing-Lists:

    http://lists.rawmode.org/mailman/listinfo/catalyst
    http://lists.rawmode.org/mailman/listinfo/catalyst-dev

=head1 AUTHORS

Catalyst Contributors, see Catalyst.pm

=head1 COPYRIGHT

This program is free software, you can redistribute it and/or modify it
under the same terms as Perl itself.

=cut
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
5c351af1	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
	19	need to install the
5c351af1	20	L<Catalyst::Manual\|http://search.cpan.org/search?query=Catalyst%3A%3AManual&mode=dist>
5c351af1	21	distribution.
c8870b8c	22
babd1e28	23	=over 4
babd1e28	24
de91d41b	25	=item *
fc7ec1d9	26
aa2b0d97	27	L<Catalyst::Manual::About>
aa2b0d97	28
de91d41b	29	Explanation (without code) of what Catalyst is and why to use it.
	30
	31	=item *
	32
ab1007f0	33	L<Catalyst::Manual::Intro>
	34
	35	Introduction to Catalyst. This is a detailed, if unsystematic, look at
	36	the basic concepts of Catalyst and what the best practices are for
	37	writing applications with it.
de91d41b	38
de91d41b	39	=item *
fc7ec1d9	40
a0bb847e	41	L<Catalyst::Manual::Tutorial>
de91d41b	42
	43	A detailed step-by-step tutorial going through a single application
	44	thoroughly.
	45
	46	=item *
a0bb847e	47
f4e62d6f	48	L<Catalyst::Manual::Plugins>
de91d41b	49
	50	Catalyst Plugins and Components. A brief look at some of the very many
	51	modules for extending Catalyst.
	52
	53	=item *
f4e62d6f	54
fc7ec1d9	55	L<Catalyst::Manual::Cookbook>
de91d41b	56
	57	Cooking with Catalyst. Recipes and solutions that you might want to use
	58	in your code.
	59
	60	=item *
	61
	62	L<Catalyst::Manual::Installation>
	63
	64	How to install Catalyst, in a variety of different ways. A closer look
	65	at one of the more difficult issues of using the framework--getting it.
	66
	67	=item *
20ef3d59	68
20ef3d59	69	L<Catalyst::Manual::WritingPlugins>
de91d41b	70
	71	Writing plugins for Catalyst; the use of L<NEXT>.
	72
	73	=item *
fc7ec1d9	74
fc7ec1d9	75	L<Catalyst::Manual::Internals>
de91d41b	76
	77	Here be dragons! A very brief explanation of the Catalyst request cycle,
	78	the major components of Catalyst, and how you can use this knowledge
	79	when writing applications under Catalyst.
fc7ec1d9	80
0d201f15	81	=back
0d201f15	82
3cb1db8c	83	=head1 SUPPORT
	84
	85	IRC:
	86
	87	Join #catalyst on irc.perl.org.
	88
	89	Mailing-Lists:
	90
	91	http://lists.rawmode.org/mailman/listinfo/catalyst
	92	http://lists.rawmode.org/mailman/listinfo/catalyst-dev
	93
0bf7ab71	94	=head1 AUTHORS
fc7ec1d9	95
0bf7ab71	96	Catalyst Contributors, see Catalyst.pm
fc7ec1d9	97
	98	=head1 COPYRIGHT
	99
de91d41b	100	This program is free software, you can redistribute it and/or modify it
de91d41b	101	under the same terms as Perl itself.
0bf7ab71	102
0bf7ab71	103	=cut