doc patch from Andrew Ford

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

diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm
index 88254bc..d205183 100644 (file)
--- a/lib/Catalyst.pm
+++ b/lib/Catalyst.pm
@@ -7,7 +7,7 @@ use Catalyst::Log;
 
 __PACKAGE__->mk_classdata($_) for qw/_config log/;
 
-our $VERSION = '4.00';
+our $VERSION = '4.28';
 our @ISA;
 
 =head1 NAME
@@ -17,22 +17,19 @@ Catalyst - The Elegant MVC Web Application Framework
 =head1 SYNOPSIS
 
     # use the helper to start a new application
-    catalyst MyApp
+    catalyst.pl MyApp
     cd MyApp
 
     # add models, views, controllers
-    bin/create model Something
-    bin/create view Stuff
-    bin/create controller Yada
+    script/create.pl model Something
+    script/create.pl view Stuff
+    script/create.pl controller Yada
 
     # built in testserver
-    bin/server
+    script/server.pl
 
     # command line interface
-    bin/test /yada
-
-
-    See also L<Catalyst::Manual::Intro>
+    script/test.pl /yada
 
 
     use Catalyst;
@@ -61,6 +58,8 @@ Catalyst - The Elegant MVC Web Application Framework
         }
     );
 
+See also L<Catalyst::Manual::Intro>
+
 =head1 DESCRIPTION
 
 Catalyst is based upon L<Maypole>, which you should consider for smaller
@@ -70,37 +69,49 @@ The key concept of Catalyst is DRY (Don't Repeat Yourself).
 
 See L<Catalyst::Manual> for more documentation.
 
-Omit the Catalyst::Plugin:: prefix from plugins.
-So Catalyst::Plugin::My::Module becomes My::Module.
+Catalyst plugins can be loaded by naming them as arguments to the "use Catalyst" statement.
+Omit the C<Catalyst::Plugin::> prefix from the plugin name, 
+so C<Catalyst::Plugin::My::Module> becomes C<My::Module>.
 
     use Catalyst 'My::Module';
 
-You can also set special flags like -Debug and -Engine.
+Special flags like -Debug and -Engine can also be specifed as arguments when
+Catalyst is loaded:
 
     use Catalyst qw/-Debug My::Module/;
 
-The position of plugins and flags in the chain is important,
-because they are loaded in the same order they appear.
+The position of plugins and flags in the chain is important, because they are
+loaded in exactly the order that they appear.
+
+The following flags are supported:
 
-=head2 -Debug
+=over 4
+
+=item -Debug
+
+enables debug output, i.e.:
 
     use Catalyst '-Debug';
 
-is equivalent to
+this is equivalent to:
 
     use Catalyst;
     sub debug { 1 }
 
-=head2 -Engine
+=item -Engine
 
 Force Catalyst to use a specific engine.
-Omit the Catalyst::Engine:: prefix.
+Omit the C<Catalyst::Engine::> prefix of the engine name, i.e.:
 
     use Catalyst '-Engine=CGI';
 
-=head2 METHODS
+=back
+
+=head1 METHODS
+
+=over 4
 
-=head3 debug
+=item debug
 
 Overload to enable debug messages.
 
@@ -108,7 +119,7 @@ Overload to enable debug messages.
 
 sub debug { 0 }
 
-=head3 config
+=item config
 
 Returns a hashref containing your applications settings.
 
@@ -162,7 +173,8 @@ sub import {
             else {
                 $caller->log->debug(qq/Loaded plugin "$plugin"/)
                   if $caller->debug;
-                unshift @ISA, $plugin;
+                no strict 'refs';
+                push @{"$caller\::ISA"}, $plugin;
             }
         }
     }
@@ -172,10 +184,26 @@ sub import {
       if $ENV{CATALYST_ENGINE};
     $engine->require;
     die qq/Couldn't load engine "$engine", "$@"/ if $@;
-    push @ISA, $engine;
+    {
+        no strict 'refs';
+        push @{"$caller\::ISA"}, $engine;
+    }
     $caller->log->debug(qq/Loaded engine "$engine"/) if $caller->debug;
 }
 
+=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 SEE ALSO
 
 L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
@@ -187,8 +215,9 @@ Sebastian Riedel, C<sri@oook.de>
 
 =head1 THANK YOU
 
-Danijel Milicevic, David Naughton, Gary Ashton Jones, Jesse Sheidlower,
-Marcus Ramberg and all the others who've helped.
+Andrew Ruthven, Christian Hansen, Christopher Hicks, Danijel Milicevic,
+David Naughton, Gary Ashton Jones, Jesse Sheidlower, Johan Lindstrom,
+Marcus Ramberg, Tatsuhiko Miyagawa and all the others who've helped.
 
 =head1 LICENSE