From 8bbd2b435a993ce72871cf210383faa519d9573f Mon Sep 17 00:00:00 2001 From: Sebastian Riedel Date: Thu, 28 Oct 2004 12:57:54 +0000 Subject: [PATCH] New Maypole::Config documentation git-svn-id: http://svn.maypole.perl.org/Maypole/trunk@276 48953598-375a-da11-a14b-00016c27c3ee --- Changes | 1 + lib/Maypole/Config.pm | 68 ++++++++++++++++++++++++------------------- 2 files changed, 39 insertions(+), 30 deletions(-) diff --git a/Changes b/Changes index 27cc5d8..0bc595e 100644 --- a/Changes +++ b/Changes @@ -3,6 +3,7 @@ Revision history for Perl extension Maypole 2.04 Tue Oct 27 14:00:00 2004 - Fixed Apache::MVC version (Randal Schwartz) - fixed template_args (Dave Howorth) + - New Maypole::Config documentation (Dave Howorth) 2.03 Tue Oct 26 13:00:00 2004 - increased version number of Apache::MVC diff --git a/lib/Maypole/Config.pm b/lib/Maypole/Config.pm index c4843b7..9d0c900 100644 --- a/lib/Maypole/Config.pm +++ b/lib/Maypole/Config.pm @@ -30,16 +30,11 @@ This class stores all configuration data for your Maypole application. =head3 application_name -This should be a string containing you applications name. +This should be a string containing your application's name. -=head3 view - -The view class for your Maypole Application. Defaults to "Maypole::View::TT" - -=head3 uri_base +=head3 rows_per_page -This is the uri base that should be appended to your application when maypole -makes urls. +This is the number of rows your application should display per page. =head3 tables @@ -51,41 +46,50 @@ A hash containing a table to class mapping, if supported by model. =head3 template_root -This is where your application can find it's templates. +This is where your application can find its templates. -=head3 rows_per_page +=head3 uri_base + +This is the URI base that should be prepended to your application when +Maypole +makes URLs. + +=head3 view -This is the number of rows your application should display per page. +The name of the view class for your Maypole Application. Defaults to +"Maypole::View::TT". =head2 Model-Related -=head3 display_tables +=head3 classes -These are the tables that are public to your maypole application +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 ok_tables +=head3 display_tables -These are the tables that maypole should care about +These are the tables that are public to your Maypole application. +Defaults to all the tables in the database. -=head3 model +=head3 dsn -The model class for your Maypole Application. Defaults to "Maypole::View::CDBI" +The DSN to your database. Follows standard DBD syntax. =head3 loader -This is the loader object. It's set up by the CDBI model if it's not initialized before setup. +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 classes +=head3 model -This config variable contains a list of your view classes. This set up by the -model class, and should not be changed in the view or the config. +The name of the model class for your Maypole Application. Defaults to +"Maypole::Model::CDBI". -=head3 dsn -The DSN to your database. Follows standard DBD syntax. - -=head3 user +=head3 ok_tables -Username to log into the database with +These are the tables that Maypole should care about =head3 pass @@ -93,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 -=head1 MAINTAINER +=head1 AUTHOR -Sebastian Riedel, c +Sebastian Riedel, C -=head1 AUTHOR +=head1 AUTHOR EMERITUS Simon Cozens, C -- 2.39.5