Updates based on suggestion from David Kurtz.

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Manual / Tutorial.pod

=head1 NAME

Catalyst::Manual::Tutorial - Catalyst Tutorial: Overview

=head1 DESCRIPTION

The Catalyst framework is a flexible and comprehensive environment for
quickly building high-functionality web applications.  This tutorial is
designed to provide a rapid introduction to its basics and its most
commonly used features while focusing on real-world best practices.

The tutorial is divided into the following sections:

B<NOTE:> CLICK THESE LINKS TO JUMP TO CHAPTERS (the index links above
only navigate inside this page).

=over 4

=item *

L<Introduction|Catalyst::Manual::Tutorial::Intro>

=item * 

L<Catalyst Basics|Catalyst::Manual::Tutorial::CatalystBasics>

=item * 

L<Basic CRUD|Catalyst::Manual::Tutorial::BasicCRUD>

=item * 

L<Authentication|Catalyst::Manual::Tutorial::Authentication>

=item * 

L<Authorization|Catalyst::Manual::Tutorial::Authorization>

=item * 

L<Debugging|Catalyst::Manual::Tutorial::Debugging>

=item *

L<Testing|Catalyst::Manual::Tutorial::Testing>

=item * 

L<Advanced CRUD|Catalyst::Manual::Tutorial::AdvancedCRUD>

=item * 

L<Appendices|Catalyst::Manual::Tutorial::Appendices>

=back

A tarball of the final application is available at
L<http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/Tutorial/Final_Tarball/MyApp.tgz>.


=head1 Detailed Table of Contents

=head2 L<Part 1: Introduction|Catalyst::Manual::Tutorial::Intro>

=over 4

=item *

VERSIONS AND CONVENTIONS USED IN THIS TUTORIAL

=item *

CATALYST INSTALLATION

=item *

DATABASES

=item *

WHERE TO GET WORKING CODE

=back


=head2 L<Part 2: Catalyst Basics|Catalyst::Manual::Tutorial::CatalystBasics>

=over 4

=item *

CREATE A CATALYST PROJECT

=item *

CREATE A SQLITE DATABASE

=item *

EDIT THE LIST OF CATALYST PLUGINS

=item *

DATABASE ACCESS WITH DBIx::Class


=over 4

=item *

Create a DBIC Schema File

=item *

Create the DBIC ``Result Source'' Files

=item *

Use Catalyst::Model::DBIC::Schema to Load the Model Class

=back


=item *

CREATE A CATALYST CONTROLLER

=item *

CATALYST VIEWS


=over 4

=item *

Create a Catalyst View Using TTSite

=item *

Using RenderView for the Default View

=item *

Globally Customize Every View

=item *

Create a TT Template Page

=back


=item *

RUN THE APPLICATION

=back

=head2 L<Part 3: Basic CRUD|Catalyst::Manual::Tutorial::BasicCRUD>

=over 4

=item *

FORMLESS SUBMISSION

=over 4

=item *

Include a Create Action in the Books Controller

=item *

Include a Template for the url_create Action:

=item *

Try the url_create Feature

=back

=item *

MANUALLY BUILDING A CREATE FORM

=over 4

=item *

Add a Method to Display the Form

=item *

Add a Template for the Form

=item *

Add Method to Process Form Values and Update Database

=item *

Test Out the Form

=back

=item *

A SIMPLE DELETE FEATURE

=over 4

=item *

Include a Delete Link in the List

=item *

Add a Delete Action to the Controller

=item *

Try the Delete Feature

=back

=back

=head2 L<Part 4: Authentication|Catalyst::Manual::Tutorial::Authentication>

=over 4

=item *

BASIC AUTHENTICATION

=over 4

=item *

Add Users and Roles to the Database

=item *

Add User and Role Information to DBIC Schema

=item *

Create New ``Result Source Objects''

=item *

Sanity-Check Reload of Development Server

=item *

Include Authentication and Session Plugins

=item *

Configure Authentication

=item *

Add Login and Logout Controllers

=item *

Add a Login Form TT Template Page

=item *

Add Valid User Check

=item *

Displaying Content Only to Authenticated Users

=item *

Try Out Authentication

=back

=item *

USING PASSWORD HASHES

=over 4

=item *

Get a SHA-1 Hash for the Password

=item *

Switch to SHA-1 Password Hashes in the Database

=item *

Enable SHA-1 Hash Passwords in Catalyst::Plugin::Authentication::Store::DBIC

=item *

Try Out the Hashed Passwords

=back

=back

=head2 L<Part 5: Authorization|Catalyst::Manual::Tutorial::Authorization>

=over 4

=item *

BASIC AUTHORIZATION

=over 4

=item *

Update Plugins to Include Support for Authorization

=item *

Add Config Information for Authorization

=item *

Add Role-Specific Logic to the ``Book List'' Template

=item *

Limit Books::add to admin Users

=item *

Try Out Authentication And Authorization

=back

=item *

ENABLE ACL-BASED AUTHORIZATION

=over 4

=item *

Add the Catalyst::Plugin::Authorization::ACL Plugin

=item *

Add ACL Rules to the Application Class

=item *

Add a Method to Handle Access Violations

=back

=back

=head2 L<Part 6: Debugging|Catalyst::Manual::Tutorial::Debugging>

=over 4

=item *

LOG STATEMENTS

=item *

RUNNING CATALYST UNDER THE PERL DEBUGGER

=item *

DEBUGGING MODULES FROM CPAN

=back

=head2 L<Part 7: Testing|Catalyst::Manual::Tutorial::Testing>

=over 4

=item *

RUNNING THE "CANNED" CATALYST TESTS

=item *

RUNNING A SINGLE TEST

=item *

ADDING YOUR OWN TEST SCRIPT

=item *

SUPPORTING BOTH PRODUCTION AND TEST DATABASES

=back

=head2 L<Part 8: Advanced CRUD|Catalyst::Manual::Tutorial::AdvancedCRUD>

=over 4

=item *

HTML::WIDGET FORM CREATION

=over 4

=item *

Add the HTML::Widget Plugin

=item *

Add a Form Creation Helper Method

=item *

Add Actions to Display and Save the Form

=item *

Update the CSS

=item *

Create a Template Page To Display The Form

=item *

Add Links for Create and Update via HTML::Widget

=item *

Test The <HTML::Widget> Create Form

=back

=item *

HTML::WIDGET VALIDATION AND FILTERING

=over 4

=item *

Add Constraints and Filters to the Widget Creation Method

=item *

Rebuild the Form Submission Method to Include Validation

=item *

Try Out the Form

=back

=item *

Enable DBIx::Class::HTMLWidget Support

=over 4

=item *

Add DBIx::Class::HTMLWidget to DBIC Model

=item *

Use populate_from_widget in hw_create_do

=back

=back

=head2 L<Part 9: Appendices|Catalyst::Manual::Tutorial::Appendices>

=over 4

=item *

APPENDIX 1: CUT AND PASTE FOR POD-BASED EXAMPLES

=over 4

=item *

"Un-indenting" with Vi/Vim

=item *

"Un-indenting" with Emacs

=back

=item *

APPENDIX 2: USING MYSQL AND POSTGRESQL

=over 4

=item *

MySQL

=item *

PostgreSQL

=back

=item *

APPENDIX 3: IMPROVED HASHING SCRIPT

=back


=head1 THANKS

This tutorial would not have been possible without the input of many 
different people in the Catalyst community.  In particular, the 
primary author would like to thank:

=over 4

=item *

Sebastian Riedel for founding the Catalyst project.

=item *

The members of the Catalyst Core Team for their tireless efforts to
advance the Catalyst project.  Although all of the Core Team members
have played a key role in this tutorial, it would have never been
possible without the critical contributions of: Matt Trout, for his
unfathomable knowledge of all things Perl and Catalyst (and his
willingness to answer lots of my questions); Jesse Sheidlower, for his
incredible skill with the written word and dedication to improving the
Catalyst documentation; and Yuval Kogman, for his work on the Catalyst
"Auth & Authz" plugins (the original focus of the tutorial) and other
key Catalyst modules.

=item *

Other Catalyst documentation folks like Kieren Diment, Gavin Henry,
and Jess Robinson (including their work on the original Catalyst
tutorial).

=item *

Everyone on #catalyst and #catalyst-dev.

=item *

People who have emailed me with corrections and suggestions on the 
tutorial.  As of the most recent release, this include: Florian Ragwitz, 
Mauro Andreolini, Jim Howard, Giovanni Gigante, William Moreno,  
Bryan Roach, Ashley Berlin, David Kamholz, Kevin Old, Henning Sprang,
Jeremy Jones, and David Kurtz.

=back



=head1 AUTHOR

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-Runtime/lib/Catalyst/Manual/Tutorial/>.

Copyright 2006, Kennedy Clark, under Creative Commons License
(L<http://creativecommons.org/licenses/by-nc-sa/2.5/>).