]> git.decadent.org.uk Git - maypole.git/blobdiff - lib/Maypole/Config.pm
New Maypole::Config documentation
[maypole.git] / lib / Maypole / Config.pm
index 21b848f4bc9dac3dcc8d90522bac8f6f54f8e570..9d0c900f6544a625d4ecb2905c11e02d1db300f4 100644 (file)
@@ -8,14 +8,11 @@ use warnings;
 # Public accessors.
 __PACKAGE__->mk_accessors(
     qw( view uri_base template_root model loader display_tables ok_tables
-      rows_per_page dsn user pass opts)
+      rows_per_page dsn user pass opts application_name)
 );
 
 # Should only be modified by model.
-__PACKAGE__->mk_ro_accessors(
-    qw( classes tables table_to_class
-      )
-);
+__PACKAGE__->mk_ro_accessors(qw( classes tables table_to_class));
 
 1;
 
@@ -31,52 +28,68 @@ This class stores all configuration data for your Maypole application.
 
 =head2 View related
 
-=head3 view
-
-The view class for your Maypole Application. Defaults to "Maypole::View::TT"
-
-=head3 uri_base 
+=head3 application_name
 
-This is the uri base that should be appended to your application when maypole 
-makes urls.
+This should be a string containing your application's name.
 
-=head3 template_root
+=head3 rows_per_page
 
-This is where your application can find it's templates.
+This is the number of rows your application should display per page.
 
-=head3 rows_per_page
+=head3 tables
 
-This is the  number of rows your application should display per page.
+Contains a list of all tables, if supported by model.
 
-=head2 Model-Related
+=head3 table_to_class
 
-=head3 display_tables 
+A hash containing a table to class mapping, if supported by model.
 
-These are the tables that are public to your maypole application
+=head3 template_root
 
-=head3 ok_tables
+This is where your application can find its templates.
 
-These are the tables that maypole should care about
+=head3 uri_base
 
-=head3 model
+This is the URI base that should be prepended to your application when
+Maypole
+makes URLs.
 
-The model class for your Maypole Application. Defaults to "Maypole::View::CDBI"
+=head3 view
 
-=head3 loader
+The name of the view class for your Maypole Application. Defaults to
+"Maypole::View::TT".
 
-This is the loader object. It's set up by the CDBI model if it's not initialized before setup.
+=head2 Model-Related
 
 =head3 classes
 
-This config variable contains a list of your view classes. This set up by the
+This config variable contains a list of your view classes. This is set
+up by the
 model class, and should not be changed in the view or the config.
 
+=head3 display_tables
+
+These are the tables that are public to your Maypole application.
+Defaults to all the tables in the database.
+
 =head3 dsn
+
 The DSN to your database. Follows standard DBD syntax.
 
-=head3 user
+=head3 loader
 
-Username to log into the database with
+This is the loader object (n.b. an instance, not a class name). It's set
+up by the CDBI model to an instance of "Class::DBI::Loader" if it's not
+initialized before calling setup().
+
+=head3 model
+
+The name of the model class for your Maypole Application. Defaults to
+"Maypole::Model::CDBI".
+
+=head3 ok_tables
+
+These are the tables that Maypole should care about
 
 =head3 pass
 
@@ -84,17 +97,21 @@ Password for database user.
 
 =head3 opts
 
-Other options to the dbi connect call.
+Other options to the DBI connect call.
+
+=head3 user
+
+Username to log into the database with.
 
 =head1 SEE ALSO
 
 L<Maypole>
 
-=head1 MAINTAINER
+=head1 AUTHOR
 
-Sebastian Riedel, c<sri@oook.de>
+Sebastian Riedel, C<sri@oook.de>
 
-=head1 AUTHOR
+=head1 AUTHOR EMERITUS
 
 Simon Cozens, C<simon@cpan.org>