apache fastcgi/mod_deflate note per awnstudio
[catagits/Catalyst-Manual.git] / lib / Catalyst / Manual / Cookbook.pod
index 89cc05d..5262a10 100644 (file)
@@ -10,21 +10,23 @@ Yummy code like your mum used to bake!
 
 =head1 Basics
 
-These recipes cover some basic stuff that is worth knowing for catalyst developers.
+These recipes cover some basic stuff that is worth knowing for
+Catalyst developers.
 
 =head2 Delivering a Custom Error Page
 
 By default, Catalyst will display its own error page whenever it
 encounters an error in your application. When running under C<-Debug>
-mode, the error page is a useful screen including the error message and
-L<Data::Dump> output of the relevant parts of the C<$c> context object. 
-When not in C<-Debug>, users see a simple "Please come back later" screen.
+mode, the error page is a useful screen including the error message
+and L<Data::Dump> output of the relevant parts of the C<$c> context
+object.  When not in C<-Debug>, users see a simple "Please come back
+later" screen.
 
-To use a custom error page, use a special C<end> method to short-circuit
-the error processing. The following is an example; you might want to
-adjust it further depending on the needs of your application (for
-example, any calls to C<fillform> will probably need to go into this
-C<end> method; see L<Catalyst::Plugin::FillInForm>).
+To use a custom error page, use a special C<end> method to
+short-circuit the error processing. The following is an example; you
+might want to adjust it further depending on the needs of your
+application (for example, any calls to C<fillform> will probably need
+to go into this C<end> method; see L<Catalyst::Plugin::FillInForm>).
 
     sub end : Private {
         my ( $self, $c ) = @_;
@@ -52,47 +54,49 @@ You can manually set errors in your code to trigger this page by calling
 
 =head2 Disable statistics
 
-Just add this line to your application class if you don't want those nifty
-statistics in your debug messages.
+Just add this line to your application class if you don't want those
+nifty statistics in your debug messages.
 
     sub Catalyst::Log::info { }
 
 =head2 Enable debug status in the environment
 
 Normally you enable the debugging info by adding the C<-Debug> flag to
-your C<use Catalyst> statement. However, you can also enable it using
+your C<use Catalyst> statement . However, you can also enable it using
 environment variable, so you can (for example) get debug info without
 modifying your application scripts. Just set C<CATALYST_DEBUG> or
 C<E<lt>MYAPPE<gt>_DEBUG> to a true value.
 
 =head2 Sessions
 
-When you have your users identified, you will want to somehow remember that
-fact, to save them from having to identify themselves for every single
-page. One way to do this is to send the username and password parameters in
-every single page, but that's ugly, and won't work for static pages. 
+When you have your users identified, you will want to somehow remember
+that fact, to save them from having to identify themselves for every
+single page. One way to do this is to send the username and password
+parameters in every single page, but that's ugly, and won't work for
+static pages.
 
-Sessions are a method of saving data related to some transaction, and giving
-the whole collection a single ID. This ID is then given to the user to return
-to us on every page they visit while logged in. The usual way to do this is
-using a browser cookie.
+Sessions are a method of saving data related to some transaction, and
+giving the whole collection a single ID. This ID is then given to the
+user to return to us on every page they visit while logged in. The
+usual way to do this is using a browser cookie.
 
 Catalyst uses two types of plugins to represent sessions:
 
 =head3 State
 
-A State module is used to keep track of the state of the session between the
-users browser, and your application.  
+A State module is used to keep track of the state of the session
+between the users browser, and your application.
 
-A common example is the Cookie state module, which sends the browser a cookie
-containing the session ID. It will use default value for the cookie name and
-domain, so will "just work" when used. 
+A common example is the Cookie state module, which sends the browser a
+cookie containing the session ID. It will use default value for the
+cookie name and domain, so will "just work" when used.
 
 =head3 Store
 
-A Store module is used to hold all the data relating to your session, for
-example the users ID, or the items for their shopping cart. You can store data
-in memory (FastMmap), in a file (File) or in a database (DBI).
+A Store module is used to hold all the data relating to your session,
+for example the users ID, or the items for their shopping cart. You
+can store data in memory (FastMmap), in a file (File) or in a database
+(DBI).
 
 =head3 Authentication magic
 
@@ -103,17 +107,27 @@ retrieve the user data for you.
 =head3 Using a session
 
 Once the session modules are loaded, the session is available as C<<
-$c->session >>, and can be writen to and read from as a simple hash reference.
+$c->session >>, and can be writen to and read from as a simple hash
+reference.
 
 =head3 EXAMPLE
 
-  use Catalyst qw/
-                 Session
-                 Session::Store::FastMmap
-                 Session::State::Cookie
-                 /;
+  package MyApp;
+  use Moose;
+  use namespace::autoclean;
 
+  use Catalyst  qw/
+                         Session
+                         Session::Store::FastMmap
+                         Session::State::Cookie
+                   /;
+  extends 'Catalyst';
+  __PACKAGE__->setup;
 
+  package MyApp::Controller::Foo;
+  use Moose;
+  use namespace::autoclean;
+  BEGIN { extends 'Catalyst::Controller' };
   ## Write data into the session
 
   sub add_item : Local {
@@ -155,36 +169,27 @@ You configure your application with the C<config> method in your
 application class. This can be hard-coded, or brought in from a
 separate configuration file.
 
-=head3 Using YAML
+=head3 Using Config::General
 
-YAML is a method for creating flexible and readable configuration
-files. It's a great way to keep your Catalyst application configuration
-in one easy-to-understand location.
+L<Config::General|Config::General> is a method for creating flexible
+and readable configuration files. It's a great way to keep your
+Catalyst application configuration in one easy-to-understand location.
 
-In your application class (e.g. C<lib/MyApp.pm>):
-
-  use YAML;
-  # application setup
-  __PACKAGE__->config( YAML::LoadFile(__PACKAGE__->config->{'home'} . '/myapp.yml') );
-  __PACKAGE__->setup;
+Now create C<myapp.conf> in your application home:
 
-Now create C<myapp.yml> in your application home:
-
-  --- #YAML:1.0
-  # DO NOT USE TABS FOR INDENTATION OR label/value SEPARATION!!!
-  name:     MyApp
+  name     MyApp
 
   # session; perldoc Catalyst::Plugin::Session::FastMmap
-  session:
-    expires:        '3600'
-    rewrite:        '0'
-    storage:        '/tmp/myapp.session'
+  <Session>
+    expires 3600
+    rewrite 0
+    storage /tmp/myapp.session
+  </Session>
 
   # emails; perldoc Catalyst::Plugin::Email
   # this passes options as an array :(
-  email:
-    - SMTP
-    - localhost
+  Mail SMTP
+  Mail localhost
 
 This is equivalent to:
 
@@ -203,11 +208,11 @@ This is equivalent to:
   # configure email sending
   __PACKAGE__->config->{email} = [qw/SMTP localhost/];
 
-See also L<YAML>.
+See also L<Config::General|Config::General>.
 
 =head1 Skipping your VCS's directories
 
-Catalyst uses Module::Pluggable to load Models, Views and Controllers.
+Catalyst uses Module::Pluggable to load Models, Views, and Controllers.
 Module::Pluggable will scan through all directories and load modules
 it finds.  Sometimes you might want to skip some of these directories,
 for example when your version control system makes a subdirectory with
@@ -216,7 +221,7 @@ Catalyst skips subversion and CVS directories already, there are other
 source control systems.  Here is the configuration you need to add
 their directories to the list to skip.
 
-You can make catalyst skip these directories using the Catalyst config:
+You can make Catalyst skip these directories using the Catalyst config:
 
   # Configure the application
   __PACKAGE__->config(
@@ -229,7 +234,7 @@ and other options.
 
 =head1 Users and Access Control
 
-Most multiuser, and some single user web applications require that
+Most multiuser, and some single-user web applications require that
 users identify themselves, and the application is often required to
 define those roles.  The recipes below describe some ways of doing
 this.
@@ -238,7 +243,7 @@ this.
 
 This is extensively covered in other documentation; see in particular
 L<Catalyst::Plugin::Authentication> and the Authentication chapter
-of the Tutorial at L<Catalyst::Manual::Tutorial::Authorization>.
+of the Tutorial at L<Catalyst::Manual::Tutorial::06_Authorization>.
 
 =head2 Pass-through login (and other actions)
 
@@ -257,67 +262,6 @@ like so:
       }
     }
 
-
-=head2 Role-based Authorization
-
-For more advanced access control, you may want to consider using role-based
-authorization. This means you can assign different roles to each user, e.g.
-"user", "admin", etc.
-
-The C<login> and C<logout> methods and view template are exactly the same as
-in the previous example.
-
-The L<Catalyst::Plugin::Authorization::Roles> plugin is required when
-implementing roles:
-
- use Catalyst qw/
-    Authentication
-    Authentication::Credential::Password
-    Authentication::Store::Htpasswd
-    Authorization::Roles
-  /;
-
-Roles are implemented automatically when using
-L<Catalyst::Authentication::Store::Htpasswd>:
-
-  # no additional role configuration required
-  __PACKAGE__->config->{authentication}{htpasswd} = "passwdfile";
-
-Or can be set up manually when using L<Catalyst::Authentication::Store::DBIC>:
-
-  # Authorization using a many-to-many role relationship
-  __PACKAGE__->config->{authorization}{dbic} = {
-    'role_class'           => 'My::Model::DBIC::Role',
-    'role_field'           => 'name',
-    'user_role_user_field' => 'user',
-
-    # DBIx::Class only (omit if using Class::DBI)
-    'role_rel'             => 'user_role',
-
-    # Class::DBI only, (omit if using DBIx::Class)
-    'user_role_class'      => 'My::Model::CDBI::UserRole'
-    'user_role_role_field' => 'role',
-  };
-
-To restrict access to any action, you can use the C<check_user_roles> method:
-
-  sub restricted : Local {
-     my ( $self, $c ) = @_;
-
-     $c->detach("unauthorized")
-       unless $c->check_user_roles( "admin" );
-
-     # do something restricted here
-  }
-
-You can also use the C<assert_user_roles> method. This just gives an error if
-the current user does not have one of the required roles:
-
-  sub also_restricted : Global {
-    my ( $self, $c ) = @_;
-    $c->assert_user_roles( qw/ user admin / );
-  }
-  
 =head2 Authentication/Authorization
 
 This is done in several steps:
@@ -327,27 +271,29 @@ This is done in several steps:
 =item Verification
 
 Getting the user to identify themselves, by giving you some piece of
-information known only to you and the user. Then you can assume that the user
-is who they say they are. This is called B<credential verification>.
+information known only to you and the user. Then you can assume that
+the user is who they say they are. This is called B<credential
+verification>.
 
 =item Authorization
 
-Making sure the user only accesses functions you want them to access. This is
-done by checking the verified users data against your internal list of groups,
-or allowed persons for the current page.
+Making sure the user only accesses functions you want them to
+access. This is done by checking the verified user's data against your
+internal list of groups, or allowed persons for the current page.
 
 =back
 
 =head3 Modules
 
-The Catalyst Authentication system is made up of many interacting modules, to
-give you the most flexibility possible.
+The Catalyst Authentication system is made up of many interacting
+modules, to give you the most flexibility possible.
 
 =head4 Credential verifiers
 
-A Credential module tables the user input, and passes it to a Store, or some
-other system, for verification. Typically, a user object is created by either
-this module or the Store and made accessible by a C<< $c->user >> call.
+A Credential module tables the user input, and passes it to a Store,
+or some other system, for verification. Typically, a user object is
+created by either this module or the Store and made accessible by a
+C<< $c->user >> call.
 
 Examples:
 
@@ -357,19 +303,19 @@ Examples:
 
 =head3 Storage backends
 
-A Storage backend contains the actual data representing the users. It is
-queried by the credential verifiers. Updating the store is not done within
-this system, you will need to do it yourself.
+A Storage backend contains the actual data representing the users. It
+is queried by the credential verifiers. Updating the store is not done
+within this system; you will need to do it yourself.
 
 Examples:
 
- DBIC     - Storage using a database.
+ DBIC     - Storage using a database via DBIx::Class.
  Minimal  - Storage using a simple hash (for testing).
 
 =head3 User objects
 
-A User object is created by either the storage backend or the credential
-verifier, and filled with the retrieved user information.
+A User object is created by either the storage backend or the
+credential verifier, and is filled with the retrieved user information.
 
 Examples:
 
@@ -377,44 +323,74 @@ Examples:
 
 =head3 ACL authorization
 
-ACL stands for Access Control List. The ACL plugin allows you to regulate
-access on a path by path basis, by listing which users, or roles, have access
-to which paths.
+ACL stands for Access Control List. The ACL plugin allows you to
+regulate access on a path-by-path basis, by listing which users, or
+roles, have access to which paths.
 
 =head3 Roles authorization
 
-Authorization by roles is for assigning users to groups, which can then be
-assigned to ACLs, or just checked when needed.
+Authorization by roles is for assigning users to groups, which can
+then be assigned to ACLs, or just checked when needed.
 
 =head3 Logging in
 
 When you have chosen your modules, all you need to do is call the C<<
-$c->login >> method. If called with no parameters, it will try to find
-suitable parameters, such as B<username> and B<password>, or you can pass it
-these values.
+$c->authenticate >> method. If called with no parameters, it will try to find
+suitable parameters, such as B<username> and B<password>, or you can
+pass it these values.
 
 =head3 Checking roles
 
-Role checking is done by using the C<< $c->check_user_roles >> method, this will
-check using the currently logged in user (via C<< $c->user >>). You pass it
-the name of a role to check, and it returns true if the user is a member.
+Role checking is done by using the C<< $c->check_user_roles >> method.
+This will check using the currently logged-in user (via C<< $c->user
+>>). You pass it the name of a role to check, and it returns true if
+the user is a member.
 
 =head3 EXAMPLE
 
- use Catalyst qw/Authentication
-                 Authentication::Credential::Password
-                 Authentication::Store::Htpasswd
-                 Authorization::Roles/;
+  package MyApp;
+  use Moose;
+  use namespace::autoclean;
+  extends qw/Catalyst/;
+  use Catalyst qw/
+    Authentication
+    Authorization::Roles
+  /;
 
- __PACKAGE__->config->{authentication}{htpasswd} = "passwdfile";
+  __PACKAGE__->config(
+     authentication => {
+         default_realm => 'test',
+         realms => {
+             test => {
+                 credential => {
+                     class          => 'Password',
+                     password_field => 'password',
+                     password_type  => 'self_check',
+                 },
+                 store => {
+                     class => 'Htpasswd',
+                     file => 'htpasswd',
+                 },
+             },
+         },
+     },   
+  );
 
+  package MyApp::Controller::Root;
+  use Moose;
+  use namespace::autoclean;
+  
+  BEGIN { extends 'Catalyst::Controller' }
+  
+  __PACKAGE__->config(namespace => '');
+  
   sub login : Local {
      my ($self, $c) = @_;
 
      if (    my $user = $c->req->param("user")
          and my $password = $c->req->param("password") )
      {
-         if ( $c->login( $user, $password ) ) {
+         if ( $c->authenticate( username => $user, password => $password ) ) {
               $c->res->body( "hello " . $c->user->name );
          } else {
             # login incorrect
@@ -436,50 +412,42 @@ the name of a role to check, and it returns true if the user is a member.
 
 =head3 Using authentication in a testing environment
 
-Ideally, to write tests for authentication/authorization code one would first
-set up a test database with known data, then use
-L<Test::WWW::Mechanize::Catalyst> to simulate a user logging in. Unfortunately
-the former can be rather awkward, which is why it's a good thing that the
-authentication framework is so flexible.
+Ideally, to write tests for authentication/authorization code one would
+first set up a test database with known data, then use
+L<Test::WWW::Mechanize::Catalyst> to simulate a user logging
+in. Unfortunately this can be rather awkward, which is why it's a good
+thing that the authentication framework is so flexible.
 
-Instead of using a test database, one can simply change the authentication
-store to something a bit easier to deal with in a testing
-environment. Additionally, this has the advantage of not modifying one's
-database, which can be problematic if one forgets to use the testing instead of
-production database.
+Instead of using a test database, one can simply change the
+authentication store to something a bit easier to deal with in a
+testing environment. Additionally, this has the advantage of not
+modifying one's database, which can be problematic if one forgets to
+use the testing instead of production database.
 
-e.g.,
-
-  use Catalyst::Plugin::Authentication::Store::Minimal::Backend;
-
-  # Sets up the user `test_user' with password `test_pass'
-  MyApp->default_auth_store(
-    Catalyst::Plugin::Authentication::Store::Minimal::Backend->new({
-      test_user => { password => 'test_pass' },
-    })
-  );
-
-Now, your test code can call C<$c->login('test_user', 'test_pass')> and
-successfully login, without messing with the database at all.
+Alternatively, if you want to authenticate real users, but not have to
+worry about their passwords, you can use
+L<Catalyst::Authentication::Credential::Testing> to force all users to
+authenticate with a global password.
 
 =head3 More information
 
-L<http://search.cpan.org/perldoc?Catalyst::Plugin::Authentication> has a longer explanation.
+L<Catalyst::Plugin::Authentication> has a longer explanation.
 
 =head2 Authorization
 
 =head3 Introduction
 
-Authorization is the step that comes after authentication. Authentication
-establishes that the user agent is really representing the user we think it's
-representing, and then authorization determines what this user is allowed to
-do.
+Authorization is the step that comes after
+authentication. Authentication establishes that the user agent is really
+representing the user we think it's representing, and then authorization
+determines what this user is allowed to do.
 
 =head3 Role Based Access Control
 
-Under role based access control each user is allowed to perform any number of
-roles. For example, at a zoo no one but specially trained personnel can enter
-the moose cage (Mynd you, møøse bites kan be pretty nasti!). For example: 
+Under role based access control each user is allowed to perform any
+number of roles. For example, at a zoo no one but specially trained
+personnel can enter the moose cage (Mynd you, møøse bites kan be
+pretty nasti!). For example:
 
     package Zoo::Controller::MooseCage;
 
@@ -489,17 +457,18 @@ the moose cage (Mynd you, møøse bites kan be pretty nasti!). For example:
         $c->model( "Moose" )->eat( $c->req->param("food") );
     }
 
-With this action, anyone can just come into the moose cage and feed the moose,
-which is a very dangerous thing. We need to restrict this action, so that only
-a qualified moose feeder can perform that action.
+With this action, anyone can just come into the moose cage and feed
+the moose, which is a very dangerous thing. We need to restrict this
+action, so that only a qualified moose feeder can perform that action.
 
-The Authorization::Roles plugin let's us perform role based access control
-checks. Let's load it:
+The Authorization::Roles plugin lets us perform role based access
+control checks. Let's load it:
 
+    use parent qw/Catalyst/;
     use Catalyst qw/
-        Authentication # yadda yadda
-        Authorization::Roles
-    /;
+                    Authentication
+                    Authorization::Roles
+                  /;
 
 And now our action should look like this:
 
@@ -513,11 +482,11 @@ And now our action should look like this:
         }
     }
 
-This checks C<< $c->user >>, and only if the user has B<all> the roles in the
-list, a true value is returned.
+This checks C<< $c->user >>, and only if the user has B<all> the roles
+in the list, a true value is returned.
 
-C<check_roles> has a sister method, C<assert_roles>, which throws an exception
-if any roles are missing.
+C<check_roles> has a sister method, C<assert_roles>, which throws an
+exception if any roles are missing.
 
 Some roles that might actually make sense in, say, a forum application:
 
@@ -533,62 +502,65 @@ moderator
 
 =back
 
-each with a distinct task (system administration versus content administration).
+each with a distinct task (system administration versus content
+administration).
 
 =head3 Access Control Lists
 
 Checking for roles all the time can be tedious and error prone.
 
-The Authorization::ACL plugin let's us declare where we'd like checks to be
-done automatically for us.
+The Authorization::ACL plugin lets us declare where we'd like checks
+to be done automatically for us.
 
 For example, we may want to completely block out anyone who isn't a
 C<moose_feeder> from the entire C<MooseCage> controller:
 
     Zoo->deny_access_unless( "/moose_cage", [qw/moose_feeder/] );
 
-The role list behaves in the same way as C<check_roles>. However, the ACL
-plugin isn't limited to just interacting with the Roles plugin. We can use a
-code reference instead. For example, to allow either moose trainers or moose
-feeders into the moose cage, we can create a more complex check:
+The role list behaves in the same way as C<check_roles>. However, the
+ACL plugin isn't limited to just interacting with the Roles plugin. We
+can use a code reference instead. For example, to allow either moose
+trainers or moose feeders into the moose cage, we can create a more
+complex check:
 
     Zoo->deny_access_unless( "/moose_cage", sub {
         my $c = shift;
         $c->check_roles( "moose_trainer" ) || $c->check_roles( "moose_feeder" );
     });
 
-The more specific a role, the earlier it will be checked. Let's say moose
-feeders are now restricted to only the C<feed_moose> action, while moose
-trainers get access everywhere:
+The more specific a role, the earlier it will be checked. Let's say
+moose feeders are now restricted to only the C<feed_moose> action,
+while moose trainers get access everywhere:
 
     Zoo->deny_access_unless( "/moose_cage", [qw/moose_trainer/] );
     Zoo->allow_access_if( "/moose_cage/feed_moose", [qw/moose_feeder/]);
 
-When the C<feed_moose> action is accessed the second check will be made. If the
-user is a C<moose_feeder>, then access will be immediately granted. Otherwise,
-the next rule in line will be tested - the one checking for a C<moose_trainer>.
-If this rule is not satisfied, access will be immediately denied.
+When the C<feed_moose> action is accessed the second check will be
+made. If the user is a C<moose_feeder>, then access will be
+immediately granted. Otherwise, the next rule in line will be tested -
+the one checking for a C<moose_trainer>.  If this rule is not
+satisfied, access will be immediately denied.
 
-Rules applied to the same path will be checked in the order they were added.
+Rules applied to the same path will be checked in the order they were
+added.
 
-Lastly, handling access denial events is done by creating an C<access_denied>
-private action:
+Lastly, handling access denial events is done by creating an
+C<access_denied> private action:
 
     sub access_denied : Private {
         my ( $self, $c, $action ) = @_;
-
-        
     }
 
-This action works much like auto, in that it is inherited across namespaces
-(not like object oriented code). This means that the C<access_denied> action
-which is B<nearest> to the action which was blocked will be triggered.
+This action works much like auto, in that it is inherited across
+namespaces (not like object oriented code). This means that the
+C<access_denied> action which is B<nearest> to the action which was
+blocked will be triggered.
 
-If this action does not exist, an error will be thrown, which you can clean up
-in your C<end> private action instead.
+If this action does not exist, an error will be thrown, which you can
+clean up in your C<end> private action instead.
 
-Also, it's important to note that if you restrict access to "/" then C<end>,
-C<default>, etc will also be restricted.
+Also, it's important to note that if you restrict access to "/" then
+C<end>, C<default>, etc. will also be restricted.
 
    MyApp->acl_allow_root_internals;
 
@@ -603,17 +575,20 @@ are just the start.
 
 =head2 Using existing DBIC (etc.) classes with Catalyst
 
-Many people have existing Model classes that they would like to use with
-Catalyst (or, conversely, they want to write Catalyst models that can be
-used outside of Catalyst, e.g.  in a cron job). It's trivial to write a
-simple component in Catalyst that slurps in an outside Model:
+Many people have existing Model classes that they would like to use
+with Catalyst (or, conversely, they want to write Catalyst models that
+can be used outside of Catalyst, e.g.  in a cron job). It's trivial to
+write a simple component in Catalyst that slurps in an outside Model:
 
     package MyApp::Model::DB;
+
     use base qw/Catalyst::Model::DBIC::Schema/;
+
     __PACKAGE__->config(
         schema_class => 'Some::DBIC::Schema',
         connect_info => ['dbi:SQLite:foo.db', '', '', {AutoCommit=>1}];
     );
+
     1;
 
 and that's it! Now C<Some::DBIC::Schema> is part of your
@@ -623,9 +598,41 @@ Cat app as C<MyApp::Model::DB>.
 
 See L<Catalyst::Model::DBIC::Schema>.
 
+=head2 Create accessors to preload static data once per server instance
+
+When you have data that you want to load just once from the model at
+startup, instead of for each request, use mk_group_accessors to
+create accessors and tie them to resultsets in your package that
+inherits from DBIx::Class::Schema:
+
+    package My::Schema;
+    use base qw/DBIx::Class::Schema/;
+    __PACKAGE__->register_class('RESULTSOURCEMONIKER',
+                                'My::Schema::RESULTSOURCE');
+    __PACKAGE__->mk_group_accessors('simple' =>
+                                qw(ACCESSORNAME1 ACCESSORNAME2 ACCESSORNAMEn));
+
+    sub connection {
+        my ($self, @rest) = @_;
+        $self->next::method(@rest);
+        # $self is now a live My::Schema object, complete with DB connection
+
+        $self->ACCESSORNAME1([ $self->resultset('RESULTSOURCEMONIKER')->all ]);
+        $self->ACCESSORNAME2([ $self->resultset('RESULTSOURCEMONIKER')->search({ COLUMN => { '<' => '30' } })->all ]);
+        $self->ACCESSORNAMEn([ $self->resultset('RESULTSOURCEMONIKER')->find(1) ]);
+    }
+
+    1;
+
+and now in the controller, you can now access any of these without a
+per-request fetch:
+
+    $c->stash->{something} = $c->model('My::Schema')->schema->ACCESSORNAME;
+
+
 =head2 XMLRPC
 
-Unlike SOAP, XMLRPC is a very simple (and imo elegant) web-services
+Unlike SOAP, XMLRPC is a very simple (and elegant) web-services
 protocol, exchanging small XML messages like these:
 
 Request:
@@ -687,7 +694,7 @@ later) and SOAP::Lite (for XMLRPCsh.pl).
 5. Add a XMLRPC redispatch method and an add method with Remote
 attribute to lib/MyApp/Controller/API.pm
 
-    sub default : Private {
+    sub default :Path {
         my ( $self, $c ) = @_;
         $c->xmlrpc;
     }
@@ -724,13 +731,11 @@ enforce a specific one.
         my ( $self, $c, $a, $b ) = @_;
         return RPC::XML::int->new( $a + $b );
     }
-    
-
 
 =head1 Views
 
 Views pertain to the display of your application.  As with models,
-catalyst is uncommonly flexible.  The recipes below are just a start.
+Catalyst is uncommonly flexible.  The recipes below are just a start.
 
 =head2 Catalyst::View::TT
 
@@ -740,8 +745,8 @@ display your data; you can choose to generate HTML, PDF files, or plain
 text if you wanted.
 
 Most Catalyst applications use a template system to generate their HTML,
-and though there are several template systems available, Template
-Toolkit is probably the most popular.
+and though there are several template systems available, 
+L<Template Toolkit|Template> is probably the most popular.
 
 Once again, the Catalyst developers have done all the hard work, and
 made things easy for the rest of us. Catalyst::View::TT provides the
@@ -803,7 +808,7 @@ This time, the helper sets several options for us in the generated View.
 
 =over
 
-=item 
+=item
 
 INCLUDE_PATH defines the directories that Template Toolkit should search
 for the template files.
@@ -912,15 +917,35 @@ In your template, you can use the following:
 
     <a href="[% c.uri_for('/login') %]">Login Here</a>
 
-Although the parameter starts with a forward slash, this is relative to the application root, not the webserver root. This is important to remember. So, if your application is installed at http://www.domain.com/Calendar, then the link would be http://www.mydomain.com/Calendar/Login. If you move your application to a different domain or path, then that link will still be correct.
+Although the parameter starts with a forward slash, this is relative
+to the application root, not the webserver root. This is important to
+remember. So, if your application is installed at
+http://www.domain.com/Calendar, then the link would be
+http://www.mydomain.com/Calendar/Login. If you move your application
+to a different domain or path, then that link will still be correct.
 
 Likewise,
 
     <a href="[% c.uri_for('2005','10', '24') %]">October, 24 2005</a>
 
-The first parameter does NOT have a forward slash, and so it will be relative to the current namespace. If the application is installed at http://www.domain.com/Calendar. and if the template is called from MyApp::Controller::Display, then the link would become http://www.domain.com/Calendar/Display/2005/10/24.
+The first parameter does NOT have a forward slash, and so it will be
+relative to the current namespace. If the application is installed at
+http://www.domain.com/Calendar. and if the template is called from
+MyApp::Controller::Display, then the link would become
+http://www.domain.com/Calendar/Display/2005/10/24.
+
+If you want to link to a parent uri of your current namespace you can
+prefix the arguments with multiple '../':
 
-Once again, this allows you to move your application around without having to worry about broken links. But there's something else, as well. Since the links are generated by uri_for, you can use the same template file by several different controllers, and each controller will get the links that its supposed to. Since we believe in Don't Repeat Yourself, this is particularly helpful if you have common elements in your site that you want to keep in one file.
+    <a href="[% c.uri_for('../../view', stashed_object.id) %]">User view</a>
+
+Once again, this allows you to move your application around without
+having to worry about broken links. But there's something else, as
+well. Since the links are generated by uri_for, you can use the same
+template file by several different controllers, and each controller
+will get the links that its supposed to. Since we believe in Don't
+Repeat Yourself, this is particularly helpful if you have common
+elements in your site that you want to keep in one file.
 
 Further Reading:
 
@@ -930,7 +955,7 @@ L<http://search.cpan.org/perldoc?Catalyst%3A%3AView%3A%3ATT>
 
 L<http://search.cpan.org/perldoc?Template>
 
-=head2 Adding RSS feeds 
+=head2 Adding RSS feeds
 
 Adding RSS feeds to your Catalyst applications is simple. We'll see two
 different aproaches here, but the basic premise is that you forward to
@@ -947,7 +972,7 @@ This is the aproach used in Agave (L<http://dev.rawmode.org/>).
         $c->stash->{template}='rss.tt';
     }
 
-Then you need a template. Here's the one from Agave: 
+Then you need a template. Here's the one from Agave:
 
     <?xml version="1.0" encoding="UTF-8"?>
     <rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/">
@@ -960,7 +985,7 @@ Then you need a template. Here's the one from Agave:
      [% WHILE (post = posts.next) %]
       <item>
         <title>[% post.title %]</title>
-        <description>[% post.formatted_teaser|html%]</description>    
+        <description>[% post.formatted_teaser|html%]</description>
         <pubDate>[% post.pub_date %]</pubDate>
         <guid>[% post.full_uri %]</guid>
         <link>[% post.full_uri %]</link>
@@ -968,11 +993,11 @@ Then you need a template. Here's the one from Agave:
       </item>
     [% END %]
       </channel>
-    </rss> 
+    </rss>
 
 =head3 Using XML::Feed
 
-A more robust solution is to use XML::Feed, as was done in the Catalyst
+A more robust solution is to use L<XML::Feed>, as was done in the Catalyst
 Advent Calendar. Assuming we have a C<view> action that populates
 'entries' with some DBIx::Class iterator, the code would look something
 like this:
@@ -998,7 +1023,7 @@ like this:
    }
 
 A little more code in the controller, but with this approach you're
-pretty sure to get something that validates. 
+pretty sure to get something that validates.
 
 Note that for both of the above aproaches, you'll need to set the
 content type like this:
@@ -1059,51 +1084,22 @@ set the appropriate content type and disposition.
 Controllers are the main point of communication between the web server
 and your application.  Here we explore some aspects of how they work.
 
-=head2 Extending RenderView (formerly DefaultEnd)
-
-The recommended approach for an C<end> action is to use
-L<Catalyst::Action::RenderView> (taking the place of
-L<Catalyst::Plugin::DefaultEnd>), which does what you usually need.
-However there are times when you need to add a bit to it, but don't want
-to write your own C<end> action.
-
-You can extend it like this:
-
-To add something to an C<end> action that is called before rendering
-(this is likely to be what you want), simply place it in the C<end>
-method:
-
-    sub end : ActionClass('RenderView') {
-      my ( $self, $c ) = @_;
-      # do stuff here; the RenderView action is called afterwards
-    }
-
-To add things to an C<end> action that are called I<after> rendering,
-you can set it up like this:
-
-    sub render : ActionClass('RenderView') { }
-
-    sub end : Private { 
-      my ( $self, $c ) = @_;
-      $c->forward('render');
-      # do stuff here
-    }
-  
 =head2 Action Types
 
 =head3 Introduction
 
-A Catalyst application is driven by one or more Controller modules. There are
-a number of ways that Catalyst can decide which of the methods in your
-controller modules it should call. Controller methods are also called actions,
-because they determine how your catalyst application should (re-)act to any
-given URL. When the application is started up, catalyst looks at all your
-actions, and decides which URLs they map to.
+A Catalyst application is driven by one or more Controller
+modules. There are a number of ways that Catalyst can decide which of
+the methods in your controller modules it should call. Controller
+methods are also called actions, because they determine how your
+catalyst application should (re-)act to any given URL. When the
+application is started up, catalyst looks at all your actions, and
+decides which URLs they map to.
 
 =head3 Type attributes
 
 Each action is a normal method in your controller, except that it has an
-L<attribute|http://search.cpan.org/~nwclark/perl-5.8.7/lib/attributes.pm>
+L<attribute|attributes>
 attached. These can be one of several types.
 
 Assume our Controller module starts with the following package declaration:
@@ -1118,8 +1114,9 @@ server default).
 =item Path
 
 A Path attribute also takes an argument, this can be either a relative
-or an absolute path. A relative path will be relative to the controller
-namespace, an absolute path will represent an exact matching URL.
+or an absolute path. A relative path will be relative to the
+controller namespace, an absolute path will represent an exact
+matching URL.
 
  sub my_handles : Path('handles') { .. }
 
@@ -1131,15 +1128,17 @@ and
 
  sub my_handles : Path('/handles') { .. }
 
-becomes 
+becomes
 
  http://localhost:3000/handles
 
+See also: L<Catalyst::DispatchType::Path>
+
 =item Local
 
-When using a Local attribute, no parameters are needed, instead, the name of
-the action is matched in the URL. The namespaces created by the name of the
-controller package is always part of the URL.
+When using a Local attribute, no parameters are needed, instead, the
+name of the action is matched in the URL. The namespaces created by
+the name of the controller package is always part of the URL.
 
  sub my_handles : Local { .. }
 
@@ -1149,8 +1148,8 @@ becomes
 
 =item Global
 
-A Global attribute is similar to a Local attribute, except that the namespace
-of the controller is ignored, and matching starts at root.
+A Global attribute is similar to a Local attribute, except that the
+namespace of the controller is ignored, and matching starts at root.
 
  sub my_handles : Global { .. }
 
@@ -1160,9 +1159,9 @@ becomes
 
 =item Regex
 
-By now you should have figured that a Regex attribute is just what it sounds
-like. This one takes a regular expression, and matches starting from
-root. These differ from the rest as they can match multiple URLs.
+By now you should have figured that a Regex attribute is just what it
+sounds like. This one takes a regular expression, and matches starting
+from root. These differ from the rest as they can match multiple URLs.
 
  sub my_handles : Regex('^handles') { .. }
 
@@ -1170,12 +1169,14 @@ matches
 
  http://localhost:3000/handles
 
-and 
+and
 
  http://localhost:3000/handles_and_other_parts
 
 etc.
 
+See also: L<Catalyst::DispatchType::Regex>
+
 =item LocalRegex
 
 A LocalRegex is similar to a Regex, except it only matches below the current
@@ -1193,41 +1194,47 @@ and
 
 etc.
 
+=item Chained
+
+See L<Catalyst::DispatchType::Chained> for a description of how the chained
+dispatch type works.
+
 =item Private
 
-Last but not least, there is the Private attribute, which allows you to create
-your own internal actions, which can be forwarded to, but won't be matched as
-URLs.
+Last but not least, there is the Private attribute, which allows you
+to create your own internal actions, which can be forwarded to, but
+won't be matched as URLs.
 
  sub my_handles : Private { .. }
 
 becomes nothing at all..
 
-Catalyst also predefines some special Private actions, which you can override,
-these are:
+Catalyst also predefines some special Private actions, which you can
+override, these are:
 
 =over 4
 
 =item default
 
-The default action will be called, if no other matching action is found. If
-you don't have one of these in your namespace, or any sub part of your
-namespace, you'll get an error page instead. If you want to find out where it
-was the user was trying to go, you can look in the request object using 
-C<< $c->req->path >>.
+The default action will be called, if no other matching action is
+found. If you don't have one of these in your namespace, or any sub
+part of your namespace, you'll get an error page instead. If you want
+to find out where it was the user was trying to go, you can look in
+the request object using C<< $c->req->path >>.
 
- sub default : Private { .. }
+ sub default :Path { .. }
 
-works for all unknown URLs, in this controller namespace, or every one if put
-directly into MyApp.pm.
+works for all unknown URLs, in this controller namespace, or every one
+if put directly into MyApp.pm.
 
-=item index 
+=item index
 
-The index action is called when someone tries to visit the exact namespace of
-your controller. If index, default and matching Path actions are defined, then
-index will be used instead of default and Path.
+The index action is called when someone tries to visit the exact
+namespace of your controller. If index, default and matching Path
+actions are defined, then index will be used instead of default and
+Path.
 
- sub index : Private { .. }
+ sub index :Path :Args(0) { .. }
 
 becomes
 
@@ -1235,14 +1242,15 @@ becomes
 
 =item begin
 
-The begin action is called at the beginning of every request involving this
-namespace directly, before other matching actions are called. It can be used
-to set up variables/data for this particular part of your app. A single begin
-action is called, its always the one most relevant to the current namespace.
+The begin action is called at the beginning of every request involving
+this namespace directly, before other matching actions are called. It
+can be used to set up variables/data for this particular part of your
+app. A single begin action is called, its always the one most relevant
+to the current namespace.
 
  sub begin : Private { .. }
 
-is called once when 
+is called once when
 
  http://localhost:3000/bucket/(anything)?
 
@@ -1250,10 +1258,10 @@ is visited.
 
 =item end
 
-Like begin, this action is always called for the namespace it is in, after
-every other action has finished. It is commonly used to forward processing to
-the View component. A single end action is called, its always the one most
-relevant to the current namespace. 
+Like begin, this action is always called for the namespace it is in,
+after every other action has finished. It is commonly used to forward
+processing to the View component. A single end action is called, its
+always the one most relevant to the current namespace.
 
 
  sub end : Private { .. }
@@ -1266,19 +1274,19 @@ is visited.
 
 =item auto
 
-Lastly, the auto action is magic in that B<every> auto action in
-the chain of paths up to and including the ending namespace, will be
-called. (In contrast, only one of the begin/end/default actions will be
-called, the relevant one).
+Lastly, the auto action is magic in that B<every> auto action in the
+chain of paths up to and including the ending namespace, will be
+called. (In contrast, only one of the begin/end/default actions will
+be called, the relevant one).
 
- package MyApp.pm;
+ package MyApp::Controller::Root;
  sub auto : Private { .. }
 
-and 
+and
 
  sub auto : Private { .. }
 
-will both be called when visiting 
+will both be called when visiting
 
  http://localhost:3000/bucket/(anything)?
 
@@ -1288,15 +1296,78 @@ will both be called when visiting
 
 =head3 A word of warning
 
-Due to possible namespace conflicts with Plugins, it is advised to only put the
-pre-defined Private actions in your main MyApp.pm file, all others should go
-in a Controller module.
+You can put root actions in your main MyApp.pm file, but this is deprecated,
+please put your actions into your Root controller.
 
-=head3 More Information
+=head3 Flowchart
+
+A graphical flowchart of how the dispatcher works can be found on the wiki at
+L<http://dev.catalyst.perl.org/attachment/wiki/WikiStart/catalyst-flow.png>.
+
+=head2 DRY Controllers with Chained actions
+
+Imagine that you would like the following paths in your application:
+
+=over
 
-L<http://search.cpan.org/author/SRI/Catalyst-5.61/lib/Catalyst/Manual/Intro.pod>
+=item B<< /cd/<ID>/track/<ID> >>
 
-L<http://dev.catalyst.perl.org/wiki/FlowChart>
+Displays info on a particular track.
+
+In the case of a multi-volume CD, this is the track sequence.
+
+=item B<< /cd/<ID>/volume/<ID>/track/<ID> >>
+
+Displays info on a track on a specific volume.
+
+=back
+
+Here is some example code, showing how to do this with chained controllers:
+
+    package CD::Controller;
+    use base qw/Catalyst::Controller/;
+
+    sub root : Chained('/') PathPart('/cd') CaptureArgs(1) {
+        my ($self, $c, $cd_id) = @_;
+        $c->stash->{cd_id} = $cd_id;
+        $c->stash->{cd} = $self->model('CD')->find_by_id($cd_id);
+    }
+
+    sub trackinfo : Chained('track') PathPart('') Args(0) RenderView {
+        my ($self, $c) = @_;
+    }
+
+    package CD::Controller::ByTrackSeq;
+    use base qw/CD::Controller/;
+
+    sub track : Chained('root') PathPart('track') CaptureArgs(1) {
+        my ($self, $c, $track_seq) = @_;
+        $c->stash->{track} = $self->stash->{cd}->find_track_by_seq($track_seq);
+    }
+
+    package CD::Controller::ByTrackVolNo;
+    use base qw/CD::Controller/;
+
+    sub volume : Chained('root') PathPart('volume') CaptureArgs(1) {
+        my ($self, $c, $volume) = @_;
+        $c->stash->{volume} = $volume;
+    }
+
+    sub track : Chained('volume') PathPart('track') CaptureArgs(1) {
+        my ($self, $c, $track_no) = @_;
+        $c->stash->{track} = $self->stash->{cd}->find_track_by_vol_and_track_no(
+            $c->stash->{volume}, $track_no
+        );
+    }
+
+Note that adding other actions (i.e. chain endpoints) which operate on a track
+is simply a matter of adding a new sub to CD::Controller - no code is duplicated,
+even though there are two different methods of looking up a track.
+
+This technique can be expanded as needed to fulfil your requirements - for example,
+if you inherit the first action of a chain from a base class, then mixing in a
+different base class can be used to duplicate an entire URL hieratchy at a different
+point within your application.
 
 =head2 Component-based Subrequests
 
@@ -1401,9 +1472,47 @@ the Catalyst Request object:
   $c->req->args([qw/arg1 arg2 arg3/]);
   $c->forward('/wherever');
 
-(See the L<Catalyst::Manual::Intro> Flow_Control section for more 
+(See the L<Catalyst::Manual::Intro> Flow_Control section for more
 information on passing arguments via C<forward>.)
 
+=head2 Chained dispatch using base classes, and inner packages.
+
+  package MyApp::Controller::Base;
+  use base qw/Catalyst::Controller/;
+
+  sub key1 : Chained('/')
+  
+=head2 Extending RenderView (formerly DefaultEnd)
+
+The recommended approach for an C<end> action is to use
+L<Catalyst::Action::RenderView> (taking the place of
+L<Catalyst::Plugin::DefaultEnd>), which does what you usually need.
+However there are times when you need to add a bit to it, but don't want
+to write your own C<end> action.
+
+You can extend it like this:
+
+To add something to an C<end> action that is called before rendering
+(this is likely to be what you want), simply place it in the C<end>
+method:
+
+    sub end : ActionClass('RenderView') {
+      my ( $self, $c ) = @_;
+      # do stuff here; the RenderView action is called afterwards
+    }
+
+To add things to an C<end> action that are called I<after> rendering,
+you can set it up like this:
+
+    sub render : ActionClass('RenderView') { }
+
+    sub end : Private {
+      my ( $self, $c ) = @_;
+      $c->forward('render');
+      # do stuff here
+    }
+
+  
 
 =head1 Deployment
 
@@ -1458,7 +1567,7 @@ to run a Catalyst app.
 
 =head4 1. Install Catalyst::Engine::Apache
 
-You should install the latest versions of both Catalyst and 
+You should install the latest versions of both Catalyst and
 Catalyst::Engine::Apache.  The Apache engines were separated from the
 Catalyst core in version 5.50 to allow for updates to the engine without
 requiring a new Catalyst release.
@@ -1485,7 +1594,7 @@ Here is a basic Apache 2 configuration.
 
     PerlSwitches -I/var/www/MyApp/lib
     PerlModule MyApp
-    
+
     <Location />
         SetHandler          modperl
         PerlResponseHandler MyApp
@@ -1517,7 +1626,7 @@ of your choice.
         SetHandler          modperl
         PerlResponseHandler MyApp
     </Location>
-    
+
 When running this way, it is best to make use of the C<uri_for> method in
 Catalyst for constructing correct links.
 
@@ -1529,11 +1638,30 @@ Static files can be served directly by Apache for a performance boost.
     <Location /static>
         SetHandler default-handler
     </Location>
-    
+
 This will let all files within root/static be handled directly by Apache.  In
 a two-tiered setup, the frontend server should handle static files.
 The configuration to do this on the frontend will vary.
 
+The same is accomplished in lighttpd with the following snippet:
+
+   $HTTP["url"] !~ "^/(?:img/|static/|css/|favicon.ico$)" {
+         fastcgi.server = (
+             "" => (
+                 "MyApp" => (
+                     "socket"       => "/tmp/myapp.socket",
+                     "check-local"  => "disable",
+                 )
+             )
+         )
+    }
+
+Which serves everything in the img, static, css directories
+statically, as well as the favicon file.
+
+Note the path of the application needs to be stated explicitly in the
+web server configuration for both these recipes.
+
 =head2 Catalyst on shared hosting
 
 So, you want to put your Catalyst app out there for the whole world to
@@ -1616,6 +1744,9 @@ can be used without worrying about the thread safety of your application.
 
 =head3 Cons
 
+You may have to disable mod_deflate.  If you experience page hangs with
+mod_fastcgi then remove deflate.load and deflate.conf from mods-enabled/
+
 =head4 More complex environment
 
 With FastCGI, there are more things to monitor and more processes running
@@ -1629,6 +1760,9 @@ mod_fastcgi for Apache is a third party module, and can be found at
 L<http://www.fastcgi.com/>.  It is also packaged in many distributions,
 for example, libapache2-mod-fastcgi in Debian.
 
+Important Note! If you experience difficulty properly rendering pages,
+try disabling Apache's mod_deflate (Deflate Module), e.g. 'a2dismod deflate'.
+
 =head4 2. Configure your application
 
     # Serve static content directly
@@ -1637,10 +1771,10 @@ for example, libapache2-mod-fastcgi in Debian.
 
     FastCgiServer /var/www/MyApp/script/myapp_fastcgi.pl -processes 3
     Alias /myapp/ /var/www/MyApp/script/myapp_fastcgi.pl/
-    
+
     # Or, run at the root
     Alias / /var/www/MyApp/script/myapp_fastcgi.pl/
-    
+
 The above commands will launch 3 app processes and make the app available at
 /myapp/
 
@@ -1652,12 +1786,12 @@ server gives you much more flexibility.
 First, launch your app as a standalone server listening on a socket.
 
     script/myapp_fastcgi.pl -l /tmp/myapp.socket -n 5 -p /tmp/myapp.pid -d
-    
+
 You can also listen on a TCP port if your web server is not on the same
 machine.
 
     script/myapp_fastcgi.pl -l :8080 -n 5 -p /tmp/myapp.pid -d
-    
+
 You will probably want to write an init script to handle starting/stopping
 of the app using the pid file.
 
@@ -1671,10 +1805,10 @@ Now, we simply configure Apache to connect to the running server.
 
     FastCgiExternalServer /tmp/myapp.fcgi -socket /tmp/myapp.socket
     Alias /myapp/ /tmp/myapp.fcgi/
-    
+
     # Or, run at the root
     Alias / /tmp/myapp.fcgi/
-    
+
 =head3 More Info
 
 L<Catalyst::Engine::FastCGI>.
@@ -1684,12 +1818,10 @@ L<Catalyst::Engine::FastCGI>.
 The development server is a mini web server written in perl.  If you
 expect a low number of hits or you don't need mod_perl/FastCGI speed,
 you could use the development server as the application server with a
-lightweight proxy web server at the front.  However, be aware that
-there are known issues, especially with Internet Explorer.  Many of
-these issues can be dealt with by running the server with the -k
-(keepalive) option but be aware for more complex applications this may
-not be suitable.  Consider using Catalyst::Engine::HTTP::POE.  This
-recipe is easily adapted for POE as well.
+lightweight proxy web server at the front.  However, consider using
+L<Catalyst::Engine::HTTP::Prefork> for this kind of deployment instead, since
+it can better handle multiple concurrent requests without forking, or can
+prefork a set number of servers for improved performance.
 
 =head3 Pros
 
@@ -1714,7 +1846,7 @@ save forking.
 
 =head4 Start up the development server
 
-   script/myapp_server.pl -p 8080 -k  -f -pidfile=/tmp/myapp.pid -daemon
+   script/myapp_server.pl -p 8080 -k  -f -pidfile=/tmp/myapp.pid
 
 You will probably want to write an init script to handle stop/starting
 the app using the pid file.
@@ -1732,9 +1864,18 @@ Make sure mod_proxy is enabled and add:
         Order deny,allow
         Allow from all
     </Proxy>
+
+    # Need to specifically stop these paths from being passed to proxy
+    ProxyPass /static !
+    ProxyPass /favicon.ico !
+
     ProxyPass / http://localhost:8080/
     ProxyPassReverse / http://localhost:8080/
 
+    # This is optional if you'd like to show a custom error page
+    # if the proxy is not available
+    ErrorDocument 502 /static/error_pages/http502.html
+
 You can wrap the above within a VirtualHost container if you want
 different apps served on the same host.
 
@@ -1769,6 +1910,33 @@ L<Module::Install::Catalyst>, which simplifies the process greatly.  From the sh
     % perl Makefile.PL
     % make catalyst_par
 
+You can customise the PAR creation process by special "catalyst_par_*" commands
+available from L<Module::Install::Catalyst>. You can add these commands in your
+Makefile.PL just before the line containing "catalyst;"
+
+    #Makefile.PL example with extra PAR options
+    use inc::Module::Install;
+
+    name 'MyApp';
+    all_from 'lib\MyApp.pm';
+
+    requires 'Catalyst::Runtime' => '5.80005';
+    <snip>
+    ...
+    <snip>
+
+    catalyst_par_core(1);      # bundle perl core modules in the resulting PAR
+    catalyst_par_multiarch(1); # build a multi-architecture PAR file
+    catalyst_par_classes(qw/
+      Some::Additional::Module
+      Some::Other::Module
+    /);          # specify additional modules you want to be included into PAR
+    catalyst;
+
+    install_script glob('script/*.pl');
+    auto_install;
+    WriteAll;
+
 Congratulations! Your package "myapp.par" is ready, the following
 steps are just optional.
 
@@ -1859,7 +2027,7 @@ Static::Simple look somewhere else, this is as easy as:
 
  MyApp->config->{static}->{include_path} = [
   MyApp->config->{root},
-  '/path/to/my/files' 
+  '/path/to/my/files'
  ];
 
 When you override include_path, it will not automatically append the
@@ -1884,7 +2052,7 @@ be processed by Catalyst): B<tmpl, tt, tt2, html, xhtml>. This list can
 be replaced easily:
 
  MyApp->config->{static}->{ignore_extensions} = [
-    qw/tmpl tt tt2 html xhtml/ 
+    qw/tmpl tt tt2 html xhtml/
  ];
 
 =item Ignoring directories
@@ -1915,7 +2083,7 @@ static content to the view, perhaps like this:
     sub end : Private {
         my ( $self, $c ) = @_;
 
-        $c->forward( 'MyApp::View::TT' ) 
+        $c->forward( 'MyApp::View::TT' )
           unless ( $c->res->body || !$c->stash->{template} );
     }
 
@@ -2017,24 +2185,24 @@ There are three wrapper plugins around common CPAN cache modules:
 Cache::FastMmap, Cache::FileCache, and Cache::Memcached.  These can be
 used to cache the result of slow operations.
 
-This very page you're viewing makes use of the FileCache plugin to cache the
+The Catalyst Advent Calendar uses the FileCache plugin to cache the
 rendered XHTML version of the source POD document.  This is an ideal
-application for a cache because the source document changes infrequently but
-may be viewed many times.
+application for a cache because the source document changes
+infrequently but may be viewed many times.
 
     use Catalyst qw/Cache::FileCache/;
-    
+
     ...
-    
+
     use File::stat;
     sub render_pod : Local {
         my ( self, $c ) = @_;
-        
+
         # the cache is keyed on the filename and the modification time
         # to check for updates to the file.
         my $file  = $c->path_to( 'root', '2005', '11.pod' );
         my $mtime = ( stat $file )->mtime;
-        
+
         my $cached_pod = $c->cache->get("$file $mtime");
         if ( !$cached_pod ) {
             $cached_pod = do_slow_pod_rendering();
@@ -2043,7 +2211,7 @@ may be viewed many times.
         }
         $c->stash->{pod} = $cached_pod;
     }
-    
+
 We could actually cache the result forever, but using a value such as 12 hours
 allows old entries to be automatically expired when they are no longer needed.
 
@@ -2060,26 +2228,26 @@ thing for every single user who views the page.
 
     sub front_page : Path('/') {
         my ( $self, $c ) = @_;
-        
+
         $c->forward( 'get_news_articles' );
         $c->forward( 'build_lots_of_boxes' );
         $c->forward( 'more_slow_stuff' );
-        
+
         $c->stash->{template} = 'index.tt';
     }
 
 We can add the PageCache plugin to speed things up.
 
     use Catalyst qw/Cache::FileCache PageCache/;
-    
+
     sub front_page : Path ('/') {
         my ( $self, $c ) = @_;
-        
+
         $c->cache_page( 300 );
-        
+
         # same processing as above
     }
-    
+
 Now the entire output of the front page, from <html> to </html>, will be
 cached for 5 minutes.  After 5 minutes, the next request will rebuild the
 page and it will be re-cached.
@@ -2092,14 +2260,14 @@ You can even get that front-end Squid proxy to help out by enabling HTTP
 headers for the cached page.
 
     MyApp->config->{page_cache}->{set_http_headers} = 1;
-    
+
 This would now set the following headers so proxies and browsers may cache
 the content themselves.
 
     Cache-Control: max-age=($expire_time - time)
     Expires: $expire_time
     Last-Modified: $cache_created_time
-    
+
 =head3 Template Caching
 
 Template Toolkit provides support for caching compiled versions of your
@@ -2108,17 +2276,17 @@ TT will cache compiled templates keyed on the file mtime, so changes will
 still be automatically detected.
 
     package MyApp::View::TT;
-    
+
     use strict;
     use warnings;
     use base 'Catalyst::View::TT';
-    
+
     __PACKAGE__->config(
         COMPILE_DIR => '/tmp/template_cache',
     );
-    
+
     1;
-    
+
 =head3 More Info
 
 See the documentation for each cache plugin for more details and other
@@ -2139,10 +2307,10 @@ alterations.
 
 =head2 Testing
 
-Catalyst provides a convenient way of testing your application during 
+Catalyst provides a convenient way of testing your application during
 development and before deployment in a real environment.
 
-C<Catalyst::Test> makes it possible to run the same tests both locally 
+C<Catalyst::Test> makes it possible to run the same tests both locally
 (without an external daemon) and against a remote server via HTTP.
 
 =head3 Tests
@@ -2164,7 +2332,7 @@ response.
 
 =item C<02pod.t>
 
-Verifies that all POD is free from errors. Only executed if the C<TEST_POD> 
+Verifies that all POD is free from errors. Only executed if the C<TEST_POD>
 environment variable is true.
 
 =item C<03podcoverage.t>
@@ -2206,18 +2374,18 @@ take three different arguments:
 
 =back
 
-C<request> returns an instance of C<HTTP::Response> and C<get> returns the 
+C<request> returns an instance of C<HTTP::Response> and C<get> returns the
 content (body) of the response.
 
 =head3 Running tests locally
 
     mundus:~/MyApp chansen$ CATALYST_DEBUG=0 TEST_POD=1 prove --lib lib/ t/
-    t/01app............ok                                                        
-    t/02pod............ok                                                        
-    t/03podcoverage....ok                                                        
+    t/01app............ok
+    t/02pod............ok
+    t/03podcoverage....ok
     All tests successful.
     Files=3, Tests=4,  2 wallclock secs ( 1.60 cusr +  0.36 csys =  1.96 CPU)
+
 C<CATALYST_DEBUG=0> ensures that debugging is off; if it's enabled you
 will see debug logs between tests.
 
@@ -2229,12 +2397,12 @@ find out more about it from the links below.
 =head3 Running tests remotely
 
     mundus:~/MyApp chansen$ CATALYST_SERVER=http://localhost:3000/ prove --lib lib/ t/01app.t
-    t/01app....ok                                                                
+    t/01app....ok
     All tests successful.
     Files=1, Tests=2,  0 wallclock secs ( 0.40 cusr +  0.01 csys =  0.41 CPU)
 
-C<CATALYST_SERVER=http://localhost:3000/> is the absolute deployment URI of 
-your application. In C<CGI> or C<FastCGI> it should be the host and path 
+C<CATALYST_SERVER=http://localhost:3000/> is the absolute deployment URI of
+your application. In C<CGI> or C<FastCGI> it should be the host and path
 to the script.
 
 =head3 C<Test::WWW::Mechanize> and Catalyst
@@ -2329,28 +2497,11 @@ L<http://search.cpan.org/perldoc?Catalyst::Plugin::Authorization::ACL>
 
 =head1 AUTHORS
 
-Sebastian Riedel C<sri@oook.de>
-
-Danijel Milicevic C<me@danijel.de>
-
-Viljo Marrandi C<vilts@yahoo.com>  
-
-Marcus Ramberg C<mramberg@cpan.org>
-
-Jesse Sheidlower C<jester@panix.com>
-
-Andy Grundman C<andy@hybridized.org> 
-
-Chisel Wright C<pause@herlpacker.co.uk>
-
-Will Hawes C<info@whawes.co.uk>
-
-Gavin Henry C<ghenry@perl.me.uk>
-
-Kieren Diment C<kd@totaldatasolution.com>
+Catalyst Contributors, see Catalyst.pm
 
 =head1 COPYRIGHT
 
-This document is free, you can redistribute it and/or modify it
-under the same terms as Perl itself.
+This library is free software. You can redistribute it and/or modify it under
+the same terms as Perl itself.
 
+=cut