From: hkclark Date: Mon, 29 Aug 2011 14:56:19 +0000 (-0400) Subject: Reformat/wrap paragraphs X-Git-Tag: 5.9003~25^2~54 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Manual.git;a=commitdiff_plain;h=8168726b56cffd642199c062021246cd23a199c7 Reformat/wrap paragraphs --- diff --git a/lib/Catalyst/Manual/Tutorial.pod b/lib/Catalyst/Manual/Tutorial.pod index cc895e1..60571fe 100644 --- a/lib/Catalyst/Manual/Tutorial.pod +++ b/lib/Catalyst/Manual/Tutorial.pod @@ -730,6 +730,7 @@ 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 . +***TODO: Update The most recent version of the Catalyst Tutorial can be found at L. diff --git a/lib/Catalyst/Manual/Tutorial/01_Intro.pod b/lib/Catalyst/Manual/Tutorial/01_Intro.pod index 54d2d98..494b9a2 100644 --- a/lib/Catalyst/Manual/Tutorial/01_Intro.pod +++ b/lib/Catalyst/Manual/Tutorial/01_Intro.pod @@ -64,8 +64,8 @@ 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, how to add -authentication and authorization to an existing application, or form -management). +authentication and authorization to an existing application, and/or +form management). You can obtain the code for all the tutorial examples from the catalyst subversion repository by issuing the command: @@ -81,25 +81,25 @@ 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.> -B It should make little or no difference to Catalyst's -operation, B because that represents a quick and easy way for most people to -try out Catalyst with virtually zero setup time and hassles. Also, -the tutorial has been tested to work correctly with the versions of -Catalyst and all the supporting modules in Debian 5 (see "VERSIONS -AND CONVENTIONS USED IN THIS TUTORIAL" below for the specific versions -for some of the key modules), so B (for example, a module changed its -behavior in a newer version or a bug was introduced), B. - -If you plan to follow along with Debian 5, you can jump down to the -"Debian" section under L below and it will walk you -though the setup of a fully functional Catalyst environment. If you -would prefer to install directly from CPAN, you can download the example -program and all the necessary dependencies to your local machine by -installing the C distribution: +B It should make little or no difference to Catalyst's +operation, B because that represents a quick and easy way for most people to try +out Catalyst with virtually zero setup time and hassles. Also, the +tutorial has been tested to work correctly with the versions of Catalyst +and all the supporting modules in Debian 6 (see "VERSIONS AND +CONVENTIONS USED IN THIS TUTORIAL" below for the specific versions for +some of the key modules), so B (for example, a module changed its behavior +in a newer version or a bug was introduced), B. + +If you plan to follow along with Debian 6, you can jump down to the +"Debian" section under L below and it will +walk you though the setup of a fully functional Catalyst environment. If +you would prefer to install directly from CPAN, you can download the +example program and all the necessary dependencies to your local machine +by installing the C distribution: cpan Task::Catalyst::Tutorial @@ -117,8 +117,8 @@ A simple application that lists and adds books. =item * -The use of L (DBIC) for the model (including -some of the more advanced techniques you will probably want to use in +The use of L (DBIC) for the model (including +some of the more advanced techniques you will probably want to use in your applications). =item * @@ -136,12 +136,8 @@ Role-based authorization ("authz"). =item * -Attempts to provide an example showing current (5.8XXX) Catalyst -practices. For example, the use of -L, -DBIC, L -with C, the use of C -vs. C, etc. +Attempts to provide an example showing current (5.9) Catalyst +practices. =item * @@ -155,10 +151,10 @@ applications. =item * The use of SQLite as a database (with code also provided for MySQL and -PostgreSQL). (Note: Because we make use of the DBIx::Class Object +PostgreSQL). (Note: Because we make use of the DBIx::Class Object Relational Mapping [ORM] layer, out our application will be database -agnostic and can easily be used by any of the databases supported -by DBIx::Class.) +agnostic and can easily be used by any of the databases supported by +DBIx::Class.) =item * @@ -183,35 +179,36 @@ to more complex environments. More complete and complicated example applications can be found in the C area of the Catalyst Subversion repository at L. +***Todo: update link above? =head1 QUICK START -For those who want to get going quickly, here is a short "cookbook-style -recipe" to quickly get you up and running. Although there are many -different ways to get a Catalyst environment going, this tutorial has -been written with and tested against Debian 5 Live CD, using the steps -in this Quick Start. +For those who want to get going quickly, here is a short "cookbook-style +recipe" to quickly get you up and running. Although there are many +different ways to get a Catalyst environment going, this tutorial has +been written with and tested against Debian 6 Live CD, using the steps +in this Quick Start. -If you want, you can follow the directions in this section and then jump -right to L of -the tutorial. However, it would be a good idea to come back and read the -sections below the Quick Start when you have time. Or, continue reading -those other sections for suggestions if you do not wish to use the -Debian 5 Live CD. +If you want, you can follow the directions in this section and then jump +right to L of +the tutorial. However, it would be a good idea to come back and read the +sections below the Quick Start when you have time. Or, continue reading +those other sections for suggestions if you do not wish to use the +Debian 6 Live CD. =over 4 =item 1 -Download the C image from -L. +Download the C image from +L. =item 2 Boot this disk, either in a physical machine, or possibly some sort -of virtual machine (can be a very handy way to practice). +of virtual machine (using a VM can be a very handy way to practice). =item 3 @@ -369,36 +366,35 @@ or: =item * -This tutorial will assume that the web browser is located on the same -system where the Catalyst development server is running, and -therefore use a URL of C (the Catalyst -development server defaults to port 3000). If you are running Perl on -a different box than where your web browser is located (or using a -different port number via the C<-p> I option to the -development server), then you will need to update the URL you use -accordingly. - -Please Note: Depending on the web browser you are using, you might -need to hit C or C to pull a fresh page -when testing your application at various points (see -L 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). +This tutorial will assume that the web browser is located on the same +system where the Catalyst development server is running, and therefore +use a URL of C (the Catalyst development server +defaults to port 3000). If you are running Perl on a different box than +where your web browser is located (or using a different port number via +the C<-p> I option to the development server), then you +will need to update the URL you use accordingly. + +Please Note: Depending on the web browser you are using, you might need +to hit C or C to pull a fresh page when +testing your application at various points (see +L 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). ***Todo: is this still true? =back =head1 CATALYST INSTALLATION -Although Catalyst installation has been a challenge in the past, the -good news is that there are a growing number of options to eliminate -(or at least dramatically simplify) this concern. 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 if you approach it in the wrong way. Consider -the following suggestions on the most common ways to get started with -a Catalyst development environment: +Although Catalyst installation has been a challenge in the past, the +good news is that there are a growing number of options to eliminate (or +at least dramatically simplify) this concern. 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 if you approach it in the wrong way. Consider the following +suggestions on the most common ways to get started with a Catalyst +development environment: =over 4 @@ -406,59 +402,58 @@ a Catalyst development environment: Debian -The Debian 5 live CD represents a great way for newcomers to -experiment with Catalyst. As a "live CD," you can simple boot from -the CD, run a few commands, and in a matter of minutes you should have -a fully function environment in which do this tutorial. B +The Debian 6 Live CD represents a great way for newcomers to experiment +with Catalyst. As a "live CD," you can simple boot from the CD, run a +few commands, and in a matter of minutes you should have a fully +function environment in which do this tutorial. B =over 4 =item * -Download one of the ISO files from -L -(the current version at the time this was written was 5.0.3). -You can pick any one of the live CD variations will work, but -you may wish to consider the following points: +Download one of the ISO files from +L +(the current version at the time this was written was 6.0.1). You can +pick any one of the live CD variations will work, but you may wish to +consider the following points: =over 4 =item * -"C" is probably the best all-around -option for most people because it includes many extra tools such as -the GCC compiler, therefore saving RAM (every package you need to -install when running from live CD consumes memory because RAM disk is -being used in lieu of real disk space). When initially booting under -this image, you may see some cryptic warning messages having to do -with various diagnostic tools it tries to load or enable, but you -should be able to safely ignore these. +"C" is probably the best all-around +option for most people because it includes many extra tools such as the +GCC compiler, therefore saving RAM (every package you need to install +when running from live CD consumes memory because RAM disk is being used +in lieu of real disk space). When initially booting under this image, +you may see some cryptic warning messages having to do with various +diagnostic tools it tries to load or enable, but you should be able to +safely ignore these. =item * -"C" is a great option because of -its compact size, but you will probably need approximately 1 GB of RAM -in the computer where you will run the tutorial. Because the -"standard" live CD comes with with a minimal set of tools, we will -have to install extra packages (such as the GCC compiler), all of -which will require RAM when running from a live CD. +"C" is a great option because of +its compact size, but you will probably need approximately 1 GB of RAM +in the computer where you will run the tutorial. Because the "standard" +live CD comes with with a minimal set of tools, we will have to install +extra packages (such as the GCC compiler), all of which will require RAM +when running from a live CD. =item * -The other ISO images include different flavors of X-Windows desktop -managers. You can select one of these if you don't mind the larger -download size and prefer a graphical environment. Be aware that these -disks do not come with the extra tools found on the "rescue" image, so -you will need adequate RAM to be able to install them just as you -would under the "standard" image. B (If you are using one of the non- -graphical images discussed above, you can still use a graphical web -browser from another machine and point it to your Catalyst development -machine.) +The other ISO images include different flavors of X-Windows desktop +managers. You can select one of these if you don't mind the larger +download size and prefer a graphical environment. Be aware that these +disks do not come with the extra tools found on the "rescue" image, so +you will need adequate RAM to be able to install them just as you would +under the "standard" image. B (If you are using one of the non- graphical images +discussed above, you can still use a graphical web browser from another +machine and point it to your Catalyst development machine.) =back @@ -484,9 +479,9 @@ password for root: sudo passwd ... -Then enter the following command to add the more current "unstable" -package repository so we get the latest versions of Catalyst and -related packages: +Then enter the following command to add the more current "unstable" +package repository so we get the latest versions of Catalyst and related +packages: sudo vi /etc/apt/sources.list @@ -494,12 +489,12 @@ Add the following line to the bottom of this file: deb http://ftp.us.debian.org/debian/ unstable main -If you are not familiar with VI, you can move to the bottom of this -file and press the "o" key to insert a new line and type the line -above. Then press the "Esc" key followed by a colon (":"), the -letters "wq" and then the "Enter" key. The rest of the tutorial will -assume that you know how to use some editor that is available from the -Linux command-line environment. +If you are not familiar with VI, you can move to the bottom of this file +and press the "o" key to insert a new line and type the line above. +Then press the "Esc" key followed by a colon (":"), the letters "wq" and +then the "Enter" key. The rest of the tutorial will assume that you +know how to use some editor that is available from the Linux +command-line environment. =item * @@ -523,18 +518,18 @@ to run the following command to install additional packages: sudo aptitude -y install gcc make libc6-dev -If you are running from the Live CD, you probably also want to free up +If you are running from the Live CD, you probably also want to free up some RAM disk space with the following: sudo aptitude clean -NOTE: While the instructions above mention the Live CD because that -makes it easy for people new to Linux, you can obviously pick a -different Debian ISO image and install it to your hard drive. -Although there are many different ways to download and install Debian, -the "netinst" ISO image (such as "C" -represents a great option because it keeps your initial download small -(but still lets you install anything you want "over the network"). +NOTE: While the instructions above mention the Live CD because that +makes it easy for people new to Linux, you can obviously pick a +different Debian ISO image and install it to your hard drive. Although +there are many different ways to download and install Debian, the +"netinst" ISO image (such as "C" represents +a great option because it keeps your initial download small (but still +lets you install anything you want "over the network"). Here are some tips if you are running from a live CD and are running out of disk space (which really means you are running out of RAM): @@ -543,43 +538,41 @@ out of disk space (which really means you are running out of RAM): =item * -Always run "C" after you install new packages to -delete the original .deb files (the files installed B the .deb -package B remain available, just the .deb package itself is -deleted). +Always run "C" after you install new packages to delete +the original .deb files (the files installed B the .deb package +B remain available, just the .deb package itself is deleted). =item * -If you are installing modules from CPAN, you can free up some space -with "C" (change "/root/" in the previous -command to match your home directory or the location where CPAN -has been configured to perform build operations). +If you are installing modules from CPAN, you can free up some space with +"C" (change "/root/" in the previous command to +match your home directory or the location where CPAN has been configured +to perform build operations). =item * -If necessary, you can remove the cached package information with the -command "C". You can later pull this +If necessary, you can remove the cached package information with the +command "C". You can later pull this information again via the command "C". =item * -You can save a small amount of space by commenting out the lines in -C that reference "deb-src" and -"security.debian.org". If you have already done an "C" with these repositories enabled, you can use the tip in the -previous bullet to free the space up (and then do another "C"). +You can save a small amount of space by commenting out the lines in +C that reference "deb-src" and +"security.debian.org". If you have already done an "C" +with these repositories enabled, you can use the tip in the previous +bullet to free the space up (and then do another "C"). =item * -Although you can free up space by removing packages you installed -since you last booted (check out "C"), -don't bother trying to remove packages already available at the time -of boot. Instead of freeing up space, it will actual I some -space. (The live CD uses these "burn in" packages right from the CD -disk vs. first loading them on the virtual RAM disk. However, if you -remove them, the system has to update various files, something that -I consume some space on the virtual RAM disk.) +Although you can free up space by removing packages you installed since +you last booted (check out "C"), don't bother +trying to remove packages already available at the time of boot. Instead +of freeing up space, it will actual I some space. (The live CD +uses these "burn in" packages right from the CD disk vs. first loading +them on the virtual RAM disk. However, if you remove them, the system +has to update various files, something that I consume some space +on the virtual RAM disk.) =back @@ -589,27 +582,27 @@ I consume some space on the virtual RAM disk.) Ubuntu -Ubuntu is an extremely popular offshoot of Debian. It provides -cutting edge versions of many common tools, application and libraries -in an easy-to-run live CD configuration (and because a single download -option can be used for both live CD and install-to-disk usage, it -keeps your download options nice and simple). As with Debian 5, you -should be able to generate a fully function Catalyst environment in a -matter of minutes. Here are quick instructions on how to use Ubuntu -to prepare for the tutorial: +Ubuntu is an extremely popular offshoot of Debian. It provides cutting +edge versions of many common tools, application and libraries in an +easy-to-run live CD configuration (and because a single download option +can be used for both live CD and install-to-disk usage, it keeps your +download options nice and simple). As with Debian 6, you should be able +to generate a fully function Catalyst environment in a matter of +minutes. Here are quick instructions on how to use Ubuntu to prepare +for the tutorial: =over 4 =item * -Download the Ubuntu Desktop edition and boot from the CD and/or image -file, select your language, and then "Try Ubuntu without any changes -to your computer." +Download the Ubuntu 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"). +Open a terminal session (click "Applications" in the upper-left corner, +then "Accessories," then "Terminal"). =item * @@ -627,16 +620,16 @@ Install Catalyst: sudo aptitude update sudo aptitude install libdbd-sqlite3-perl libcatalyst-perl libcatalyst-modules-perl libconfig-general-perl -Accept all of the dependencies. Done. +Accept all of the dependencies. Done. -If you are running from the Live CD, you probably also want to free up +If you are running from the Live CD, you probably also want to free up some disk space with the following: sudo aptitude clean -NOTE: 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. +NOTE: 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 @@ -644,13 +637,13 @@ of the options to install Ubuntu on your drive. Matt Trout's C -Available at L, -C can be a fairly painless way to get Catalyst up and -running. Just download the script from the link above and type C. Depending on the speed of your Internet connection and -your computer, it will probably take 30 to 60 minutes to install because -it downloads, makes, compiles, and tests every module. But this is an -excellent way to automate the installation of all the latest modules +Available at L, +C can be a fairly painless way to get Catalyst up and +running. Just download the script from the link above and type C. Depending on the speed of your Internet connection and +your computer, it will probably take 30 to 60 minutes to install because +it downloads, makes, compiles, and tests every module. But this is an +excellent way to automate the installation of all the latest modules used by Catalyst from CPAN. @@ -664,25 +657,25 @@ Other Possibilities OpenBSD Packages -The 2008 Advent Day 4 entry has more information on using OpenBSD -packages to quickly build a system: +The 2008 Advent Day 4 entry has more information on using OpenBSD +packages to quickly build a system: L. =item * NetBSD Package Collection on Solaris -The 2008 Advent Day 15 entry has more information on using C and -NetBSD packages on Solaris: +The 2008 Advent Day 15 entry has more information on using C and +NetBSD packages on Solaris: L. =item * CatInABox -You can get more information at -L -or L. +You can get more information at +L or +L. =item * @@ -699,7 +692,7 @@ for more details. =back For additional information and recommendations on Catalyst installation, -please refer to +please refer to L. @@ -718,11 +711,11 @@ same. =head1 WHERE TO GET WORKING CODE -Each chapter of the tutorial has complete code available as a tarball in -the main Catalyst Subversion repository (see the note at the beginning +Each chapter of the tutorial has complete code available as a tarball in +the main Catalyst Subversion repository (see the note at the beginning of each part for the appropriate svn command to use). -B You can run the test cases for the final code through Chapter 8 +B You can run the test cases for the final code through Chapter 8 with the following commands: svn co http://dev.catalystframework.org/repos/Catalyst/trunk/examples/Tutorial/MyApp_Chapter8 @@ -743,13 +736,13 @@ ran the test suite above: script/myapp_server.pl -And the application will start. You can try out the application by -pulling up C in your web browser (as mentioned -earlier, change C to a different IP address or DNS name if -you are running your web browser and your Catalyst development on -different boxes). We will obviously see more about how to use the -application as we go through the remaining chapters of the tutorial, but -for now you can log in using the username "test01" and a password of +And the application will start. You can try out the application by +pulling up C in your web browser (as mentioned +earlier, change C to a different IP address or DNS name if +you are running your web browser and your Catalyst development on +different boxes). We will obviously see more about how to use the +application as we go through the remaining chapters of the tutorial, but +for now you can log in using the username "test01" and a password of "mypass". @@ -757,11 +750,8 @@ for now you can log in using the username "test01" and a password of Kennedy Clark, C -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 -. - -The most recent version of the Catalyst Tutorial can be found at +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-2010, Kennedy Clark, under the