fix autocomplete error (RT#91544)
[catagits/Catalyst-Manual.git] / lib / Catalyst / Manual / Tutorial / 02_CatalystBasics.pod
index 759d3fc..2319bea 100644 (file)
@@ -200,13 +200,13 @@ C<Ctrl-C> to breakout of the dev server) if you prefer.
     [debug] Statistics enabled
     [debug] Loaded plugins:
     .----------------------------------------------------------------------------.
-    | Catalyst::Plugin::ConfigLoader  0.27                                       |
+    | Catalyst::Plugin::ConfigLoader  0.30                                       |
     '----------------------------------------------------------------------------'
     
     [debug] Loaded dispatcher "Catalyst::Dispatcher"
-    [debug] Loaded engine "Catalyst::Engine::HTTP"
-    [debug] Found home "/home/me/Hello"
-    [debug] Loaded Config "/home/me/Hello/hello.conf"
+    [debug] Loaded engine "Catalyst::Engine"
+    [debug] Found home "/home/catalyst/Hello"
+    [debug] Loaded Config "/home/catalyst/Hello/hello.conf"
     [debug] Loaded components:
     .-----------------------------------------------------------------+----------.
     | Class                                                           | Type     |
@@ -231,8 +231,8 @@ C<Ctrl-C> to breakout of the dev server) if you prefer.
     | /                                   | /default                             |
     '-------------------------------------+--------------------------------------'
     
-    [info] Hello powered by Catalyst 5.80025
-    You can connect to your server at http://debian:3000
+    [info] Hello powered by Catalyst 5.90002
+    HTTP::Server::PSGI: Accepting connections at http://0:3000/
 
 Point your web browser to L<http://localhost:3000> (substituting a
 different hostname or IP address as appropriate) and you should be
@@ -241,15 +241,18 @@ screen or an "Index" screen, you probably forgot to specify port 3000 in
 your URL).  Information similar to the following should be appended to
 the logging output of the development server:
 
-    [info] *** Request 1 (0.001/s) [23194] [Sat Jan 16 11:09:18 2010] ***
-    [debug] "GET" request for "/" from "127.0.0.1"
+    [info] Hello powered by Catalyst 5.90002
+    HTTP::Server::PSGI: Accepting connections at http://0:3000/
+    [info] *** Request 1 (0.067/s) [19026] [Tue Aug 30 17:24:32 2011] ***
+    [debug] "GET" request for "/" from "192.168.245.2"
     [debug] Path is "/"
-    [info] Request took 0.004851s (206.143/s)
+    [debug] Response Code: 200; Content-Type: text/html; charset=utf-8; Content-Length: 5613
+    [info] Request took 0.040895s (24.453/s)
     .------------------------------------------------------------+-----------.
     | Action                                                     | Time      |
     +------------------------------------------------------------+-----------+
-    | /index                                                     | 0.000395s |
-    | /end                                                       | 0.000425s |
+    | /index                                                     | 0.000916s |
+    | /end                                                       | 0.000877s |
     '------------------------------------------------------------+-----------'
 
 B<Note>: Press C<Ctrl-C> to break out of the development server if
@@ -268,7 +271,7 @@ browser.
 
     sub index :Path :Args(0) {
         my ( $self, $c ) = @_;
-        
+    
         # Hello World
         $c->response->body( $c->welcome_message );
     }
@@ -279,7 +282,7 @@ as a "404" message or a redirect, but for now just leave it alone.
 The "C<$c>" here refers to the Catalyst context, which is used to access
 the Catalyst application. In addition to many other things, the Catalyst
 context provides access to "response" and "request" objects. (See
-L<Catalyst>, L<Catalyst::Response>, and
+L<Catalyst::Runtime>, L<Catalyst::Response>, and
 L<Catalyst::Request>)
 
 C<$c-E<gt>response-E<gt>body> sets the HTTP response (see
@@ -308,28 +311,25 @@ way. For example, the URL C<http://hello.com/admin/articles/create> maps
 to the package C<Hello::Controller::Admin::Articles>, and the C<create>
 method.
 
-Add the following subroutine to your C<lib/Hello/Controller/Root.pm>
-file:
+While you leave the C<script/hello_server.pl -r> command running the
+development server in one window (don't forget the "-r" at the end!),
+open another window and add the following subroutine to your
+C<lib/Hello/Controller/Root.pm> file:
 
     sub hello :Global {
         my ( $self, $c ) = @_;
-        
+    
         $c->response->body("Hello, World!");
     }
 
-Once you restart the server, you will need to use the new address
-L<http://localhost:3000/hello> instead of L<http://localhost:3000/> to see the
-changes.
-
 B<TIP>: See Appendix 1 for tips on removing the leading spaces when
 cutting and pasting example code from POD-based documents.
 
-Here you're sending your own string to the webpage.
-
-Save the file, and you should notice the following in your server output:
+Notice in the window running the Development Server that you should
+get output similar to the following:
 
     Saw changes to the following files:
-     - /home/me/Hello/lib/Hello/Controller/Root.pm (modify)
+     - /home/catalyst/Hello/lib/Hello/Controller/Root.pm (modify)
     
     Attempting to restart the server
     ...
@@ -342,17 +342,11 @@ Save the file, and you should notice the following in your server output:
     | /index               | Hello::Controller::Root              | index        |
     | /hello               | Hello::Controller::Root              | hello        |
     '----------------------+--------------------------------------+--------------'
-    
-    [debug] Loaded Path actions:
-    .-------------------------------------+--------------------------------------.
-    | Path                                | Private                              |
-    +-------------------------------------+--------------------------------------+
-    | /                                   | /index                               |
-    | /                                   | /default                             |
-    | /hello                              | /hello                               |
-    '-------------------------------------+--------------------------------------'
     ...
 
+The development server noticed the change in C<Hello::Controller::Root>
+and automatically restarted itself.
+
 Go to L<http://localhost:3000/hello> to see "Hello, World!".   Also
 notice that the newly defined 'hello' action is listed under "Loaded
 Private actions" in the development server debug output.
@@ -362,9 +356,9 @@ Private actions" in the development server debug output.
 
 In the Catalyst world a "View" itself is not a page of XHTML or a
 template designed to present a page to a browser. Rather, it is the
-module that determines the I<type> of view -- HTML, pdf, XML, etc. For
+module that determines the I<type> of view -- HTML, PDF, XML, etc. For
 the thing that generates the I<content> of that view (such as a
-Toolkit Template template file), the actual templates go under the
+Template Toolkit template file), the actual templates go under the
 "root" directory.
 
 To create a TT view, run:
@@ -391,7 +385,7 @@ details on setting this).
 =item *
 
 The final "TT" tells Catalyst the I<type> of the view, with "TT"
-indicating that you want to a Template Toolkit view.
+indicating that you want to use a Template Toolkit view.
 
 =back
 
@@ -402,7 +396,7 @@ Now that the HTML.pm "View" exists, Catalyst will autodiscover it and be
 able to use it to display the view templates using the "process" method
 that it inherits from the C<Catalyst::View::TT> class.
 
-Template Toolkit is a very full featured template facility, with
+Template Toolkit is a very full-featured template facility, with
 excellent documentation at L<http://template-toolkit.org/>, but since
 this is not a TT tutorial, we'll stick to only basic TT usage here (and
 explore some of the more common TT features in later chapters of the
@@ -436,18 +430,18 @@ 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 request cycle. 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- E<gt>body()>
+view to be 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, the development server should automatically
 restart (again, the tutorial is written to assume that you are using the
 "-r" option -- manually restart it if you aren't), and look at
-L<http://localhost:3000/hello> in your again. You should see the
-template that you just made.
+L<http://localhost:3000/hello> in your web browser again. You should see
+the template that you just created.
 
 B<TIP:> If you keep the server running with "-r" in a "background
-window," don't let that window get totally hidden... if you have an
+window," don't let that window get totally hidden... if you have a
 syntax error in your code, the debug server output will contain the
 error information.
 
@@ -480,8 +474,8 @@ Create a controller named "Site" by executing the create script:
     $ script/hello_create.pl controller Site
 
 This will create a C<lib/Hello/Controller/Site.pm> file (and a test
-file). Bring Site.pm up in your editor, and you can see that there's not
-much there.
+file). If you bring Site.pm up in your editor, you can see that
+there's not much there to see.
 
 In C<lib/Hello/Controller/Site.pm>, add the following method:
 
@@ -514,7 +508,7 @@ Make a subdirectory "site" in the "root" directory.
 
     $ mkdir root/site
 
-Create a new template file in that direction named C<root/site/test.tt>
+Create a new template file in that directory named C<root/site/test.tt>
 and include a line like:
 
     <p>Hello, [% username %]!</p>
@@ -526,6 +520,11 @@ your test.tt file displayed, including the name "John" that you set in
 the controller.
 
 
+You can jump to the next chapter of the tutorial here:
+L<More Catalyst Basics|Catalyst::Manual::Tutorial::03_MoreCatalystBasics>
+
+
+
 =head1 AUTHORS
 
 Gerda Shank, C<gerda.shank@gmail.com>
@@ -533,11 +532,8 @@ Kennedy Clark, C<hkclark@gmail.com>
 
 Feel free to contact the author for any errors or suggestions, but the
 best way to report issues is via the CPAN RT Bug system at
-<https://rt.cpan.org/Public/Dist/Display.html?Name=Catalyst-Manual>.
-
-The most recent version of the Catalyst Tutorial can be found at
-L<http://dev.catalyst.perl.org/repos/Catalyst/Catalyst-Manual/5.80/trunk/lib/Catalyst/Manual/Tutorial/>.
+L<https://rt.cpan.org/Public/Dist/Display.html?Name=Catalyst-Manual>.
 
-Copyright 2006-2010, Kennedy Clark, under the
+Copyright 2006-2011, Kennedy Clark, under the
 Creative Commons Attribution Share-Alike License Version 3.0
 (L<http://creativecommons.org/licenses/by-sa/3.0/us/>).