X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Manual.git;a=blobdiff_plain;f=lib%2FCatalyst%2FManual%2FTutorial%2FIntro.pod;h=9b449efdde0b43e34e7119bfbd5a1001fe9963c2;hp=524bcf22cca8c58befdb89cf0c1b9b3ec28ced15;hb=15e1d0b201341bf72fbf027d1450bbddac49e80f;hpb=5e6026272f809951ac22fae43b73d2c1dc79c7fc diff --git a/lib/Catalyst/Manual/Tutorial/Intro.pod b/lib/Catalyst/Manual/Tutorial/Intro.pod index 524bcf2..9b449ef 100644 --- a/lib/Catalyst/Manual/Tutorial/Intro.pod +++ b/lib/Catalyst/Manual/Tutorial/Intro.pod @@ -5,7 +5,7 @@ Catalyst::Manual::Tutorial::Intro - Catalyst Tutorial - Part 1: Introduction =head1 OVERVIEW -This is B of the Catalyst Tutorial. +This is B for the Catalyst tutorial. L @@ -21,34 +21,39 @@ L =item 3 -L +L =item 4 -L +L =item 5 -L +L =item 6 -L +L =item 7 -L +L =item 8 -L +L =item 9 +L + +=item 10 + L =back + =head1 DESCRIPTION This tutorial provides a multipart introduction to the Catalyst web @@ -58,8 +63,9 @@ required in the construction of nearly all Catalyst applications. Although the primary target of the tutorial is users new to the Catalyst framework, experienced users may wish to review specific sections (for -example, how to use DBIC for their model classes or how to add -authentication and authorization to an existing application). +example, how to use DBIC for their model classes, how to add +authentication and authorization to an existing application, or form +management). You can obtain the code for all the tutorial examples from the catalyst subversion repository by issuing the command: @@ -70,10 +76,22 @@ This will download the current code for each tutorial chapter in the CatalystTutorial directory. Each example application directory has the same name as the tutorial chapter. -Additionally, if you're reading this manual online, you can download -the manual, the example program, and all the necessary dependencies to -your local machine by installing the C -distribution from CPAN: +B + +B It should make little or no difference to Catalyst's +operation, but this tutorial has been written using Ubuntu 8.04 +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 distribution from CPAN: cpan Task::Catalyst::Tutorial @@ -81,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 @@ -133,14 +151,14 @@ PostgreSQL). =item * -The use of L for automated form processing +The use of L for automated form processing and validation. =back This tutorial makes the learning process its main priority. For example, the level of comments in the code found here would likely be -considered excessive in a "normal project". Because of their contextual +considered excessive in a "normal project." Because of their contextual value, this tutorial will generally favor inline comments over a separate discussion in the text. It also deliberately tries to demonstrate multiple approaches to various features (in general, you @@ -170,15 +188,19 @@ versions: =item * -OS = CentOS 4 Linux (RHEL 4) +Ubuntu 8.04 Hardy Heron =item * -Catalyst v5.6902 +Catalyst v5.7011 + +=item * + +Catalyst::Devel v1.03 =item * -DBIx::Class v0.06003 +DBIx::Class v0.08008 =item * @@ -193,47 +215,43 @@ use. This tutorial has been tested against the following set of plugins: =item * -Catalyst::Plugin::Authentication -- 0.09 - -=item * - -Catalyst::Plugin::Authentication::Store::DBIC -- 0.07 +Catalyst::Plugin::Authentication -- v0.10002 =item * -Catalyst::Plugin::Authorization::ACL -- 0.08 +Catalyst::Plugin::Authentication::Store::DBIC -- v0.09 =item * -Catalyst::Plugin::Authorization::Roles -- 0.04 +Catalyst::Plugin::Authorization::ACL -- v0.08 =item * -Catalyst::Plugin::ConfigLoader -- 0.13 +Catalyst::Plugin::Authorization::Roles -- v0.05 =item * -Catalyst::Plugin::HTML::Widget -- 1.1 +Catalyst::Plugin::ConfigLoader -- v0.17 =item * -Catalyst::Plugin::Session -- 0.12 +Catalyst::Plugin::Session -- v0.18 =item * -Catalyst::Plugin::Session::State::Cookie -- 0.05 +Catalyst::Plugin::Session::State::Cookie -- v0.08 =item * -Catalyst::Plugin::Session::Store::FastMmap -- 0.02 +Catalyst::Plugin::Session::Store::FastMmap -- v0.03 =item * -Catalyst::Plugin::StackTrace -- 0.06 +Catalyst::Plugin::StackTrace -- v0.06 =item * -Catalyst::Plugin::Static::Simple -- 0.14 +Catalyst::Plugin::Static::Simple -- v0.20 =back @@ -259,19 +277,70 @@ Explorer). =head1 CATALYST INSTALLATION -Unfortunately, one of the most daunting tasks faced by newcomers to -Catalyst is getting it installed. Although a compelling strength of -Catalyst is that it can easily make use of many of the modules in the -vast repository that is CPAN, this can result in initial installations -that are both time consuming and frustrating. 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: +If approach in the wrong manner, it can be a daunting tasks to get +Catalyst initially 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: + +=over 4 + +=item * + +Ubuntu + +Given the popularity of Ubuntu and it's 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 +this tutorial in a matter of minutes. =over 4 =item * +Download Ubuntu 8.04 (aka, Hardy Heron) 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 (click "Applications" in the upper-left +corner, then "Accessories," then "Terminal"). + +=item * + +Add the 'universe' repositories: + + sudo gedit /etc/apt/sources.list + +And remove the comments from the lines under the comments about the +'universe' repositories. + +=item * + +Install Catalyst: + + sudo apt-get update + 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 +to tell), you can free up some space with +C (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 * + Matt Trout's C Available at L, @@ -345,7 +414,7 @@ Kennedy Clark, C Please report any errors, issues or suggestions to the author. The most recent version of the Catalyst Tutorial can be found at -L. +L. Copyright 2006, Kennedy Clark, under Creative Commons License (L).