Update URL for latest copy in SVN to match new location of repo
[catagits/Catalyst-Manual.git] / lib / Catalyst / Manual / Tutorial / Intro.pod
index 4d735f2..9744f55 100644 (file)
@@ -5,7 +5,7 @@ Catalyst::Manual::Tutorial::Intro - Catalyst Tutorial - Part 1: Introduction
 
 =head1 OVERVIEW
 
-This is B<Part 2 of 10> for the Catalyst tutorial.
+This is B<Part 1 of 10> for the Catalyst tutorial.
 
 L<Tutorial Overview|Catalyst::Manual::Tutorial>
 
@@ -82,10 +82,16 @@ ensure that your system is set up correctly, and that you have not
 inadvertently made any typographic errors, or accidentally skipped
 part of the tutorial.>
 
-Additionally, if you're reading this manual online, you can download
-the example program and all the necessary dependencies to
-your local machine by installing the C<Task::Catalyst::Tutorial>
-distribution from CPAN:
+B<NOTE: You can use any perl-supported OS and environment to run 
+Catalyst.> It should make little or no difference to Catalyst's 
+operation, but this tutorial has been written using Ubuntu 8.10 
+because that represents a quick and easy for most people to try out 
+Catalyst with virtually zero setup time and hassles.  See the Catalyst 
+installation section below for more information.
+
+If you're reading this manual online, you can download the example 
+program and all the necessary dependencies to your local machine by 
+installing the C<Task::Catalyst::Tutorial> distribution from CPAN:
 
      cpan Task::Catalyst::Tutorial
 
@@ -93,7 +99,7 @@ This will also test to make sure the dependencies are working.  If you
 have trouble installing these, please ask for help on the #catalyst
 IRC channel, or the Catalyst mailing list.
 
-Subjects covered include:
+Subjects covered by the tutorial include:
 
 =over 4
 
@@ -124,14 +130,12 @@ Attempts to provide an example showing current (5.7XXX) Catalyst
 practices. For example, the use of 
 L<Catalyst::Action::RenderView|Catalyst::Action::RenderView>,
 DBIC, L<Catalyst::Plugin::ConfigLoader|Catalyst::Plugin::ConfigLoader> 
-with C<myapp.yml>, the use of C<lib/MyApp/Controller/Root.pm> 
+with C<myapp.conf>, the use of C<lib/MyApp/Controller/Root.pm> 
 vs. C<lib/MyApp.pm>, etc.
 
 =item * 
 
-The use of Template Toolkit (TT) and the
-L<Catalyst::Helper::View::TTSite|Catalyst::Helper::View::TTSite> 
-view helper.
+The use of Template Toolkit (TT).
 
 =item * 
 
@@ -172,6 +176,7 @@ through the Catalyst web site and at
 L<http://dev.catalyst.perl.org/wiki/UserIntroductions> and
 L<http://dev.catalyst.perl.org/>.
 
+
 =head1 VERSIONS AND CONVENTIONS USED IN THIS TUTORIAL
 
 This tutorial was built using the following resources. Please note that
@@ -182,19 +187,19 @@ versions:
 
 =item * 
 
-Ubuntu 8.04 Hardy Heron
+Ubuntu 8.10 (Intrepid Ibex)
 
 =item * 
 
-Catalyst v5.7011
+Catalyst v5.7014
 
 =item *
 
-Catalyst::Devel v1.03
+Catalyst::Devel v1.07
 
 =item * 
 
-DBIx::Class v0.08008
+DBIx::Class v0.08010
 
 =item * 
 
@@ -209,11 +214,7 @@ use. This tutorial has been tested against the following set of plugins:
 
 =item * 
 
-Catalyst::Plugin::Authentication -- v0.10002
-
-=item *
-
-Catalyst::Plugin::Authentication::Store::DBIC -- v0.09
+Catalyst::Plugin::Authentication -- v0.10006
 
 =item *
 
@@ -225,23 +226,23 @@ Catalyst::Plugin::Authorization::Roles -- v0.05
 
 =item *
 
-Catalyst::Plugin::ConfigLoader -- v0.17
+Catalyst::Plugin::ConfigLoader -- v0.20
 
 =item *
 
-Catalyst::Plugin::Session -- v0.18
+Catalyst::Plugin::Session -- v0.19
 
 =item *
 
-Catalyst::Plugin::Session::State::Cookie -- v0.08
+Catalyst::Plugin::Session::State::Cookie -- v0.09
 
 =item *
 
-Catalyst::Plugin::Session::Store::FastMmap -- v0.03
+Catalyst::Plugin::Session::Store::FastMmap -- v0.05
 
 =item *
 
-Catalyst::Plugin::StackTrace -- v0.06
+Catalyst::Plugin::StackTrace -- v0.08
 
 =item *
 
@@ -251,6 +252,14 @@ Catalyst::Plugin::Static::Simple -- v0.20
 
 =item * 
 
+B<NOTE:> You can check the versions you have installed with the
+following command:
+
+    perl -ME<lt>mod_nameE<gt> -e '"print $E<lt>mod_nameE<gt>::VERSION\n"'
+
+For example:
+    perl -MCatalyst::Plugin::StackTrace -e 'print "$Catalyst::Plugin::StackTrace::VERSION\n"'
+
 Since the web browser is being used on the same box where Perl and the
 Catalyst development server is running, the URL of
 C<http://localhost:3000> will be used (the Catalyst development server
@@ -261,24 +270,27 @@ will need to update the URL you use accordingly.
 
 =item * 
 
-Depending on the web browser you are using, you might need to hit
-C<Shift+Reload> to pull a fresh page when testing your application at
-various points.  Also, the C<-k> keepalive option to the development
-server can be necessary with some browsers (especially Internet
-Explorer).
+Depending on the web browser you are using, you might need to hit 
+C<Shift+Reload> or C<Ctrl+Reload> to pull a fresh page when testing 
+your application at various points (see 
+L<http://en.wikipedia.org/wiki/Bypass_your_cache> for a comprehensive
+list of options for each browser).  Also, the C<-k> keepalive option 
+to the development server can be necessary with some browsers 
+(especially Internet Explorer).
 
 =back
 
+
 =head1 CATALYST INSTALLATION
 
-If approach in the wrong manner, it can be a daunting tasks to get
-Catalyst initally installed.  Although a compelling strength of
-Catalyst is that it makes use of many of the modules in the
-vast repository that is CPAN, this can complicate the installation
-process.  However, there are a growing number of methods 
-that can dramatically ease this undertaking.  Of these, the following 
-are likely to be applicable to the largest number of potential new 
-users:
+While the rough edges of Catalyst installation have been a problem in
+the past, this is now mostly solved.  Nonetheless, installing Catalyst
+can be a little time consuming. Although a compelling strength of
+Catalyst is that it makes use of many of the modules in the vast
+repository that is CPAN, this can complicate the installation process.
+However, there are a growing number of methods that can dramatically
+ease this undertaking.  Of these, the following are likely to be
+applicable to the largest number of potential new users:
 
 =over 4
 
@@ -286,7 +298,7 @@ users:
 
 Ubuntu
 
-Given the popularity of Ubuntu and it's ease of use, Ubuntu can be 
+Given the popularity of Ubuntu and its ease of use, Ubuntu can be 
 a great way for newcomers to experiment with Catalyst.  Because it 
 is a "live CD," you can simply boot from the CD, run a few commands,
 and you should have a fully functional environment in which to do 
@@ -296,19 +308,20 @@ this tutorial in a matter of minutes.
 
 =item * 
 
-Download Ubuntu 8.04 (aka, Hardy Heron) and boot from the CD and/or
-image file, select your language, and then "Try Ubuntu without any
-changes to your computer."
+Download Ubuntu 8.10 (aka, Intrepid Ibex) Desktop edition and boot from 
+the CD and/or image file, select your language, and then "Try Ubuntu 
+without any changes to your computer."
 
 =item *
 
-Open a terminal session.
+Open a terminal session (click "Applications" in the upper-left 
+corner, then "Accessories," then "Terminal").
 
 =item *
 
 Add the 'universe' repositories:
 
-    sudo vi /etc/apt/sources.list
+    sudo gedit /etc/apt/sources.list
 
 And remove the comments from the lines under the comments about the
 'universe' repositories.
@@ -318,11 +331,18 @@ And remove the comments from the lines under the comments about the
 Install Catalyst:
 
     sudo apt-get update
-    sudo apt-get upgrade
-    sudo apt-get install sqlite3 libdbd-sqlite3-perl libcatalyst-perl libcatalyst-modules-perl
+    sudo apt-get install libdbd-sqlite3-perl libcatalyst-perl libcatalyst-modules-perl libconfig-general-perl
 
 Accept all of the dependencies.  Done.
 
+NOTE: If you are low on disk space after the above commands (use C<df /> 
+to tell), you can free up some space with 
+C<sudo rm /var/cache/apt/archives/*.deb> (the Live CD uses memory for 
+disk space, so having a decent amount of memory will help).  And, 
+while the instructions above mention the Live CD because that makes it 
+easy for people new to Linux, you can obviously also use one of the 
+options to install Ubuntu on your drive.
+
 =back
 
 =item * 
@@ -352,6 +372,16 @@ of VMWare images where an entire Catalyst development environment has
 already been installed, complete with database engines and a full
 complement of Catalyst plugins.
 
+=item * 
+
+Frank Speiser's Amazon EC2 Catalyst SDK
+
+There are currently two flavors of publicly available Amazon Machine
+Images (AMI) that include all the elements you'd need to begin
+developing in a fully functional Catalyst environment within minutes.
+See L<Catalyst::Manual::Installation|Catalyst::Manual::Installation>
+for more details.
+
 =back
 
 For additional information and recommendations on Catalyst installation,
@@ -365,6 +395,7 @@ Using these instructions, you should be able to build a complete CentOS
 4.X server with Catalyst and all the plugins required to run this
 tutorial.
 
+
 =head1 DATABASES
 
 This tutorial will primarily focus on SQLite because of its simplicity
@@ -377,6 +408,7 @@ notice that only the C<.sql> files used to initialize the database
 change between database systems: the Catalyst code generally remains the
 same.
 
+
 =head1 WHERE TO GET WORKING CODE
 
 Each part of the tutorial has complete code available in the main
@@ -400,9 +432,7 @@ Kennedy Clark, C<hkclark@gmail.com>
 
 Please report any errors, issues or suggestions to the author.  The
 most recent version of the Catalyst Tutorial can be found at
-L<http://dev.catalyst.perl.org/repos/Catalyst/trunk/Catalyst-Manual/lib/Catalyst/Manual/Tutorial/>.
-
-Copyright 2006, Kennedy Clark, under Creative Commons License
-(L<http://creativecommons.org/licenses/by-nc-sa/2.5/>).
-
+L<http://dev.catalyst.perl.org/repos/Catalyst/Catalyst-Manual/5.70/trunk/lib/Catalyst/Manual/Tutorial/>.
 
+Copyright 2006-2008, Kennedy Clark, under Creative Commons License
+(L<http://creativecommons.org/licenses/by-sa/3.0/us/>).