Merge pull request #715 from symfony-cmf/route_basepaths

Document route basepaths

Author: dbu

bundles/routing/configuration.rst

@@ -381,14 +381,18 @@ manager_name
 ``route_basepaths``
 *******************
 
-**type**: ``array`` **default**: ``array('/cms/routes')``
+.. versionadded:: 1.3
+    The ``route_basepaths`` setting was introduced in version 1.3. Prior to
+    1.3, you could only configure one basepath using ``route_basepath``.
+
+**type**: ``string`` | ``array`` **default**: ``/cms/routes``
 
-The basepaths where to look for routes in the PHPCR tree.
+A set of paths where routes are located in the PHPCR tree.
 
 If the :doc:`CoreBundle <../core/introduction>` is registered, this will
 default to ``%cmf_core.persistence.phpcr.basepath%/routes``. If the
 :doc:`SimpleCmsBundle <../simple_cms/introduction>` is registered as well,
-this will additionally default to ``%cmf_core.persistence.phpcr.basepath%/simple``.
+the SimpleCmsBundle basepath will be added as an additional route basepath.
 
 ``content_basepath``
 ********************
@@ -404,7 +408,7 @@ If the :doc:`CoreBundle <../core/introduction>` is registered, this will default
 ``admin_basepath``
 ******************
 
-**type**: ``string`` **default**: first value of route_basepaths
+**type**: ``string`` **default**: first value of ``route_basepaths``
 
 The path at which to create routes with Sonata admin. There can be additional
 route basepaths, but you will need your own tools to edit those.

quick_tour/the_router.rst

@@ -96,7 +96,10 @@ new routes in ``/cms/routes``:
             dynamic:
                 persistence:
                     phpcr:
-                        route_basepath: /cms/routes
+                        route_basepaths: /cms/routes
+                    # /cms/routes is the default base path, the above code is
+                    # equivalent to:
+                    # phpcr: true
 
     .. code-block:: xml
 
@@ -116,7 +119,13 @@ new routes in ``/cms/routes``:
 
                 <dynamic>
                     <persistence>
-                        <phpcr route-basepath="/cms/routes" />
+                        <phpcr>
+                            <route-basepath>/cms/routes</route-basepath>
+                        </phpcr>
+                        <!-- /cms/routes is the default base path, the above
+                             code is equivalent to:
+                             <phpcr />
+                        --->
                     </persistence>
                 </dynamic>
             </config>
@@ -138,8 +147,12 @@ new routes in ``/cms/routes``:
             'dynamic' => array(
                 'persistence' => array(
                     'phpcr' => array(
-                        'route_basepath' => '/cms/routes',
+                        'route_basepaths' => '/cms/routes',
                     ),
+                    /* /cms/routes is the default base path, the above code is
+                       equivalent to:
+                       'phpcr' => true,
+                    */
                 ),
             ),
         ));

tutorial/auto-routing.rst

@@ -72,8 +72,7 @@ Add the following to your application configuration:
             dynamic:
                 enabled: true
                 persistence:
-                    phpcr:
-                        route_basepath: /cms/routes
+                    phpcr: true
 
     .. code-block:: xml
 
@@ -86,7 +85,7 @@ Add the following to your application configuration:
                 </chain>
                 <dynamic>
                     <persistence>
-                        <phpcr route-basepath="/cms/routes" />
+                        <phpcr />
                     </persistence>
                 </dynamic>
             </config>
@@ -98,10 +97,7 @@ Add the following to your application configuration:
         $container->loadFromExtension('cmf_routing', array(
             'dynamic' => array(
                 'persistence' => array(
-                    'phpcr' => array(
-                        'enabled' => true,
-                        'route_basepath' => '/cms/routes',
-                    ),
+                    'phpcr' => true,
                 ),
             ),
         ));