Merge pull request #271 from symfony-cmf/simple-cms-bundle

restructured SimpleCmsBundle docs

Author: wouterj

bundles/index.rst

@@ -15,7 +15,7 @@ Bundles
     routing_auto
     routing/index
     search
-    simple_cms
+    simple_cms/index
     doctrine_phpcr_admin
     tree_browser
 

bundles/map.rst.inc

@@ -51,9 +51,12 @@
 
   * :doc:`search`
 
-* **SimpleCmsbundle**
+* :doc:`simple_cms/index`
 
-  * :doc:`simple_cms`
+  * :doc:`simple_cms/introduction`
+  * :doc:`simple_cms/multilang`
+  * :doc:`simple_cms/rendering`
+  * :doc:`simple_cms/extending_page_class`
 
 * **SonataDoctrinePhpcrAdminBundle**
 

bundles/routing_auto.rst

@@ -12,7 +12,7 @@ RoutingAutoBundle
 The RoutingAutoBundle allows you to define automatically created routes for
 documents. This implies a separation of the ``Route`` and ``Content``
 documents. If your needs are simple this bundle may not be for you and you
-should have a look at :doc:`SimpleCmsBundle <simple_cms>`.
+should have a look at :doc:`SimpleCmsBundle <simple_cms/introduction>`.
 
 For the sake of example, we will imagine a blog application that has two
 routeable contents, the blog itself, and the posts for the blog.  We will call

bundles/simple_cms.rst

@@ -0,0 +1,80 @@
+.. index::
+    single: Extending Page; SimpleCmsBundle
+
+Extending the Page class
+------------------------
+
+The default Page document (``Symfony\Cmf\Bundle\SimpleCmsBundle\Model\Page``)
+is relatively simple, shipping with a handful of the most common properties
+for building a typical page: title, body, tags, publish dates etc.
+
+If this is not enough for your project you can easily provide your own
+document by extending the default ``Page`` document and explicitly setting the
+configuration parameter to your own document class:
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        cmf_simple_cms:
+            persistence:
+                phpcr:
+                    document_class: Acme\DemoBundle\Document\MySuperPage
+
+    .. code-block:: xml
+
+        <?xml version="1.0" charset="UTF-8" ?>
+        <container xmlns="http://symfony.com/schema/dic/services">
+
+            <config xmlns="http://cmf.symfony.com/schema/dic/simplecms">
+                <persistence>
+                    <phpcr
+                        document-class="Acme\DemoBundle\Document\MySuperPage"
+                    />
+                </persistence>
+            </config>
+
+        </container>
+
+    .. code-block:: php
+
+        $container->loadFromExtension('cmf_simple_cms', array(
+            'persistence' => array(
+                'phpcr' => array(
+                    'document_class' => 'Acme\DemoBundle\Document\MySuperPage',
+                ),
+            ),
+        ));
+
+Alternatively, the default ``Page`` document contains an ``extras`` property.
+This is a key - value store (where value must be string or ``null``) which can be
+used for small trivial additions, without having to extend the default Page
+document.
+
+For example::
+
+    use Symfony\Cmf\Bundle\SimpleCmsBundle\Doctrine\Phpcr\Page;
+    // ...
+
+    $page = new Page();
+
+    $page->setTitle('Hello World!');
+    $page->setBody('Really interesting stuff...');
+    $page->setLabel('Hello World');
+
+    // set extras
+    $extras = array(
+        'subtext' => 'Add CMS functionality to applications built with the Symfony2 PHP framework.',
+        'headline-icon' => 'exclamation.png',
+    );
+
+    $page->setExtras($extras);
+
+    $documentManager->persist($page);
+
+These properties can then be accessed in your controller or templates via the
+``getExtras()`` or ``getExtra($key)`` methods.
+
+.. _`SimpleCmsBundle`: https://github.com/symfony-cmf/SimpleCmsBundle#readme
+.. _`Symfony CMF Standard Edition`: https://github.com/symfony-cmf/symfony-cmf-standard
+.. _`CMF website`: https://github.com/symfony-cmf/cmf-website/

bundles/simple_cms/extending_page_class.rst

@@ -0,0 +1,10 @@
+SimpleCmsBundle
+===============
+
+.. toctree::
+    :maxdepth: 2
+
+    introduction
+    multilang
+    rendering
+    extending_page_class