Merge pull request #1027 from TomAdam/pr-form-group-description

Add form group description

Form/FormMapper.php

@@ -12,7 +12,6 @@ namespace Sonata\AdminBundle\Form;
 
 use Sonata\AdminBundle\Builder\FormContractorInterface;
 use Sonata\AdminBundle\Admin\AdminInterface;
-use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
 use Symfony\Component\Form\FormBuilder;
 
 /**
@@ -55,8 +54,9 @@ class FormMapper
         }
 
         $formGroups[$name] = array_merge(array(
-            'collapsed' => false,
-            'fields'    => array()
+            'collapsed'   => false,
+            'fields'      => array(),
+            'description' => false
         ), $formGroups[$name], $options);
 
         $this->admin->setFormGroups($formGroups);

Resources/doc/reference/form_help_message.rst

@@ -1,13 +1,13 @@
-Form Help Messages
-==================
+Form Help Messages and Descriptions
+===================================
 
 Help Messages
 -------------
 
-Help messages are short notes that are rendered together with form fields. They are generally used to show additional information so the user can complete the form element faster and more accurately.
+Help messages are short notes that are rendered together with form fields. They are generally used to show additional information so the user can complete the form element faster and more accurately. The text is not escaped, so HTML can be used.
 
 Example
--------
+^^^^^^^
 
 .. code-block:: php
 
@@ -25,7 +25,7 @@ Example
     }
 
 Alternative Way To Define Help Messages
----------------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: php
 
@@ -46,3 +46,25 @@ Alternative Way To Define Help Messages
         }
     }
 
+Form Group Descriptions
+-----------------------
+
+A form group description is a block of text rendered below the group title. These can be used to describe a section of a form. The text is not escaped, so HTML can be used.
+
+Example
+^^^^^^^
+
+.. code-block:: php
+
+    <?php
+    class ExampleAdmin.php
+    {
+        protected function configureFormFields(FormMapper $formMapper)
+        {
+            $formMapper
+                ->with('General', array('description' => 'This section contains general settings for the web page'))
+                    ->add('title', null, array('help'=>'Set the title of a web page'))
+                    ->add('keywords', null, array('help'=>'Set the keywords of a web page'))
+                ->end();
+        }
+    }

Resources/public/base.js

@@ -81,8 +81,8 @@ var Admin = {
      * @param subject
      */
     add_collapsed_toggle: function(subject) {
-        jQuery('fieldset.sonata-ba-fielset-collapsed').has('.error').addClass('sonata-ba-collapsed-fields-close');
-        jQuery('fieldset.sonata-ba-fielset-collapsed div.sonata-ba-collapsed-fields').not(':has(.error)').hide();
+        jQuery('fieldset.sonata-ba-fieldset-collapsed').has('.error').addClass('sonata-ba-collapsed-fields-close');
+        jQuery('fieldset.sonata-ba-fieldset-collapsed div.sonata-ba-collapsed-fields').not(':has(.error)').hide();
         jQuery('fieldset legend a.sonata-ba-collapsed', subject).live('click', function(event) {
             event.preventDefault();
 

Resources/public/css/layout.css

@@ -278,11 +278,19 @@ legend + .sonata-ba-collapsed-fields {
     -webkit-margin-top-collapse: separate;
 }
 
+legend.sonata-ba-fieldset-collapsed-description + .sonata-ba-collapsed-fields {
+    margin-top: 0;
+}
+
+.sonata-ba-collapsed-fields > p {
+    margin-bottom: 18px;
+}
+
 .bordered-table tbody.ui-sortable tr {
     cursor: move;
 }
 
-.sonata-ba-fielset-collapsed legend:before {
+.sonata-ba-fieldset-collapsed legend:before {
     content: '+ ';
 }
 
@@ -297,4 +305,4 @@ legend + .sonata-ba-collapsed-fields {
 
 .sonata-bc .pagination {
     margin: 0px;
-}
+}

Resources/views/CRUD/base_edit_form.html.twig

@@ -16,8 +16,8 @@
             {% block sonata_pre_fieldsets %}{% endblock %}
 
             {% for name, form_group in admin.formgroups %}
-                <fieldset {% if form_group.collapsed %}class="sonata-ba-fielset-collapsed"{% endif %}>
-                    <legend>
+                <fieldset {% if form_group.collapsed %}class="sonata-ba-fieldset-collapsed"{% endif %}>
+                    <legend{% if form_group.description != false %} class="sonata-ba-fieldset-collapsed-description"{% endif %}>
                         {% if form_group.collapsed %}
                             <a href="" class="sonata-ba-collapsed" title="{{ 'link_expand'|trans({}, 'SonataAdminBundle') }}">{{ name|trans({}, admin.translationdomain) }}</a>
                         {% else %}
@@ -26,6 +26,10 @@
                     </legend>
 
                     <div class="sonata-ba-collapsed-fields">
+                        {% if form_group.description != false %}
+                            <p>{{ form_group.description|raw }}</p>
+                        {% endif %}
+
                         {% for field_name in form_group.fields %}
                             {% if admin.formfielddescriptions[field_name] is defined %}
                                 {{ form_row(form[field_name])}}
@@ -70,4 +74,4 @@
         </form>
     {% endif%}
 
-{% endblock %}
+{% endblock %}