Merge pull request #834 from symfony-cmf/2.0

2.0

Author: dbu

_images/quick_tour/3rd-party-bundles-homepage.png

@@ -185,7 +185,7 @@ After this, you have to create getters and setters for the properties.
 
     You may want to implement ``Doctrine\ODM\PHPCR\HierarchyInterface``
     which makes it for example possible to leverage the
-    :ref:`Sonata Admin Child Extension <bundle-core-child-admin-extension>`.
+    :doc:`Sonata Admin Child Extension <../bundles/sonata_phpcr_admin_integration/core>`.
 
 .. seealso::
 

_images/quick_tour/3rd-party-bundles-sonata-admin.png

@@ -320,10 +320,8 @@ default locale, for example ``/de/admin/dashboard``. When clicking on the
 language switcher, the page reloads and displays the correct content for the
 requested language.
 
-If your documents implement the TranslatableInterface, you can
-:ref:`configure the translatable admin extension <bundle-core-translatable-admin-extension>`
-to get a language choice field to let the administrator
-choose in which language to store the content.
+If your documents implement the TranslatableInterface, use the
+SonataTranslationBundle_ to enable multi-language editing in the admin backend.
 
 Frontend Editing and multi-language
 -----------------------------------
@@ -348,3 +346,4 @@ save the edited document in the same language as it was loaded.
 .. _`cmf-sandbox config.yml file`: https://github.com/symfony-cmf/cmf-sandbox/blob/master/app/config/config.yml
 .. _`PHPCR-ODM documentation on multi-language`: http://docs.doctrine-project.org/projects/doctrine-phpcr-odm/en/latest/reference/multilang.html
 .. _`issue`: https://github.com/symfony-cmf/create-bundle/issues/39
+.. _SonataTranslationBundle: https://packagist.org/packages/sonata-project/translation-bundle

_images/quick_tour/big-picture-createjs-bar.png

@@ -519,8 +519,8 @@ handle ``StaticContent`` as :ref:`explained above <start-routing-getting-control
 
 The PHPCR-ODM routes support more things, for example route parameters,
 requirements and defaults. This is explained in the
-:ref:`route document section in the RoutingBundle documentation <bundle-routing-document>`.
-You can also find :ref:`route entity documentation and Doctrine ORM integration <bundle-routing-entity>`.
+:ref:`route document section in the RoutingBundle documentation <bundles-routing-document>`.
+You can also find :ref:`route entity documentation and Doctrine ORM integration <bundles-routing-entity>`.
 
 Further Notes
 -------------

_images/quick_tour/big-picture-edit-page.png

@@ -0,0 +1,15 @@
+``enabled``
+***********
+
+**type**: ``bool`` **default**: ``false``
+
+If ``true``, the admin classes and extensions of this package are loaded and
+available for Sonata Admin.
+
+.. tip::
+
+    If you do not see this admin on the Sonata dashboard, you need to configure
+    the dashboard to show the admin service in question. Read more about this
+    in `the Sonata Admin documentation`_.
+
+.. _the Sonata Admin documentation: https://sonata-project.org/bundles/admin/3-x/doc/reference/dashboard.html

_images/quick_tour/big-picture-new-page.png

@@ -0,0 +1,4 @@
+The name of the form group to use in the admin extension.
+
+The caption for the group is determined by translating the group name. If you
+change the group, be sure to also define a translation for it.

_images/quick_tour/the-model-new-page.png

@@ -0,0 +1,4 @@
+The name of the form tab to use in the admin extension.
+
+The caption for the tab is determined by translating the tab name. If you
+change the tab name, be sure to also define a translation for it.

_images/quick_tour/the-router-new-page.png

@@ -0,0 +1,12 @@
+.. note::
+
+    To focus our efforts onto a manageable number of packages, this package is
+    currently *not* maintained. Security fixes and submitted bug fixes will
+    still be released, but no new features should be expected. This bundle
+    might have outdated documentation, there is no support from the CMF team
+    and you should not expect bugs to be fixed.
+
+    If you want to help co-maintaining this package, tell us in a GitHub issue
+    or in #symfony_cmf of the `Symfony devs slack`_.
+
+.. _`Symfony devs slack`: https://slackinvite.me/to/symfony-devs

big-picture-home.png

@@ -1,11 +1,11 @@
 Cache
 =====
 
-The Symfony2 CMF BlockBundle integrates with the `SonataCacheBundle`_ to
+The CmfBlockBundle integrates with the `SonataCacheBundle`_ to
 provide several caching solutions. Have a look at the available adapters in the
 `SonataCacheBundle`_ to see all options.
 
-The Symfony2 CMF BlockBundle additionally provides its own adapters for:
+The CmfBlockBundle additionally provides its own adapters for:
 
 * `ESI`_ (service: ``cmf.block.cache.varnish``)
 * `SSI`_ (service: ``cmf.block.cache.ssi``)
@@ -15,7 +15,7 @@ The Symfony2 CMF BlockBundle additionally provides its own adapters for:
 .. note::
 
   It is advised to store all settings in the block document when using cache.
-  See also :ref:`bundle-block-cache-rendering`.
+  See also :ref:`bundles-block-cache-rendering`.
 
 Dependencies
 ------------
@@ -119,7 +119,7 @@ CmfBlockBundle and the SonataBlockBundle:
                     ),
                 ),
                 'blocks_by_class' => array(
-                    'Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\RssBlock' => array(
+                    Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\RssBlock::class => array(
                             'cache' => 'symfony_cmf.block.cache.js_async',
                         ),
                     ),
@@ -133,8 +133,7 @@ When a block having a cache configured is rendered, the following process
 is triggered:
 
 * The document is loaded based on the name;
-* If caching is configured, the cache is checked and content is returned if
-  found.
+* The cache is checked and content is returned if found.
 
   * Cache keys are computed using:
 
@@ -165,7 +164,7 @@ If the cache is checked and the cache adapter returned that no cache was found,
 the workflow proceeds like this:
 
 * The block service is asked to render the block
-  :ref:`as usual <bundle-block-execute>`;
+  :ref:`as usual <bundles-block-execute>`;
 * If the ``Response`` is cacheable, the configured adapter creates a cache
   element containing:
 
@@ -179,7 +178,7 @@ the workflow proceeds like this:
 Cache Keys
 ----------
 
-It is the responsibility of the :ref:`block service <bundle-block-service>` to generate the cache keys in
+It is the responsibility of the :ref:`block service <bundles-block-service>` to generate the cache keys in
 the method ``getCacheKeys``.
 
 The block services shipped with the Symfony CMF BlockBunde use the
@@ -220,7 +219,7 @@ The BlockBundle also has a cache invalidation listener that calls the
 ``flush`` method of a cache adapter automatically when a cached block document
 is updated or removed.
 
-.. _bundle-block-cache-rendering:
+.. _bundles-block-cache-rendering:
 
 Block Rendering
 ---------------

book/database_layer.rst

@@ -7,7 +7,7 @@ application configuration. When using XML, you can use the
 
 The BlockBundle *automatically* changes some defaults and adds configuration
 to the SonataBlockBundle to make the integration work seamlessly. See the
-:ref:`updated SonataBlockBundle defaults <bundle-block-updated-sonata-defaults>`
+:ref:`updated SonataBlockBundle defaults <bundles-block-updated-sonata-defaults>`
 for more information.
 
 Configuration
@@ -34,21 +34,6 @@ is the following configuration:
                     enabled:                  false
                     block_basepath:           /cms/content
                     manager_name:             ~
-                    string_document_class:    Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\StringBlock
-                    simple_document_class:    Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\SimpleBlock
-                    container_document_class: Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ContainerBlock
-                    reference_document_class: Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ReferenceBlock
-                    action_document_class:    Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ActionBlock
-                    slideshow_document_class: Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\SlideshowBlock
-                    imagine_document_class:   Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ImagineBlock
-                    use_sonata_admin:         auto
-                    string_admin_class:       Symfony\Cmf\Bundle\BlockBundle\Admin\StringBlockAdmin
-                    simple_admin_class:       Symfony\Cmf\Bundle\BlockBundle\Admin\SimpleBlockAdmin
-                    container_admin_class:    Symfony\Cmf\Bundle\BlockBundle\Admin\ContainerBlockAdmin
-                    reference_admin_class:    Symfony\Cmf\Bundle\BlockBundle\Admin\ReferenceBlockAdmin
-                    action_admin_class:       Symfony\Cmf\Bundle\BlockBundle\Admin\ActionBlockAdmin
-                    slideshow_admin_class:    Symfony\Cmf\Bundle\BlockBundle\Admin\Imagine\SlideshowBlockAdmin
-                    imagine_admin_class:      Symfony\Cmf\Bundle\BlockBundle\Admin\Imagine\ImagineBlockAdmin
 
     .. code-block:: xml
 
@@ -59,23 +44,8 @@ is the following configuration:
                 <persistence>
                     <phpcr
                         enabled="false"
-                        manager-name="null"
                         block-basepath="/cms/content"
-                        string-document-class="Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\StringBlock"
-                        simple-document-class="Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\SimpleBlock"
-                        container-document-class="Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ContainerBlock"
-                        reference-document-class="Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ReferenceBlock"
-                        action-document-class="Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ActionBlock"
-                        slideshow-document-class="Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\SlideshowBlock"
-                        imagine-document-class="Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ImagineBlock"
-                        use-sonata-admin="auto"
-                        string-admin-class="Symfony\Cmf\Bundle\BlockBundle\Admin\StringBlockAdmin"
-                        simple-admin-class="Symfony\Cmf\Bundle\BlockBundle\Admin\SimpleBlockAdmin"
-                        container-admin-class="Symfony\Cmf\Bundle\BlockBundle\Admin\ContainerBlockAdmin"
-                        reference-admin-class="Symfony\Cmf\Bundle\BlockBundle\Admin\ReferenceBlockAdmin"
-                        action-admin-class="Symfony\Cmf\Bundle\BlockBundle\Admin\ActionBlockAdmin"
-                        slideshow-admin-class="Symfony\Cmf\Bundle\BlockBundle\Admin\Imagine\SlideshowBlockAdmin"
-                        imagine-admin-class="Symfony\Cmf\Bundle\BlockBundle\Admin\Imagine\ImagineBlockAdmin"
+                        manager-name="null"
                     />
                 </persistence>
             </config>
@@ -90,21 +60,6 @@ is the following configuration:
                     'enabled'                  => false,
                     'block-basepath'           => '/cms/content',
                     'manager_name'             => null,
-                    'string_document_class'    => 'Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\StringBlock',
-                    'simple_document_class'    => 'Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\SimpleBlock',
-                    'container_document_class' => 'Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ContainerBlock',
-                    'reference_document_class' => 'Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ReferenceBlock',
-                    'action_document_class'    => 'Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ActionBlock',
-                    'slideshow_document_class' => 'Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\SlideshowBlock',
-                    'imagine_document_class'   => 'Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ImagineBlock',
-                    'use_sonata_admin'         => 'auto',
-                    'string_admin_class'       => 'Symfony\Cmf\Bundle\BlockBundle\Admin\StringBlockAdmin',
-                    'simple_admin_class'       => 'Symfony\Cmf\Bundle\BlockBundle\Admin\SimpleBlockAdmin',
-                    'container_admin_class'    => 'Symfony\Cmf\Bundle\BlockBundle\Admin\ContainerBlockAdmin',
-                    'reference_admin_class'    => 'Symfony\Cmf\Bundle\BlockBundle\Admin\ReferenceBlockAdmin',
-                    'action_admin_class'       => 'Symfony\Cmf\Bundle\BlockBundle\Admin\ActionBlockAdmin',
-                    'slideshow_admin_class'    => 'Symfony\Cmf\Bundle\BlockBundle\Admin\Imagine\SlideshowBlockAdmin',
-                    'imagine_admin_class'      => 'Symfony\Cmf\Bundle\BlockBundle\Admin\Imagine\ImagineBlockAdmin',
                 ),
             ),
         ));
@@ -130,123 +85,6 @@ the value of ``%cmf_core.persistence.phpcr.basepath%/content``.
 
 .. include:: ../_partials/persistence_phpcr_manager_name.rst.inc
 
-``string_document_class``
-"""""""""""""""""""""""""
-
-**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\StringBlock``
-
-The string block document class.
-
-``simple_document_class``
-"""""""""""""""""""""""""
-
-**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\SimpleBlock``
-
-The simple block document class.
-
-``container_document_class``
-""""""""""""""""""""""""""""
-
-**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ContainerBlock``
-
-The container block document class.
-
-``reference_document_class``
-""""""""""""""""""""""""""""
-
-**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ReferenceBlock``
-
-The reference block document class.
-
-``action_document_class``
-"""""""""""""""""""""""""
-
-**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ActionBlock``
-
-The action block document class.
-
-If phpcr is enabled ``use_sonata_admin`` is enabled, the class value is set in
-``Resources/config/admin.xml``.
-
-``slideshow_document_class``
-""""""""""""""""""""""""""""
-
-**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\SlideshowBlock``
-
-The slideshow block document class.
-
-``imagine_document_class``
-""""""""""""""""""""""""""
-
-**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ImagineBlock``
-
-The imagine block document class. This document will only work properly if
-you set up the LiipImagineBundle.
-
-``use_sonata_admin``
-""""""""""""""""""""
-
-**type**: ``enum`` **valid values**: ``true|false|auto`` **default**: ``auto``
-
-If ``true``, the admin classes are activated. If set to ``auto``, they are
-activated only if the SonataPhpcrAdminBundle is present.
-
-If the :doc:`CoreBundle <../core/introduction>` is registered, this will default to the value
-of ``cmf_core.persistence.phpcr.use_sonata_admin``.
-
-``string_admin_class``
-""""""""""""""""""""""
-
-**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\StringBlockAdmin``
-
-The sonata admin class of the string block.
-
-``simple_admin_class``
-""""""""""""""""""""""
-
-**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\SimpleBlockAdmin``
-
-The sonata admin class of the simple block.
-
-``container_admin_class``
-"""""""""""""""""""""""""
-
-**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\ContainerBlockAdmin``
-
-The sonata admin class of the container block.
-
-``reference_admin_class``
-"""""""""""""""""""""""""
-
-**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\ReferenceBlockAdmin``
-
-The sonata admin class of the reference block.
-
-``action_admin_class``
-""""""""""""""""""""""
-
-**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\ActionBlockAdmin``
-
-The sonata admin class of the action block.
-
-``slideshow_admin_class``
-"""""""""""""""""""""""""
-
-**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\Imagine\SlideshowBlockAdmin``
-
-The sonata admin class of the slideshow block.
-
-This admin will only be loaded if ``use_imagine`` is enabled.
-
-``imagine_admin_class``
-"""""""""""""""""""""""
-
-**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\Imagine\ImagineBlockAdmin``
-
-The sonata admin class of the imagine block.
-
-This admin will only be loaded if ``use_imagine`` is enabled.
-
 ``twig``
 ~~~~~~~~
 
@@ -258,7 +96,7 @@ This admin will only be loaded if ``use_imagine`` is enabled.
 The BlockBundle provides a Twig filter ``cmf_embed_blocks`` that
 looks through the content and looks for special tags to render blocks.
 
-See :ref:`embed blocks in content <bundle-block-embed>` for using the
+See :ref:`embed blocks in content <bundles-block-embed>` for using the
 ``cmf_embed_blocks`` filter.
 
 ``prefix``
@@ -275,14 +113,6 @@ The part before the actual path to the block.
 
 The part after the actual path to the block.
 
-``use_imagine``
-~~~~~~~~~~~~~~~
-
-**type**: ``enum`` **valid values**: ``true|false|auto`` **default**: ``auto``
-
-If ``true``, the imagine related block classes and admin classes are activated.
-If set to ``auto``, they are activated only if the LiipImagineBundle is present.
-
 ``caches``
 ~~~~~~~~~~