changeset 3817:98660492e634

document new multiconfig option structure
author Johannes Berg <johannes AT sipsolutions DOT net>
date Thu, 03 Jul 2008 20:33:17 +0200
parents 6e7ab559c67d
children fe9305d5c7cf
files MoinMoin/config/multiconfig.py
diffstat 1 files changed, 28 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/MoinMoin/config/multiconfig.py	Thu Jul 03 15:26:24 2008 +0200
+++ b/MoinMoin/config/multiconfig.py	Thu Jul 03 20:33:17 2008 +0200
@@ -640,6 +640,11 @@
         self.value = eval(exprstr)
 
 
+#
+# Options that are not prefixed automatically with their
+# group name, see below (at the options dict) for more
+# information on the layout of this structure.
+#
 options_no_group_name = {
   # ==========================================================================
   'session': ('Session settings', "Session-related settings, see HelpOnSessions.", (
@@ -981,6 +986,29 @@
   )),
 }
 
+#
+# The 'options' dict carries default MoinMoin options. The dict is a
+# group name to tuple mapping.
+# Each group tuple consists of the following items:
+#   group section heading, group help text, option list
+#
+# where each 'option list' is a tuple or list of option tuples
+#
+# each option tuple consists of
+#   option name, default value, help text
+#
+# All the help texts will be displayed by the WikiConfigHelp() macro.
+#
+# Unlike the options_no_group_name dict, option names in this dict
+# are automatically prefixed with "group name '_'" (i.e. the name of
+# the group they are in and an underscore), e.g. the 'hierarchic'
+# below creates an option called "acl_hierarchic".
+#
+# If you need to add a complex default expression that results in an
+# object and should not be shown in the __repr__ form in WikiConfigHelp(),
+# you can use the DefaultExpression class, see 'auth' above for example.
+#
+#
 options = {
     'acl': ('Access control lists', None, (
       ('hierarchic', False, 'True to use hierarchical ACLs'),