started updating the tutorial

Author: dbu

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

@@ -4,7 +4,7 @@
 The Big Picture
 ===============
 
-Start using the Symfony CMF in 10 minutes! This chapter will walk you through
+Start using the Symfony CMF in 10 minutes! This quick tour will walk you through
 the base concepts of the Symfony CMF and get you started with it.
 
 It's important to know that the Symfony CMF is a collection of bundles which
@@ -13,7 +13,7 @@ Framework. Before you read further, you should at least have a basic knowledge
 of the Symfony Framework. If you don't know Symfony, start by reading the
 `Symfony Framework Quick Tour`_.
 
-Solving the framework versus CMS dilemma
+Solving the Framework versus CMS Dilemma
 ----------------------------------------
 
 Before starting a new project, there is a difficult decision on whether it
@@ -25,12 +25,12 @@ the core parts of the CMS.
 
 The CMF is created to solve this framework versus CMS dilemma. It provides
 bundles, so you can easily add CMS features to your project. But it also
-provides flexibility and in all cases you are using the framework, so you can
+provides flexibility and you can use the underlying Symfony framework to
 build custom functionality the way you want. This is called a `decoupled CMS`_.
 
 The bundles provided by the Symfony CMF can work together, but they are also
 able to work standalone. This means that you don't need to add all bundles, you
-can decide to only use one of them (e.g. only the RoutingBundle or the MediaBundle).
+can decide to only use one of them (e.g. only the RoutingBundle or the SeoBundle).
 
 Downloading the Symfony CMF Standard Edition
 --------------------------------------------
@@ -45,16 +45,8 @@ The best way to download the Symfony CMF Standard Edition is using Composer_:
 
 .. code-block:: bash
 
-    $ composer create-project symfony-cmf/standard-edition cmf '1.2.1'
+    $ composer create-project symfony-cmf/standard-edition cmf
 
-.. note::
-
-   The `AcmeDemoBundle` that is used in this tour was removed in
-   version 1.3 of the Symfony CMF Standard Edition.  Since then it has
-   become the skeleton for a simple CMS application.  This is why we
-   install version 1.2.1.  If you insist on checking out the most
-   recent versions of the CMF, check out `symfony-cmf/cmf-sandbox`.
-    
 Setting up the Database
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -63,7 +55,7 @@ something you are used to doing when creating Symfony applications, but the
 Symfony CMF needs a database in order to make a lot of things configurable
 using an admin interface.
 
-To quickly get started, it is expected that you have enabled the sqlite
+To quickly get started, it is expected that you have enabled the sqlite PHP
 extension. After that, run these commands:
 
 .. code-block:: bash
@@ -88,9 +80,11 @@ The Request Flow
 
 .. tip::
 
-    When you have at least PHP 5.4, use the ``server:run`` command to run a
-    local server for the demo. Otherwise, use a ``localhost`` and prefix the URLs
-    in this document with ``/path-to-project/web/app_dev.php/``.
+    Use the ``server:run`` command to run a local server for the demo. If you
+    use a web server like Nginx or Apache, you need to prefix the URLs
+    in this document with ``app_dev.php/`` (and the path to the ``web`` folder
+    inside the Symfony project, if that is not already the root folder of your
+    server).
 
 Now, the Standard Edition is ready to use. Navigate to the homepage
 (``http://localhost:8000/``) to see the demo:
@@ -175,13 +169,15 @@ Adding a New Page
 
 Now you know the request flow, you can start adding a new page. In the Symfony
 CMF Standard Edition, the data is stored in data files, which are loaded when
-executing the ``doctrine:phpcr:fixtures:load`` command. To add a new page, you
-just need to edit such a data file, which is located in the
-``src/Acme/DemoBundle/Resources/data`` directory:
+executing the ``doctrine:phpcr:fixtures:load`` command. To add a new page, edit
+one of the data files located in the
+``src/AppBundle/Resources/data`` directory:
+
+TODO: replace example, simplecms bundle is not maintained anymore
 
 .. code-block:: yaml
 
-    # src/Acme/DemoBundle/Resources/data/pages.yml
+    # src/AppBundle/Resources/data/pages.yml
     Symfony\Cmf\Bundle\SimpleCmsBundle\Doctrine\Phpcr\Page:
         # ...
 
@@ -196,28 +192,6 @@ the changes on the database and after refreshing, you can see your new page!
 
 .. image:: ../_images/quick_tour/big-picture-new-page.png
 
-Live Editing
-------------
-
-Now is the time you become an admin of this site and editing the content using
-the Web Interface. To do this click on "Admin Login" and use the provided
-credentials.
-
-You'll see that you have a new bar at the top of the page:
-
-.. image:: ../_images/quick_tour/big-picture-createjs-bar.png
-
-This bar is generated by the `Create.js`_ library. The Symfony CMF integrates
-the CreatePHP_ and `Create.js`_ libraries using a CreateBundle. This enables
-you to edit a page using a full WYSIWYG editor when you are reading the page.
-
-Now you can change the content of our new page using Create.js:
-
-.. image:: ../_images/quick_tour/big-picture-edit-page.png
-
-After clicking "save", the changes are saved using the CreateBundle and the
-content is updated.
-
 Final Thoughts
 --------------
 

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

@@ -11,8 +11,8 @@ of the CMF.
 .. note::
 
     Again, this chapter is talking about the PHPCR storage layer. But the CMF
-    is storage agnostically created, meaning it is not tied to specific storage
-    system.
+    is written in a storage agnostic way, meaning it is not tied to specific
+    storage system.
 
 Getting Familiar with PHPCR
 ---------------------------
@@ -85,10 +85,10 @@ a page by using a yaml file which was parsed by the SimpleCmsBundle. This
 time, you'll create a page by doing it yourself.
 
 First, you have to create a new DataFixture to add your new page. You do this
-by creating a new class in the AcmeDemoBundle::
+by creating a new class in the AppBundle::
 
-    // src/Acme/DemoBundle/DataFixtures/PHPCR/LoadPageData.php
-    namespace Acme\DemoBundle\DataFixtures\PHPCR;
+    // src/AppBundle/DataFixtures/PHPCR/LoadPageData.php
+    namespace AppBundle\DataFixtures\PHPCR;
 
     use Doctrine\Common\Persistence\ObjectManager;
     use Doctrine\Common\DataFixtures\FixtureInterface;

quick_tour/the_big_picture.rst

@@ -135,39 +135,39 @@ new routes in ``/cms/routes``:
     .. code-block:: php
 
         // app/config/config.php
-        $container->loadFromExtension('cmf_routing', array(
-            'chain' => array(
-                'routers_by_id' => array(
+        $container->loadFromExtension('cmf_routing', [
+            'chain' => [
+                'routers_by_id' => [
                     // the standard DynamicRouter
                     'cmf_routing.dynamic_router' => 200,
 
                     // the core symfony router
                     'router.default' => 100,
-                ),
-            ),
-            'dynamic' => array(
-                'persistence' => array(
-                    'phpcr' => array(
+                ],
+            ],
+            'dynamic' => [
+                'persistence' => [
+                    'phpcr' => [
                         'route_basepaths' => '/cms/routes',
-                    ),
+                    ],
                     /* /cms/routes is the default base path, the above code is
                        equivalent to:
                        'phpcr' => true,
                     */
-                ),
-            ),
-        ));
+                ],
+            ],
+        ]);
 
 Now you can add a new ``Route`` to the tree using Doctrine::
 
-    // src/Acme/DemoBundle/DataFixtures/PHPCR/LoadRoutingData.php
-    namespace Acme\DemoBundle\DataFixtures\PHPCR;
+    // src/AppBundle/DataFixtures/PHPCR/LoadRoutingData.php
+    namespace AppBundle\DataFixtures\PHPCR;
 
     use Doctrine\Common\Persistence\ObjectManager;
     use Doctrine\Common\DataFixtures\FixtureInterface;
     use Doctrine\Common\DataFixtures\OrderedFixtureInterface;
     use Doctrine\ODM\PHPCR\DocumentManager;
-    
+
     use PHPCR\Util\NodeHelper;
 
     use Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\Route;
@@ -178,14 +178,14 @@ Now you can add a new ``Route`` to the tree using Doctrine::
         {
             return 20;
         }
-        
+
         public function load(ObjectManager $documentManager)
         {
             if (!$documentManager instanceof DocumentManager) {
                 $class = get_class($documentManager);
                 throw new \RuntimeException("Fixture requires a PHPCR ODM DocumentManager instance, instance of '$class' given.");
             }
-            
+
             $session = $documentManager->getPhpcrSession();
             NodeHelper::createPath($session, '/cms/routes');
 
@@ -205,7 +205,7 @@ Now you can add a new ``Route`` to the tree using Doctrine::
             $documentManager->flush(); // save it
         }
     }
-    
+
 Above we implemented the ``OrderedFixtureInterface`` so that our routes were loaded in the correct sequence relative to other fixtures.
 
 Now execute the ``doctrine:phpcr:fixtures:load`` command again.

quick_tour/the_model.rst

@@ -19,7 +19,7 @@ AcmeDemoBundle:
 
 .. code-block:: html+jinja
 
-    <!-- src/Acme/DemoBundle/Resources/views/layout.html.twig -->
+    <!-- app/Resources/views/layout.html.twig -->
 
     <!-- ... -->
     <nav class="navbar  navbar-inverse  page__nav" role="navigation">
@@ -46,32 +46,6 @@ contains all items implementing the ``NodeInterface`` inside the
     provides Admin classes. See the section about `Sonata Admin`_ to learn
     more about this.
 
-The CreateBundle
-----------------
-
-You've already seen this bundle in the first chapter. This bundle integrates
-the CreatePHP_ library (which uses the `Create.js`_ library) into Symfony2
-using the FOSRestBundle_.
-
-The Create.js library works using a REST layer. All elements on a page get
-`RDFa Mappings`_, which tells Create.js how to map the element to the document.
-When you save the page, the new content is passed to the REST api and saved in
-the database.
-
-Rendering content with RDFa mappings can be very easy, as you can see in the
-Standard Edition:
-
-.. code-block:: html+jinja
-
-    {% block main %}
-    {% createphp cmfMainContent as="rdf" %}
-    {{ rdf|raw }}
-    {% endcreatephp %}
-    {% endblock %}
-
-This will output the content object using `<div>` elements. You can also
-customize this completely by using the ``createphp_*`` functions.
-
 The BlockBundle
 ---------------
 
@@ -86,9 +60,9 @@ used blocks.
 
 The three blocks in the Standard Edition are custom blocks. A block is handled
 by a block service. You can find this service in the
-``Acme\DemoBundle\Block\UnitBlockService`` class. Since the blocks are
+``AppBundle\Block\UnitBlockService`` class. Since the blocks are
 persisted using PHPCR, it also needs a block document, which is located in
-``Acme\DemoBundle\Document\UnitBlock``.
+``AppBundle\Document\UnitBlock``.
 
 The SeoBundle
 -------------
@@ -106,11 +80,11 @@ both the CMF and the Sonata bundle in the ``AppKernel``::
     // ...
     public function registerBundles()
     {
-        $bundles = array(
+        $bundles = [
             // ...
             new Sonata\SeoBundle\SonataSeoBundle(),
             new Symfony\Cmf\Bundle\SeoBundle\CmfSeoBundle(),
-        );
+        ];
         // ...
     }
 
@@ -126,7 +100,7 @@ the CmfSeoBundle can extract the title from a content object:
 The ``%%content_title%%`` will be replaced by the title extracted from the
 content object. The last thing you need to do is using this title as the title
 element. To do this, replace the ``<title>`` tag line in the
-``src/Acme/DemoBundle/Resources/views/layout.html.twig`` template with this:
+``src/AppBundle/Resources/views/layout.html.twig`` template with this:
 
 .. code-block:: html+jinja
 
@@ -157,6 +131,8 @@ more SEO information.
 Sonata Admin
 ------------
 
+TODO: rewrite for sonata admin integration split out
+
 We have explained you that the CMF is based on a database, in order to make it
 editable by an admin without changing the code. But we haven't told you how
 that admin will be able to maintain the website. Now it's time to reveal how