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 =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
  14 run the following command from a unix (bash) prompt:
  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
  20 L<Catalyst::Manual|http://search.cpan.org/search?query=Catalyst%3A%3AManual&mode=dist>
  21 distribution.
  22
  23 =over 4
  24
  25 =item *
  26
  27 L<Catalyst::Manual::About>
  28
  29 Explanation (without code) of what Catalyst is and why to use it.
  30
  31 =item *
  32
  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.
  38
  39 =item *
  40
  41 L<Catalyst::Manual::Tutorial>
  42
  43 A detailed step-by-step tutorial going through a single application
  44 thoroughly.
  45
  46 =item *
  47
  48 L<Catalyst::Manual::Plugins>
  49
  50 Catalyst Plugins and Components. A brief look at some of the very many
  51 modules for extending Catalyst.
  52
  53 =item *
  54
  55 L<Catalyst::Manual::Cookbook>
  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 *
  68
  69 L<Catalyst::Manual::WritingPlugins>
  70
  71 Writing plugins for Catalyst; the use of L<NEXT>.
  72
  73 =item *
  74
  75 L<Catalyst::Manual::Internals>
  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.
  80
  81 =back
  82
  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
  94 =head1 AUTHOR
  95
  96 Sebastian Riedel, C<sri@oook.de>
  97 Jesse Sheidlower, C<jester@panix.com>
  98
  99 =head1 COPYRIGHT
 100
 101 This program is free software, you can redistribute it and/or modify it
 102 under the same terms as Perl itself.