changeset 3744:1eabe89b773b

add longer group help text
author Johannes Berg <johannes AT sipsolutions DOT net>
date Sat, 21 Jun 2008 23:58:54 +0200
parents 49144c908411
children 08dd5b1a1f1c
files MoinMoin/config/multiconfig.py MoinMoin/macro/WikiConfigHelp.py
diffstat 2 files changed, 19 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/MoinMoin/config/multiconfig.py	Sat Jun 21 23:53:13 2008 +0200
+++ b/MoinMoin/config/multiconfig.py	Sat Jun 21 23:58:54 2008 +0200
@@ -623,7 +623,7 @@
 
 
 options_no_group_name = {
-  'various': ('Various', (
+  'various': ('Various', None, (
     ('DesktopEdition',
      False,
      'True gives all local users special powers - ONLY use for MMDE style usage!'),
@@ -952,7 +952,7 @@
 }
 
 options = {
-    'acl': ('Access control lists', (
+    'acl': ('Access control lists', None, (
       ('hierarchic', False, 'True to use hierarchical ACLs'),
       ('rights_default', u"Trusted:read,write,delete,revert Known:read,write,delete,revert All:read,write", None),
       ('rights_before', u"", None),
@@ -960,14 +960,14 @@
       ('rights_valid', ['read', 'write', 'delete', 'revert', 'admin'], None),
     )),
 
-    'xapian': ('Xapian search', (
+    'xapian': ('Xapian search', None, (
       ('search', False, None),
       ('index_dir', None, None),
       ('stemming', False, None),
       ('index_history', False, None),
     )),
 
-    'user': ('Users / User settings', (
+    'user': ('Users / User settings', None, (
       ('autocreate', False, None),
       ('email_unique', True, None),
       ('jid_unique', True, None),
@@ -1048,7 +1048,7 @@
        None),
     )),
 
-    'backup': ('Backup', (
+    'backup': ('Backup', None, (
       ('compression', 'gz', None),
       ('users', [], None),
       ('include', [], None),
@@ -1064,7 +1064,9 @@
       ('restore_target_dir', '/tmp', None),
     )),
 
-    'openid_server': ('OpenID Server', (
+    'openid_server': ('OpenID Server',
+        'These settings control the built-in OpenID Identity Provider (server).',
+    (
       ('enabled', False, None),
       ('restricted_users_group', None, None),
       ('enable_user', False, None),
@@ -1073,7 +1075,7 @@
 
 def _add_options_to_defconfig(opts, addgroup=True):
     for groupname in opts:
-        group_doc, group_opts = opts[groupname]
+        group_short, group_doc, group_opts = opts[groupname]
         for name, default, doc in group_opts:
             if addgroup:
                 name = groupname + '_' + name
--- a/MoinMoin/macro/WikiConfigHelp.py	Sat Jun 21 23:53:13 2008 +0200
+++ b/MoinMoin/macro/WikiConfigHelp.py	Sat Jun 21 23:58:54 2008 +0200
@@ -21,12 +21,20 @@
     groups.sort()
 
     for groupname, addgroup, optsdict in groups:
-        desc, opts = optsdict[groupname]
+        heading, desc, opts = optsdict[groupname]
         ret.extend([
             f.heading(1, 1),
             ## XXX: translate description?
-            f.text(desc),
+            f.text(heading),
             f.heading(0, 1),
+        ])
+        if desc:
+            ret.extend([
+                f.paragraph(1),
+                f.text(desc),
+                f.paragraph(0)
+            ])
+        ret.extend([
             f.table(1),
             f.table_row(1),
             f.table_cell(1), f.strong(1), f.text(_('Variable name')), f.strong(0), f.table_cell(0),