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 L<Catalyst::Manual> distribution
  20 (L<http://search.cpan.org/dist/Catalyst-Manual/>).
  21
  22 =over 4
  23
  24 =item *
  25
  26 L<Catalyst::Manual::About>
  27
  28 Explanation (without code) of what Catalyst is and why to use it.
  29
  30 =item *
  31
  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.
  37
  38 =item *
  39
  40 L<Catalyst::Manual::Tutorial>
  41
  42 A detailed step-by-step tutorial going through a single application
  43 thoroughly.
  44
  45 =item *
  46
  47 L<Catalyst::Manual::Plugins>
  48
  49 Catalyst Plugins and Components. A brief look at some of the very many
  50 modules for extending Catalyst.
  51
  52 =item *
  53
  54 L<Catalyst::Manual::Cookbook>
  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 *
  67
  68 L<Catalyst::Manual::WritingPlugins>
  69
  70 Writing plugins for Catalyst; the use of L<NEXT>.
  71
  72 =item *
  73
  74 L<Catalyst::Manual::Internals>
  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.
  79
  80 =back
  81
  82 =head1 SUPPORT
  83
  84 IRC:
  85
  86     Join #catalyst on irc.perl.org.
  87
  88 Mailing-Lists:
  89
  90     http://lists.rawmode.org/mailman/listinfo/catalyst
  91     http://lists.rawmode.org/mailman/listinfo/catalyst-dev
  92
  93 =head1 AUTHORS
  94
  95 Catalyst Contributors, see Catalyst.pm
  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.
 101
 102 =cut