lib/Catalyst/Manual.pm

   1 =head1 NAME
   2
   3 Catalyst::Manual - User guide and reference for Catalyst
   4
   5 =head1 DESCRIPTION
   6
   7 This is the (table of contents page of the) comprehensive user guide and
   8 reference for Catalyst.
   9
  10 =over 4
  11
  12 =head1 IMPORTANT NOTE
  13
  14 If you need to read the Catalyst Manual make sure that you have
  15 Catalyst::Manual installed from cpan.  To check that it is installed run the following command from a unix (bash) prompt:
  16
  17  $ perldoc -t Catalyst::Manual::Tutorial::CatalystBasics 2>&1 >/dev/null && echo OK || echo MISSING
  18
  19 If you see "OK" as the output, it's there, if you see "MISSING" you
  20 need to install the
  21 L<Catalyst::Manual|http://search.cpan.org/search?query=Catalyst%3A%3AManual&mode=dist> distribution.
  22
  23 =item *
  24
  25 L<Catalyst::Manual::About>
  26
  27 Explanation (without code) of what Catalyst is and why to use it.
  28
  29 =item *
  30
  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.
  36
  37 =item *
  38
  39 L<Catalyst::Manual::Tutorial>
  40
  41 A detailed step-by-step tutorial going through a single application
  42 thoroughly.
  43
  44 =item *
  45
  46 L<Catalyst::Manual::Plugins>
  47
  48 Catalyst Plugins and Components. A brief look at some of the very many
  49 modules for extending Catalyst.
  50
  51 =item *
  52
  53 L<Catalyst::Manual::Cookbook>
  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 *
  66
  67 L<Catalyst::Manual::WritingPlugins>
  68
  69 Writing plugins for Catalyst; the use of L<NEXT>.
  70
  71 =item *
  72
  73 L<Catalyst::Manual::Internals>
  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.
  78
  79 =back
  80
  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
  92 =head1 AUTHOR
  93
  94 Sebastian Riedel, C<sri@oook.de>
  95 Jesse Sheidlower, C<jester@panix.com>
  96
  97 =head1 COPYRIGHT
  98
  99 This program is free software, you can redistribute it and/or modify it
 100 under the same terms as Perl itself.