X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FManual%2FTutorial.pod;h=855eef4fa6d66d857eb78d76ec87581cd92d3f10;hb=b2dd9167f1add7125a39c4bde760ad78fb0be1e0;hp=91d11acc7743c79e78506caa74119f871818cdfb;hpb=64ccd8a8bfbc16276c044c94702b1440c2897695;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Manual/Tutorial.pod b/lib/Catalyst/Manual/Tutorial.pod index 91d11ac..855eef4 100644 --- a/lib/Catalyst/Manual/Tutorial.pod +++ b/lib/Catalyst/Manual/Tutorial.pod @@ -2,70 +2,65 @@ 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 -design to provide a rapid introduction to its basics and most commonly -used features while focusing on real-world best practices. +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 broken down into the following sections: +The tutorial is divided into the following sections: + +B CLICK THESE LINKS TO JUMP TO CHAPTERS (the index links above +only navigate inside this page). =over 4 =item * -L +L =item * -L +L =item * -L +L =item * -L +L =item * -L +L =item * -L +L -=item * +=item * -L +L =item * -L +L =item * -L +L =back - -Full source code is available for each section via the main Catalyst -Subversion repository at -L. See the -end of each section for the specifics on retrieving code for that -section. - A tarball of the final application is available at -C. +L. + -=head1 Detailed Table Of Contents +=head1 Detailed Table of Contents -=head2 Part 1: Introduction +=head2 L =over 4 @@ -88,7 +83,7 @@ WHERE TO GET WORKING CODE =back -=head2 Part 2: Catalyst Application Development Basics +=head2 L =over 4 @@ -108,6 +103,7 @@ EDIT THE LIST OF CATALYST PLUGINS DATABASE ACCESS WITH DBIx::Class + =over 4 =item * @@ -120,10 +116,11 @@ Create the DBIC ``Result Source'' Files =item * -Use Catalyst::Model::DBIC::Schema To Load The Model Class +Use Catalyst::Model::DBIC::Schema to Load the Model Class =back + =item * CREATE A CATALYST CONTROLLER @@ -132,11 +129,16 @@ CREATE A CATALYST CONTROLLER CATALYST VIEWS + =over 4 =item * -Create a Catalyst View Using TTSITE +Create a Catalyst View Using TTSite + +=item * + +Using RenderView for the Default View =item * @@ -148,14 +150,18 @@ Create a TT Template Page =back + =item * RUN THE APPLICATION -=back +=item * +USING THE DEFAULT TEMPLATE NAME + +=back -=head2 Part 3: Basic CRUD +=head2 L =over 4 @@ -187,7 +193,7 @@ MANUALLY BUILDING A CREATE FORM =item * -Add Method to Display The Form +Add a Method to Display the Form =item * @@ -199,7 +205,7 @@ Add Method to Process Form Values and Update Database =item * -Test Out The Form +Test Out the Form =back @@ -225,8 +231,7 @@ Try the Delete Feature =back - -=head2 Part 4: Authentication +=head2 L =over 4 @@ -308,8 +313,7 @@ Try Out the Hashed Passwords =back - -=head2 Part 5: Authorization +=head2 L =over 4 @@ -321,7 +325,7 @@ BASIC AUTHORIZATION =item * -Update Plugins to Include Support for Authorization +Update Plugins to Include Support for Authorization =item * @@ -363,8 +367,7 @@ Add a Method to Handle Access Violations =back - -=head2 Part 6: Debugging +=head2 L =over 4 @@ -376,10 +379,13 @@ LOG STATEMENTS RUNNING CATALYST UNDER THE PERL DEBUGGER -=back +=item * +DEBUGGING MODULES FROM CPAN + +=back -=head2 Part 7: Testing +=head2 L =over 4 @@ -401,8 +407,7 @@ SUPPORTING BOTH PRODUCTION AND TEST DATABASES =back - -=head2 Part 8: Advanced CRUD +=head2 L =over 4 @@ -480,8 +485,7 @@ Use populate_from_widget in hw_create_do =back - -=head2 Part 9: Appendices +=head2 L =over 4 @@ -517,5 +521,67 @@ 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, David Kurtz, and Ingo Wichmann. + =back + + +=head1 AUTHOR + +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. + +Copyright 2006, Kennedy Clark, under Creative Commons License +(L).