accidentally committed view_options with /home directory

[maypole.git] / lib / Maypole / Config.pm

diff --git a/lib/Maypole/Config.pm b/lib/Maypole/Config.pm
index 9d0c900f6544a625d4ecb2905c11e02d1db300f4..024b78cf727899949d05dc1d5f7ee8beede96bd9 100644 (file)
--- a/lib/Maypole/Config.pm
+++ b/lib/Maypole/Config.pm
@@ -5,14 +5,16 @@ use attributes ();
 use strict;
 use warnings;
 
+our $VERSION = "1." . sprintf "%04d", q$Rev$ =~ /: (\d+)/;
+
 # Public accessors.
 __PACKAGE__->mk_accessors(
-    qw( view uri_base template_root model loader display_tables ok_tables
-      rows_per_page dsn user pass opts application_name)
+     qw( view view_options uri_base template_root model loader display_tables
+         ok_tables 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));
 
 1;
 
@@ -40,10 +42,6 @@ This is the number of rows your application should display per page.
 
 Contains a list of all tables, if supported by model.
 
-=head3 table_to_class
-
-A hash containing a table to class mapping, if supported by model.
-
 =head3 template_root
 
 This is where your application can find its templates.
@@ -59,6 +57,11 @@ makes URLs.
 The name of the view class for your Maypole Application. Defaults to
 "Maypole::View::TT".
 
+=head3 view_options
+
+A hash of configuration options for the view class. Consult the documentation
+for your chosen view class for information on available configuration options.
+
 =head2 Model-Related
 
 =head3 classes
@@ -69,8 +72,8 @@ 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.
+This is a list of the tables that are public to your Maypole 
+application. Defaults to all the tables in the database.
 
 =head3 dsn
 
@@ -89,7 +92,8 @@ The name of the model class for your Maypole Application. Defaults to
 
 =head3 ok_tables
 
-These are the tables that Maypole should care about
+This is a hash of the public tables. It is populated automatically by 
+Maypole from the list in display_tables and should not be changed.
 
 =head3 pass
 
@@ -103,6 +107,16 @@ Other options to the DBI connect call.
 
 Username to log into the database with.
 
+=head2 Adding additional configuration data
+
+If your modules need to store additional configuration data for their 
+own use or to make available to templates, add a line like this to your 
+module:
+
+   Maypole::Config->mk_accessors(qw(variable or variables));
+
+Care is needed to avoid conflicting variable names.
+
 =head1 SEE ALSO
 
 L<Maypole>