Suggestions and fixes with thanks to Murray Walker (along with a few other minor...
[catagits/Catalyst-Manual.git] / lib / Catalyst / Manual / Tutorial / CatalystBasics.pod
index 1de9f96..b288293 100644 (file)
@@ -220,8 +220,7 @@ server:
     [info] Hello powered by Catalyst 5.7014
     You can connect to your server at http://localhost:3000
 
-Point your web browser to 
-L<http://localhost:3000|http://localhost:3000> (substituting a 
+Point your web browser to L<http://localhost:3000> (substituting a 
 different hostname or IP address as appropriate) and you should be 
 greeted by the Catalyst welcome screen.  Information similar to the 
 following should be appended to the logging output of the development 
@@ -323,13 +322,28 @@ To create a TT view, run:
     $ script/hello_create.pl view TT TT
 
 This creates the C<lib/Hello/View/TT.pm> module, which is a subclass of 
-C<Catalyst::View::TT>. The "view" keyword tells the create script that 
-you are creating a view, the second "TT" tells it that you are creating 
-a Template Toolkit view, and the first "TT" tells the script to name 
-the View module "TT.pm", which is a commonly used name for TT views. 
-(You can name it anything you want, such as "HTML.pm".) If you look at 
-TT.pm, you will find that it only contains a config statement to set 
-the TT extension to ".tt".
+C<Catalyst::View::TT>. 
+
+=over 4
+
+=item *
+
+The "view" keyword tells the create script that you are creating a view.
+
+=item *
+
+The first "TT" tells the script to name the View module "TT.pm", which is a
+commonly used name for TT views.  (You can name it anything you want, such as
+"HTML.pm".)
+
+=item *
+
+The final "TT" tells it that you are creating a Template Toolkit view.
+
+=back
+
+If you look at C<lib/Hello/View/TT.pm> you will find that it only contains a
+config statement to set the TT extension to ".tt".
 
 Now that the TT.pm "View" exists, Catalyst will autodiscover it and be 
 able to use it to display the view templates, using the "process" 
@@ -345,15 +359,17 @@ Create a C<root/hello.tt> template file (put it in the C<root> under
 the C<Hello> directory that is the base of your application). Here is 
 a simple sample:
   
-    [% META title = 'Hello, World!' %]
     <p>
-        This is a TT view template, located in the 'root/' directory.
+        This is a TT view template, called '[% template.name %]'.
     </p>
 
 [% and %] are markers for the TT parts of the template. Inside you can 
-access Perl variables and classes, and use TT directives. The rest of 
-the template is normal HTML. Change the hello method in 
-C<lib/Hello/Controller/Root.pm> to the following:
+access Perl variables and classes, and use TT directives. In this 
+case, we're using a special TT variable that defines the name of the 
+template file (C<hello.tt>).  The rest of the template is normal HTML. 
+
+Change the hello method in C<lib/Hello/Controller/Root.pm> to the 
+following:
 
     sub hello : Global {
         my ( $self, $c ) = @_;
@@ -361,13 +377,13 @@ C<lib/Hello/Controller/Root.pm> to the following:
         $c->stash->{template} = 'hello.tt';
     }
 
-This time, instead of doing C<$c-E<gt>response->body()>, you are setting 
+This time, instead of doing C<$c-E<gt>response-E<gt>body()>, you are setting 
 the value of the "template" hash key in the Catalyst "stash", an area 
 for putting information to share with other parts of your application. 
 The "template" key determines which template will be displayed at the 
 end of the method. Catalyst controllers have a default "end" action 
 for all methods which causes the first (or default) view to be 
-rendered (unless there's a C<$c-E<gt>response->body()> statement). So your 
+rendered (unless there's a C<$c-E<gt>response-E<gt>body()> statement). So your 
 template will be magically displayed at the end of your method.
 
 After saving the file, restart the development server, and look at 
@@ -395,16 +411,23 @@ In C<lib/Hello/Controller/Site.pm>, add the following method:
         $c->stash->{template} = 'site/test.tt';
     }
 
-Notice the "Local" attribute on the method. This will allow the action 
-to be executed on the "controller/method" URL, or, in this case, 
-"site/test", instead of at the root site URL, like "Global". It's not 
-actually necessary to set the template value, since by default TT will 
-attempt to render a template that follows the naming pattern 
-"controller/method.tt", and we're following that pattern here, but in 
-other situations you will need to specify the template (such as if 
-you've "forwarded" to the method, or if it doesn't follow the default 
-naming convention). We've also put the variable "name" into the stash, 
-for use in the template.
+Notice the "Local" attribute on the C<test> method. This will cause 
+the C<test> action (now that we have assigned an action type to the 
+method it appears as a controller "action" to Catalyst) to be executed 
+on the "controller/method" URL, or, in this case, "site/test".  We 
+will see additional information on controller actions throughout the 
+rest of the tutorial, but if you are curious take a look at 
+L<Catalyst::Manual::Intro/Actions>.
+
+It's not actually necessary to set the template value as we do here. 
+By default TT will attempt to render a template that follows the 
+naming pattern "controller/method.tt", and we're following that 
+pattern here. However, in other situations you will need to specify 
+the template (such as if you've "forwarded" to the method, or if it 
+doesn't follow the default naming convention).
+
+We've also put the variable "username" into the stash, for use in the 
+template.
 
 Make a subdirectory "site" in the "root" directory. Copy the hello.tt 
 file into the directory as C<root/site/test.tt>, or create a new