[Checkins] SVN: z3c.preference/trunk/ - Descriptions of preference groups are now rendered in the ``group-header``

[Michael Howitz]

Log message for revision 125218:
  - Descriptions of preference groups are now rendered in the ``group-header``
    slot of the form above the error messages for the group.
  
  - Fixed description of version `0.3`, it actually added descriptions for
    preference categories, not preference groups.
  
  

Changed:
  U   z3c.preference/trunk/CHANGES.txt
  U   z3c.preference/trunk/src/z3c/preference/browser.py
  U   z3c.preference/trunk/src/z3c/preference/categories.txt
  U   z3c.preference/trunk/src/z3c/preference/configure.zcml
  U   z3c.preference/trunk/src/z3c/preference/form.pt
  U   z3c.preference/trunk/src/z3c/preference/tests.py

-=-
Modified: z3c.preference/trunk/CHANGES.txt
===================================================================
--- z3c.preference/trunk/CHANGES.txt	2012-04-20 19:26:04 UTC (rev 125217)
+++ z3c.preference/trunk/CHANGES.txt	2012-04-20 19:40:45 UTC (rev 125218)
@@ -5,14 +5,18 @@
 0.4 (unreleased)
 ----------------
 
-- Nothing changed yet.
+- Descriptions of preference groups are now rendered in the ``group-header``
+  slot of the form above the error messages for the group.
 
+- Fixed description of version `0.3`, it actually added descriptions for
+  preference categories, not preference groups.
 
+
 0.3 (2012-03-15)
 ----------------
 
-- Descriptions of preference groups are now rendered in the ``extra-info``
-  slot of the form.
+- Descriptions of preference categories are now rendered in the
+  ``extra-info`` slot of the form.
 
 
 0.2 (2012-02-23)

Modified: z3c.preference/trunk/src/z3c/preference/browser.py
===================================================================
--- z3c.preference/trunk/src/z3c/preference/browser.py	2012-04-20 19:26:04 UTC (rev 125217)
+++ z3c.preference/trunk/src/z3c/preference/browser.py	2012-04-20 19:40:45 UTC (rev 125218)
@@ -43,6 +43,7 @@
     def __init__(self, *args, **kw):
         super(PreferenceGroup, self).__init__(*args, **kw)
         self.fields = to_fields(self.context)
+        self.description = self.context.__description__
         self.label = self.context.__title__
 
 

Modified: z3c.preference/trunk/src/z3c/preference/categories.txt
===================================================================
--- z3c.preference/trunk/src/z3c/preference/categories.txt	2012-04-20 19:26:04 UTC (rev 125217)
+++ z3c.preference/trunk/src/z3c/preference/categories.txt	2012-04-20 19:40:45 UTC (rev 125218)
@@ -60,6 +60,7 @@
   ...       <preferenceGroup
   ...           id="app"
   ...           title="General Settings"
+  ...           description="Settings for the whole app"
   ...           schema="z3c.preference.categories.IGeneralSettings"
   ...           category="true"
   ...           />
@@ -67,6 +68,7 @@
   ...       <preferenceGroup
   ...           id="app.rss"
   ...           title="RSS Settings"
+  ...           description="Settings for the RSS feeds"
   ...           schema="z3c.preference.categories.IRSSSettings"
   ...           category="false"
   ...           />
@@ -88,7 +90,17 @@
 >>> browser = Browser()
 >>> browser.addHeader('Authorization', 'Basic mgr:mgrpw')
 
+The form displays the titles and descriptions of the categories:
 
+>>> browser.open('http://localhost/++preferences++/app')
+>>> print browser.contents
+<!DOCTYPE ...
+...General Settings...
+...Settings for the whole app...
+...RSS Settings...
+...Settings for the RSS feeds...
+...Search Settings...
+
 Editing preference group trees using browser
 --------------------------------------------
 

Modified: z3c.preference/trunk/src/z3c/preference/configure.zcml
===================================================================
--- z3c.preference/trunk/src/z3c/preference/configure.zcml	2012-04-20 19:26:04 UTC (rev 125217)
+++ z3c.preference/trunk/src/z3c/preference/configure.zcml	2012-04-20 19:40:45 UTC (rev 125218)
@@ -33,6 +33,12 @@
       template="form.pt"
       layer=".interfaces.IPreferenceLayer" />
 
+  <z3c:macro
+      name="z3c-preferences-group-description"
+      macro="group-description"
+      template="form.pt"
+      layer=".interfaces.IPreferenceLayer" />
+
   <browser:defaultView
       layer=".interfaces.IPreferenceLayer"
       name="index.html" />

Modified: z3c.preference/trunk/src/z3c/preference/form.pt
===================================================================
--- z3c.preference/trunk/src/z3c/preference/form.pt	2012-04-20 19:26:04 UTC (rev 125217)
+++ z3c.preference/trunk/src/z3c/preference/form.pt	2012-04-20 19:40:45 UTC (rev 125218)
@@ -1,8 +1,18 @@
 <metal:form use-macro="macro:form">
   <metal:description fill-slot="extra-info">
       <metal:macro define-macro="description">
+        <p tal:condition="view/description"
+           tal:content="view/description" />
+      </metal:macro>
+  </metal:description>
+  <metal:block fill-slot="group-header">
+    <metal:macro define-macro="group-description">
       <p tal:condition="view/description"
          tal:content="view/description" />
-      </metal:macro>
-  </metal:description>
+      <div class="status"
+           tal:condition="view/widgets/errors">
+        <div metal:use-macro="macro:form-errors" />
+      </div>
+    </metal:macro>
+  </metal:block>
 </metal:form>
\ No newline at end of file

Modified: z3c.preference/trunk/src/z3c/preference/tests.py
===================================================================
--- z3c.preference/trunk/src/z3c/preference/tests.py	2012-04-20 19:26:04 UTC (rev 125217)
+++ z3c.preference/trunk/src/z3c/preference/tests.py	2012-04-20 19:40:45 UTC (rev 125218)
@@ -31,6 +31,8 @@
     suite = doctest.DocFileSuite(
         'README.txt',
         'categories.txt',
-        setUp=setUp, tearDown=tearDown)
+        setUp=setUp,
+        tearDown=tearDown,
+        optionflags=doctest.NORMALIZE_WHITESPACE|doctest.ELLIPSIS)
     suite.layer = z3c.preference.testing.Layer
     return suite