added cookbook example for localtime.

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

diff --git a/lib/Catalyst/Helper.pm b/lib/Catalyst/Helper.pm
index 3db98d0..d50fb16 100644 (file)
--- a/lib/Catalyst/Helper.pm
+++ b/lib/Catalyst/Helper.pm
@@ -192,6 +192,10 @@ server [options]
    -help    display this help and exits
    -port    port (defaults to 3000)
 
+ See also:
+   perldoc Catalyst::Manual
+   perldoc Catalyst::Manual::Intro
+
 =head1 DESCRIPTION
 
 Run a Catalyst Testserver for this application.
@@ -253,8 +257,12 @@ test [options] uri
    -help    display this help and exits
 
  Examples:
-   test http://localhost/some_action
-   test /some_action
+   perl test http://localhost/some_action
+   perl test /some_action
+
+ See also:
+   perldoc Catalyst::Manual
+   perldoc Catalyst::Manual::Intro
 
 =head1 DESCRIPTION
 
@@ -308,15 +316,23 @@ create - Create a new Catalyst Component
 
 =head1 SYNOPSIS
 
-create [options] model|view|controller name
+create [options] model|view|controller name [helper] [options]
 
  Options:
    -help    display this help and exits
 
  Examples:
-   create controller My::Controller
-   create model My::Model
-   create view My::View
+   perl create controller My::Controller
+   perl create view My::View
+   perl create view MyView TT
+   perl create view TT TT
+   perl create model My::Model
+   perl create model SomeDB CDBI dbi:SQLite:/tmp/my.db
+   perl create model AnotherDB CDBI dbi:Pg:dbname=foo root 4321
+
+ See also:
+   perldoc Catalyst::Manual
+   perldoc Catalyst::Manual::Intro
 
 =head1 DESCRIPTION
 
@@ -492,6 +508,26 @@ EOF
     }
 }
 
+=head1 HELPERS
+
+Helpers are classes that provide two methods.
+
+    * mk_compclass - creates the Component class
+    * mk_comptest  - creates the Component test
+
+So when you call C<bin/create view MyView TT>, create would try to execute
+Catalyst::Helper::View::TT->mk_compclass and
+Catalyst::Helper::View::TT->mk_comptest.
+
+See L<Catalyst::Helper::View::TT> and L<Catalyst::Helper::Model::CDBI> for
+examples.
+
+All helper classes should be under one of the following namespaces.
+
+    Catalyst::Helper::Model::
+    Catalyst::Helper::View::
+    Catalyst::Helper::Controller::
+
 =head1 SEE ALSO
 
 L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,