Merge pull request #739 from symfony-cmf/ivory_ckeditor

Document IvoryCKEditorBundle integration

Author: dbu

bundles/_partials/ivory_ckeditor.rst.inc

@@ -0,0 +1,59 @@
+``ivory_ckeditor``
+~~~~~~~~~~~~~~~~~~
+
+.. versionadded:: 1.3
+    IvoryCKEditorBundle integration was introduced in version 1.3.
+
+This configures integration of the IvoryCKEditorBundle_, so an admin can edit
+content using CKeditor.
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        cmf_content:
+            ivory_ckeditor:
+                enabled:     auto
+                config_name: cmf_content
+
+    .. code-block:: xml
+
+        <?xml version="1.0" encoding="UTF-8" ?>
+        <container xmlns="http://symfony.com/schema/dic/services"
+            xmlns:xsi="http://www.w3.org/2001/XMLSchema-Instance"
+            xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
+            http://cmf.symfony.com/schema/dic/content http://cmf.symfony.com/schema/dic/content/content-1.0.xsd"
+        >
+
+            <config xmlns="http://cmf.symfony.com/schema/dic/content">
+                <ivory-ckeditor enabled="auto" config-name="cmf_content" />
+            </config>
+
+        </container>
+
+    .. code-block:: php
+
+        $container->loadFromExtension('cmf_content', array(
+            'ivory_ckeditor' => array(
+                'enabled'     => true,
+                'config_name' => 'cmf_content',
+            ),
+        ));
+
+``enabled``
+...........
+
+**type**: ``enum`` **valid values**: ``true|false|auto`` **default**: ``auto``
+
+Enables/disables the CKeditor integration. ``auto`` will enable the integration
+only when the IvoryCKEditorBundle is registered. ``false`` will always disable
+the integration.
+
+``config_name``
+...............
+
+**type**: ``string`` **default**: ``cmf_content``
+
+The name of the IvoryCKEditorBundle config set to use for the editor.
+
+.. _IvoryCKEditorBundle: https://github.com/egeloen/IvoryCKEditorBundle

bundles/content/configuration.rst

@@ -71,33 +71,33 @@ is the following configuration:
         ));
 
 ``enabled``
-***********
+...........
 
 .. include:: ../_partials/persistence_phpcr_enabled.rst.inc
 
 ``admin_class``
-***************
+...............
 
 **type**: ``string`` **default**: ``Symfony\Cmf\Bundle\ContentBundle\Admin\StaticContentAdmin``
 
 The admin class to use when :ref:`Sonata Admin is activated <quick-tour-third-party-sonata>`.
 
 ``document_class``
-******************
+..................
 
 **type**: ``string`` **default**: ``Symfony\Cmf\Bundle\ContentBundle\Doctrine\Phpcr\StaticContent``
 
 The Content class to use.
 
 ``content_basepath``
-********************
+....................
 
 **type**: ``string`` **default**: ``/cms/content``
 
 The basepath for Content documents in the PHPCR tree.
 
 ``use_sonata_admin``
-********************
+....................
 
 **type**: ``enum`` **valid values**: ``true|false|auto`` **default**: ``auto``
 
@@ -107,3 +107,5 @@ 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``.
+
+.. include:: ../_partials/ivory_ckeditor.rst.inc

bundles/content/introduction.rst

@@ -226,6 +226,18 @@ removing static content from the admin panel. To enable the admin, use the
 also provides :ref:`several useful extensions <bundles-core-persistence>` for
 SonataAdminBundle.
 
+.. tip::
+
+    Install the IvoryCKEditorBundle_ to enable a CKEditor to edit the content
+    body:
+
+    .. code-block:: bash
+
+        $ composer require egeloen/ckeditor-bundle
+
+    .. versionadded:: 1.3
+        IvoryCKEditorBundle integration was introduced in CmfContentBundle 1.3.
+
 Read On
 -------
 
@@ -234,3 +246,4 @@ Read On
 
 .. _`with composer`: http://getcomposer.org
 .. _`symfony-cmf/content-bundle`: https://packagist.org/packages/symfony-cmf/content-bundle
+.. _IvoryCKEditorBundle: https://github.com/egeloen/IvoryCKEditorBundle

bundles/simple_cms/configuration.rst

@@ -192,3 +192,5 @@ Configure integration with CmfMenuBundle.
 .. versionadded:: 1.1
     Since SimpleCmsBundle 1.1, this configuration is done directly on the
     :ref:`RoutingBundle <reference-config-routing-locales>`.
+
+.. include:: ../_partials/ivory_ckeditor.rst.inc

spelling_word_list.txt

@@ -21,6 +21,7 @@ cacheable
 cdn
 checkbox
 ckfinder
+CKeditor
 cmf
 coffeescript
 config