Merge remote-tracking branch 'origin/master' into update-master-from-1.2

Conflicts:
	bundles/phpcr_odm/configuration.rst

Author: dbu

.travis.yml

@@ -3,6 +3,14 @@ language: python
 python:
     - "2.7"
 
+sudo: false
+
+addons:
+    apt:
+        packages: [enchant]
+
 install: "pip install -q -r requirements.txt --use-mirrors"
 
-script: sphinx-build -nW -b html -d _build/doctrees . _build/html
+script: 
+    - sphinx-build -nW -b html -d _build/doctrees . _build/html
+    - make spelling

Makefile

@@ -37,6 +37,7 @@ help:
 	@echo "  changes    to make an overview of all changed/added/deprecated items"
 	@echo "  linkcheck  to check all external links for integrity"
 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  spelling   generate a spelling report"
 
 clean:
 	-rm -rf $(BUILDDIR)/*
@@ -151,3 +152,7 @@ doctest:
 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 	@echo "Testing of doctests in the sources finished, look at the " \
 	      "results in $(BUILDDIR)/doctest/output.txt."
+
+spelling:
+	$(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling
+	@echo "Spelling report generated in $(BUILDDIR)/spelling/output.txt"

book/database_layer.rst

@@ -37,7 +37,7 @@ versioning and access control.
 
 Doctrine PHPCR-ODM has the same API as the other Doctrine libraries, like the
 `Doctrine ORM`_. The Doctrine PHPCR-ODM adds another great feature to PHPCR:
-Multilanguage support.
+multi-language support.
 
 .. sidebar:: PHPCR Implementations
 
@@ -171,7 +171,7 @@ After this, you have to create getters and setters for the properties.
     This Document uses the parent document and a node name to determine its
     position in the tree. Because there isn't any name set, it is generated
     automatically. If you want to use a specific node name, such as a
-    sluggified version of the title, you need to add a property mapped as
+    slugified version of the title, you need to add a property mapped as
     ``Nodename``.
 
     A Document must have an id property. This represents the full path (parent
@@ -272,7 +272,7 @@ you've configured a route to display a specific task by name::
 
 To retrieve objects from the document repository using both the ``find`` and
 ``findMany`` methods and all helper methods of a class-specific repository. In
-PHPCR, it's often unkown for developers which node has the data for a specific
+PHPCR, it's often unknown for developers which node has the data for a specific
 document, in that case you should use the document manager to find the nodes
 (for instance, when you want to get the root document). In example above, we
 know they are ``Task`` documents and so we can use the repository.
@@ -294,7 +294,7 @@ The repository contains all sorts of helpful methods::
 .. tip::
 
     If you use the repository class, you can also create a custom repository
-    for a specific document. This helps with "Seperation of Concern" when using more
+    for a specific document. This helps with "Separation of Concern" when using more
     complex queries. This is similar to how it's done in Doctrine ORM, for
     more information read "`Custom Repository Classes`_" in the core
     documentation.

book/handling_multilang.rst

@@ -15,7 +15,7 @@ transparently.
 .. caution::
 
     You also need the ``intl`` php extension installed and enabled (otherwise
-    composer will tell you it can't find ext-intl). If you get issues that some
+    composer will tell you it can't find ``ext-intl``). If you get issues that some
     locales can not be loaded, have a look at `this discussion about ICU`_.
 
 Initial Language Choice: Lunetics LocaleBundle
@@ -56,7 +56,7 @@ Configuring Available Locales
 -----------------------------
 
 The CoreBundle needs to be configure with the available locales. If it is
-not configured with locales, it registeres a listener that removes all
+not configured with locales, it registries a listener that removes all
 translation mapping from PHPCR-ODM documents.
 
 .. configuration-block::

book/installation.rst

@@ -16,13 +16,15 @@ After that, you get a quick introduction of the bundles you have installed.
 This can be used to familiarize yourself with the CMF or as a starting point
 for a new custom application.
 
-.. note::
+This tutorial is aimed at people who want to get started with a project based
+on the Symfony CMF. There are two alternate articles in the cookbook you might
+want to look at, depending on what you need:
 
-    You can also install the CMF Sandbox, this is a more complete demo
-    instance of the Symfony CMF. You can view it online at `cmf.liip.ch`_.
-    You can also install it locally, so you can play with the code. For
-    installation instructions for the sandbox, please read
-    ":doc:`../cookbook/editions/cmf_sandbox`".
+* :doc:`../cookbook/editions/cmf_core` - a guide for adding the CMF to a standard
+  Symfony project.
+* :doc:`../cookbook/editions/cmf_sandbox` for instructions on how to install a
+  demonstration sandbox. The sandbox contains many examples of what you can do
+  with the CMF.
 
 Preconditions
 -------------
@@ -251,7 +253,7 @@ Adding new pages
 Symfony CMF SE does not provide any admin tools to create new pages. If you
 are interested in adding an admin UI one solution can be found in
 :doc:`../tutorial/sonata-admin`. However, if all you want
-is a simple way to add new pages that you can then edit via the inline
+is a simple way to add new pages that you can then edit via the in-line
 editing, then you can use the SimpleCmsBundle ``page`` migrator. For example,
 to add a page called "Testing", creating a file called
 ``app/Resources/data/pages/test.yml`` with the following contents:

book/routing.rst

@@ -449,10 +449,12 @@ As mentioned above, you can use any route provider. The example in this
 section applies if you use the default PHPCR-ODM route provider
 (``Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\RouteProvider``).
 
-All routes are located under the base path configured in the application
-configuration ``cmf_routing.persistence.phpcr.route_basepath``. By default
-this path is ``/cms/routes``. A new route can be created in PHP code as
-follows::
+PHPCR-ODM documents are stored in a tree, and their ID is the path in that
+tree. To match routes, a part of the repository path is used as URL. To avoid
+mixing routes and other documents, routes are placed under a common root path
+and that path is removed from the ID to build the URL. The common root path is
+called "route basepath". The default base path is ``/cms/routes``. A new route
+can be created in PHP code as follows::
 
     // src/Acme/MainBundle/DataFixtures/PHPCR/LoadRoutingData.php
     namespace Acme\DemoBundle\DataFixtures\PHPCR;
@@ -481,7 +483,7 @@ follows::
 
             $route = new Route();
             $route->setParentDocument($dm->find(null, '/cms/routes'));
-            $route->setName('projects');
+            $route->setName('my-page');
 
             // link a content to the route
             $content = new StaticContent();
@@ -492,37 +494,28 @@ follows::
             $dm->persist($content);
             $route->setContent($content);
 
-            // now define an id parameter; do not forget the leading slash if you
-            // want /projects/{id} and not /projects{id}
-            $route->setVariablePattern('/{id}');
-            $route->setRequirement('id', '\d+');
-            $route->setDefault('id', 1);
-
             $dm->persist($route);
             $dm->flush();
         }
     }
 
-This will give you a document that matches the URL ``/projects/<number>`` but
-also ``/projects`` as there is a default for the id parameter.
+Now the CMF will be able to handle requests for the URL ``/my-content``.
 
 .. caution::
 
-    As you can see, the code explicitely creates the ``/cms/routes`` path.
+    As you can see, the code explicitly creates the ``/cms/routes`` path.
     The RoutingBundle only creates this path automatically if the Sonata Admin
     was enabled in the routing configuration using an :ref:`initializer
     <phpcr-odm-repository-initializers>`. Otherwise, it'll assume you do
     something yourself to create the path (by configuring an initializer or
     doing it in a fixture like this).
 
-Because you defined the ``{id}`` route parameter, your controller can expect an
-``$id`` parameter. Additionally, because you called ``setContent`` on the
-route, your controller can expect the ``$contentDocument`` parameter.
-The content could be used to define an intro section that is the same for each
-project or other shared data. If you don't need content, you can just not set it
-in the document.
+Because you called ``setContent`` on the route, the controller can expect the
+``$contentDocument`` parameter. You can now configure which controller should
+handle ``StaticContent`` as :ref:`explained above <start-routing-getting-controller-template>`.
 
-For more details, see the
+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>`.
 
 Further Notes

book/static_content.rst

@@ -78,5 +78,4 @@ developers with a small and easy to understand starting point you can extend
 or use as inspiration to develop your own content types, Controllers and Admin
 panels.
 
-.. _`multilanguage support in PHPCR-ODM`: http://docs.doctrine-project.org/projects/doctrine-phpcr-odm/en/latest/reference/multilang.html
 .. _SonataDoctrinePHPCRAdminBundle: https://github.com/sonata-project/SonataDoctrinePhpcrAdminBundle

bundles/block/cache.rst

@@ -139,7 +139,7 @@ is triggered:
   * Cache keys are computed using:
 
     * The cache keys of the block service;
-    * The extraCacheKeys passed from the template.
+    * The ``extraCacheKeys`` passed from the template.
 
   * The cache adapter is asked for a cache element: