[Rt-commit] r15880 - in rt/3.8/trunk: .

[falcone at bestpractical.com]

Author: falcone
Date: Tue Sep  9 17:00:32 2008
New Revision: 15880

Modified:
   rt/3.8/trunk/   (props changed)
   rt/3.8/trunk/lib/RT/Config.pm

Log:
 r39578 at ketch:  falcone | 2008-09-09 16:34:14 -0400
 * first pass at documenting the hash of config options


Modified: rt/3.8/trunk/lib/RT/Config.pm
==============================================================================
--- rt/3.8/trunk/lib/RT/Config.pm	(original)
+++ rt/3.8/trunk/lib/RT/Config.pm	Tue Sep  9 17:00:32 2008
@@ -97,6 +97,35 @@
 
 =cut
 
+=head2 %META
+
+Hash of Config options that may be user overridable
+or may require more logic than should live in RT_*Config.pm
+
+Keyed by config name, there are several properties that
+can be set for each config optin:
+
+ Section     - What header this option should be grouped
+               under on the user Settings page
+ Overridable - Can users change this option
+ Widget      - What kind of display widget should be user
+               to present this option to the user
+ WidgetArguments - An argument hash passed to the WIdget
+    Description - Friendly description to show the user
+    Values      - Arrayref of options (for select Widget)
+    ValuesLabel - Hashref, key is the Value from the Values
+                  list, value is a user friendly description
+                  of the value
+    Callback    - subref that receives no arguments.  It returns
+                  a hashref of items that are added to the rest
+                  of the WidgetArguments
+ PostLoadCheck - subref passed the RT::Config object and the current
+                 setting of the config option.  Can make further checks
+                 (such as seeing if a library is installed) and then change
+                 the setting of this or other options in the Config using 
+                 the RT::Config option.
+=cut
+
 our %META = (
     # General user overridable options
     WebDefaultStylesheet => {