[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 AUTHOR

Sebastian Riedel, C<sri@oook.de>
Jesse Sheidlower, C<jester@panix.com>

=head1 COPYRIGHT

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