Merge remote-tracking branch 'aerialls/master'

Resources/doc/tutorial/creating_your_first_admin_class/defining_admin_class.rst

@@ -3,7 +3,6 @@ Defining admin class
 
 
 The admin class contains all information required to generate the CRUD interface.
-
 Let's create the Post Admin class.
 
 
@@ -12,10 +11,9 @@ PostAdmin
 
 By convention Admin files are set under a Admin folder.
 
+First, you need to create an Admin/PostAdmin.php file
 
-- Create an Admin/PostAdmin.php file
-
-..
+.. code-block:: php
 
     namespace Sonata\NewsBundle\Admin;
 
@@ -29,9 +27,9 @@ By convention Admin files are set under a Admin folder.
 
     }
 
-- register the PostAdmin class inside the DIC
+Secondly, register the PostAdmin class inside the DIC in your config.xml file.
 
-..
+.. code-block:: xml
 
     <service id="sonata.news.admin.post" class="Sonata\NewsBundle\Admin\PostAdmin">
 
@@ -41,52 +39,65 @@ By convention Admin files are set under a Admin folder.
         <argument>SonataNewsBundle:PostAdmin</argument>
     </service>
 
+Or if you're using an YML configuration file,
 
-These is the minimal configuration required to display the entity inside the dashboard and
-interact with the CRUD interfance. However the interface will display too many fields as some
-of them are not meant to be displayed.
+.. code-block:: yml
 
-Tweak the PostAdmin class
--------------------------
+    services:
+       sonata.news.admin.post:
+          class: Sonata\NewsBundle\Admin\PostAdmin
+       tags:
+         - { name: sonata.admin, manager_type: orm, group: sonata_blog, label: post }
+       arguments: [Sonata\NewsBundle\Entity\Post, SonataNewsBundle:PostAdmin]
 
-Now, let's specify the differents fields we want to use:
- 
 
-..
+These is the minimal configuration required to display the entity inside the dashboard and
+interact with the CRUD interface. However, you need to create your admin Controller.
+The interface will display too many fields as some of them are not meant to be displayed.
+We'll see how we can specify the differents fields we want to use
 
-    protected $list = array(
-        'title' => array('identifier' => true),
-        'slug',
-        'enabled',
-        'comments_enabled',
-    );
+Tweak the PostAdmin class
+-------------------------
 
-    protected $form = array(
-        'enabled',
-        'title',
-        'abstract',
-        'content',
-        'tags' => array('form_field_options' => array('expanded' => true)),
-        'comments_enabled',
-        'comments_default_status'
-    );
+You can specify which field you want displayed for each action (list, form and filter)
 
-    protected $filter = array(
-        'title',
-        'enabled',
-        'tags' => array('filter_field_options' => array('expanded' => true, 'multiple' => true))
-    );
+.. code-block:: php
 
+    class PostAdmin extends Admin
+    {
+       protected $list = array(
+           'title' => array('identifier' => true),
+           'slug',
+           'enabled',
+           'comments_enabled',
+       );
+
+       protected $form = array(
+           'enabled',
+           'title',
+           'abstract',
+           'content',
+           'tags' => array('form_field_options' => array('expanded' => true)),
+           'comments_enabled',
+           'comments_default_status'
+       );
+
+       protected $filter = array(
+           'title',
+           'enabled',
+           'tags' => array('filter_field_options' => array('expanded' => true, 'multiple' => true))
+       );
+     }
 
 Now the different CRUD interfaces will look nicer!
 
 
 So same goes for the TagAdmin and CommentAdmin class.
 
-TagAdmin
+Tweak the TagAdmin class
 --------
 
-..
+.. code-block:: php
 
     namespace Sonata\NewsBundle\Admin;
 
@@ -107,10 +118,10 @@ TagAdmin
         );
     }
 
-CommentAdmin
+Tweak the CommentAdmin class
 ------------
 
-..
+.. code-block:: php
 
     namespace Sonata\NewsBundle\Admin;
 
@@ -135,4 +146,4 @@ CommentAdmin
             'post',
             'status' => array('type' => 'choice'),
         );
-    }
+    }

Resources/doc/tutorial/creating_your_first_admin_class/introduction.rst

@@ -7,7 +7,7 @@ a blog application.
 
 The tutorial will explains how to define:
 
-* entities
-* routing
+* Entities
+* The routing
 * CRUD controller
 * The ``Admin`` class