Merge pull request #126 from WouterJ/line_length

[Getting Started] Fixed line lengths

Author: dbu

getting-started/content.rst

@@ -7,41 +7,40 @@ Content
 Concept
 -------
 
-At the heart of every CMS stands the content, an abstraction that the publishers
-can manipulate and that will later be presented to the page's users. The content's
-structure greatly depends on the project's needs, and it will have a significant
-impact on future development and use of the platform.
+At the heart of every CMS stands the content, an abstraction that the
+publishers can manipulate and that will later be presented to the page's
+users. The content's structure greatly depends on the project's needs, and it
+will have a significant impact on future development and use of the platform.
 
 Symfony CMF SE comes with the ContentBundle: a basic implementation of a
-content structure, including support for multiple languages and database storage
-of Routes.
+content structure, including support for multiple languages and database
+storage of Routes.
 
 Static Content
 --------------
 
-The ``StaticContent`` declares the basic content's structure. Its structure
-is very similar to the ones used on Symfony2's ORM systems, and most of its
+The ``StaticContent`` declares the basic content's structure. Its structure is
+very similar to the ones used on Symfony2's ORM systems, and most of its
 fields are self explanatory, and are what you would expect from a basic CMS:
-title, body, publishing information and a parent reference, to accommodate
-a tree-like hierarchy. It also includes a Block reference (more on that later).
+title, body, publishing information and a parent reference, to accommodate a
+tree-like hierarchy. It also includes a Block reference (more on that later).
 
 The two implemented interfaces reveal two of the features included in this
 implementation:
 
 * ``RouteAwareInterface`` means that the content has associated Routes.
-
 * ``PublishWorkflowInterface`` means that the content has publishing and
-   unpublishing dates, which will be handled by Symfony CMF's core to determine
-   access.
+   unpublishing dates, which will be handled by Symfony CMF's core to
+   determine access.
 
 
 Multilang Static Content
 ------------------------
 
 The ``MultilangStaticContent`` extends ``StaticContent``, offering the same
-functionality with multi language support. It specifies which fields are to
-be translated (``title``, ``body`` and ``tags``) as well as a variable to
-declare the locale.
+functionality with multi language support. It specifies which fields are to be
+translated (``title``, ``body`` and ``tags``) as well as a variable to declare
+the locale.
 
 It also specifies the translation strategy:
 
@@ -61,43 +60,43 @@ Content Controller
 ------------------
 
 To handle both content types, a controller is also included. Its inner
-workings are pretty straightforward: It accepts a content instance and optionally
-a template to render it. If none is provided, it uses a pre-configured default.
-It also takes into account the document's publishing status and multi language.
-Both the content instance and the optional template are provided to the controller
-by the ``DynamicRouter`` of the RoutingExtraBundle. More information on this is
-available on the
+workings are pretty straightforward: It accepts a content instance and
+optionally a template to render it. If none is provided, it uses a
+pre-configured default.  It also takes into account the document's publishing
+status and multi language.  Both the content instance and the optional
+template are provided to the controller by the ``DynamicRouter`` of the
+RoutingExtraBundle. More information on this is available on the
 :ref:`Routing system getting started page <start-routing-linking-a-route-with-a-model-instance>`
 page.
 
 Admin Support
 -------------
 
-The last component needed to handle the included content types is an administration
-panel. Symfony CMF can optionally support `SonataDoctrinePHPCRAdminBundle`_
-, a back office generation tool. For more information about it, please refer
-to the bundle's `documentation section`_.
+The last component needed to handle the included content types is an
+administration panel. Symfony CMF can optionally support
+`SonataDoctrinePHPCRAdminBundle`_ , a back office generation tool. For more
+information about it, please refer to the bundle's `documentation section`_.
 
-In ContentBundle, the required administration panels are already declared
-in the ``Admin`` folder and configured in ``Resources/config/admin.xml``,
-and will automatically be loaded if you install the SonataDoctrinePHPCRAdminBundle
-(refer to :doc:`../tutorials/creating-cms-using-cmf-and-sonata` for instructions
-on that).
+In ContentBundle, the required administration panels are already declared in
+the ``Admin`` folder and configured in ``Resources/config/admin.xml``, and
+will automatically be loaded if you install the SonataDoctrinePHPCRAdminBundle
+(refer to :doc:`../tutorials/creating-cms-using-cmf-and-sonata` for
+instructions on that).
 
 Configuration
 -------------
 
-The bundle also supports a set of optional configuration parameters. Refer
-to :doc:`../bundles/content` for the full configuration reference.
+The bundle also supports a set of optional configuration parameters. Refer to
+:doc:`../bundles/content` for the full configuration reference.
 
 Final Thoughts
 --------------
 
-While this small bundle includes some vital components to a fully working
-CMS, it often will not provide all you need. The main idea behind it is to
-provide 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.
+While this small bundle includes some vital components to a fully working CMS,
+it often will not provide all you need. The main idea behind it is to provide
+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

getting-started/installing-symfony-cmf.rst

@@ -4,46 +4,47 @@
 Installing the Symfony CMF Standard Edition
 ===========================================
 
-The goal of this tutorial is to install all the CMF components with the minimum necessary
-configuration and some very simple examples into a working Symfony2 application. This can
-be used to familiarize yourself with the CMF or to be used as a starting point for a new
-custom application.
+The goal of this tutorial is to install all the CMF components with the
+minimum necessary configuration and some very simple examples into a working
+Symfony2 application. This can be used to familiarize yourself with the CMF or
+to be used as a starting point for a new custom application.
 
-If this is your first encounter with the Symfony CMF it would be a good idea to first take a
-look at:
+If this is your first encounter with the Symfony CMF it would be a good idea
+to first take a look at:
 
-- `The Big Picture`_
-- The online sandbox demo at `cmf.liip.ch`_
+* `The Big Picture`_
+* The online sandbox demo at `cmf.liip.ch`_
 
 .. note::
 
     For other Symfony CMF installation guides, please read:
 
-    * The cookbook entry on :doc:`../cookbook/installing-cmf-sandbox` for instructions on
-      how to install a more complete demo instance of Symfony CMF.
-    * :doc:`../tutorials/installing-cmf-core` for step-by-step installation and
-      configuration details of just the core components into an existing Symfony
-      application.
+    * The cookbook entry on :doc:`../cookbook/installing-cmf-sandbox` for
+      instructions on how to install a more complete demo instance of Symfony
+      CMF.
+    * :doc:`../tutorials/installing-cmf-core` for step-by-step installation
+      and configuration details of just the core components into an existing
+      Symfony application.
 
 Preconditions
 -------------
 
 As Symfony CMF is based on Symfony2, you should make sure you meet the
-`Requirements for running Symfony2`_.
-Additionally, you need to have `SQLite`_ PDO extension (``pdo_sqlite``)
-installed, since it is used as the default storage medium.
+`Requirements for running Symfony2`_. Additionally, you need to have `SQLite`_
+PDO extension (``pdo_sqlite``) installed, since it is used as the default
+storage medium.
 
 .. note::
 
-    By default, Symfony CMF uses Jackalope + Doctrine DBAL and SQLite as
-    the underlying DB. However, Symfony CMF is storage agnostic, which means
-    you can use one of several available data storage mechanisms without
-    having to rewrite your code. For more information on the different
-    available mechanisms and how to install and configure them, refer to
+    By default, Symfony CMF uses Jackalope + Doctrine DBAL and SQLite as the
+    underlying DB. However, Symfony CMF is storage agnostic, which means you
+    can use one of several available data storage mechanisms without having to
+    rewrite your code. For more information on the different available
+    mechanisms and how to install and configure them, refer to
     :doc:`../tutorials/installing-configuring-doctrine-phpcr-odm`
 
-`Git`_ and `Curl`_ are also needed to follow the installation steps listed below.
-
+`Git`_ and `Curl`_ are also needed to follow the installation steps listed
+below.
 
 Installation
 ------------
@@ -64,14 +65,15 @@ and then get the Symfony CMF code with it (this may take a while)
 
 .. note::
 
-    The path ``<path-to-install>`` should either inside your web server doc root or
-    configure a virtual host for ``<path-to-install>``.
+    The path ``<path-to-install>`` should either inside your web server doc
+    root or configure a virtual host for ``<path-to-install>``.
 
-This will clone the standard edition and install all the dependencies and run some initial commands.
-These commands require write permissions to the ``app/cache`` and ``app/logs`` directory. In case
-the final commands end up giving permissions errors, please follow the
-`guidelines in the symfony book`_ for configuring the permissions and then run the
-``composer.phar install`` command mentioned below.
+This will clone the standard edition and install all the dependencies and run
+some initial commands.  These commands require write permissions to the
+``app/cache`` and ``app/logs`` directory. In case the final commands end up
+giving permissions errors, please follow the `guidelines in the symfony book`_
+for configuring the permissions and then run the ``composer.phar install``
+    command mentioned below.
 
 If you prefer you can also just clone the project:
 
@@ -80,15 +82,16 @@ If you prefer you can also just clone the project:
     $ git clone git://github.com/symfony-cmf/symfony-cmf-standard.git <dir-name>
     $ cd <dir-name>
 
-If there were problems during the ``create-project`` command, or if you used ``git clone`` or if you
-updated the checkout later, always run the following command to update the dependencies:
+If there were problems during the ``create-project`` command, or if you used
+``git clone`` or if you updated the checkout later, always run the following
+command to update the dependencies:
 
 .. code-block:: bash
 
     $ php composer.phar install
 
-The next step is to setup the database, if you want to use SQLite as your database backend just go
-ahead and run the following:
+The next step is to setup the database, if you want to use SQLite as your
+database backend just go ahead and run the following:
 
 .. code-block:: bash
 
@@ -97,10 +100,11 @@ ahead and run the following:
     $ php app/console doctrine:phpcr:repository:init
     $ php app/console doctrine:phpcr:fixtures:load
 
-This will create a file called ``app.sqlite`` inside your app folder, containing the database content.
+This will create a file called ``app.sqlite`` inside your app folder,
+containing the database content.
 
-The project should now be accessible on your web server. If you have PHP 5.4 installed
-you can alternatively use the PHP internal web server:
+The project should now be accessible on your web server. If you have PHP 5.4
+installed you can alternatively use the PHP internal web server:
 
 .. code-block:: bash
 
@@ -112,57 +116,63 @@ And then access the CMF via:
 
     http://localhost:8000
 
-If you prefer to use another database backend, for example MySQL, run the configurator (point your browser
-to ``/web/config.php``) or set your database connection parameters in ``app/config/parameters.yml``. Make sure you
-leave the ``database_path`` property at ``null`` in order to use another driver than SQLite. Leaving the field blank
-in the web-configurator should set it to ``null``.
+If you prefer to use another database backend, for example MySQL, run the
+configurator (point your browser to ``/web/config.php``) or set your database
+connection parameters in ``app/config/parameters.yml``. Make sure you leave
+the ``database_path`` property at ``null`` in order to use another driver than
+SQLite. Leaving the field blank in the web-configurator should set it to
+``null``.
 
 Overview
 --------
 
 This guide will help you understand the basic parts of Symfony CMF Standard
-Edition (SE) and how they work together to provide the default pages you
-can see when browsing the Symfony CMF SE installation.
+Edition (SE) and how they work together to provide the default pages you can
+see when browsing the Symfony CMF SE installation.
 
-It assumes you have already installed Symfony CMF SE and have carefully
-read `the Symfony2 book`_.
+It assumes you have already installed Symfony CMF SE and have carefully read
+`the Symfony2 book`_.
 
 .. note::
 
     For other Symfony CMF installation guides, please read:
 
-    * The cookbook entry on :doc:`../cookbook/installing-cmf-sandbox` for instructions on how to
-      install a more complete demo instance of Symfony CMF.
-    * :doc:`../tutorials/installing-cmf-core` for step-by-step installation and configuration
-      details of just the core components into an existing Symfony application.
+    * The cookbook entry on :doc:`../cookbook/installing-cmf-sandbox` for
+      instructions on how to install a more complete demo instance of Symfony
+      CMF.
+    * :doc:`../tutorials/installing-cmf-core` for step-by-step installation
+      and configuration details of just the core components into an existing
+      Symfony application.
 
 AcmeMainBundle and SimpleCMSBundle
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Symfony CMF SE comes with a default AcmeMainBundle to help you get started,
-in a similar way that Symfony2 has AcmeDemoBundle, providing you some
-demo pages visible on your browser. However, AcmeMainBundle doesn't include
-controllers or configuration files, like you probably would expect. It contains
-little more than a twig file and `Fixtures`_ data, that was loaded into your
-database during installation.
+Symfony CMF SE comes with a default AcmeMainBundle to help you get started, in
+a similar way that Symfony2 has AcmeDemoBundle, providing you some demo pages
+visible on your browser. However, AcmeMainBundle doesn't include controllers
+or configuration files, like you probably would expect. It contains little
+more than a twig file and `Fixtures`_ data, that was loaded into your database
+during installation.
 
 There are several bundles working together in order to turn the fixture data
 into a browsable website. The overall, simplified process is:
 
-* When a request is received, the :doc:`Symfony CMF Routing's Dynamic Router <routing>` is used
-  to handle the incoming request;
-* The Dynamic Router is able to match the requested URL with a specific ContentBundle's Content
-  stored in the database;
-* The retrieved content's information is used to determine which controller to pass it on to, and
-  which template to use;
+* When a request is received, the :doc:`Symfony CMF Routing's Dynamic Router <routing>`
+  is used to handle the incoming request;
+* The Dynamic Router is able to match the requested URL with a specific
+  ContentBundle's Content stored in the database;
+* The retrieved content's information is used to determine which controller to
+  pass it on to, and which template to use;
 * As configured, the retrieved content is passed to ContentBundle's
-  ``ContentController``, which will handle it and render AcmeMainBundle's ``layout.html.twig``.
+  ``ContentController``, which will handle it and render AcmeMainBundle's
+  ``layout.html.twig``.
 
-Again, this is simplified view of a very simple CMS built on top of Symfony CMF.
-To fully understand all the possibilities of the CMF, a careful look into
-each component is needed.
+Again, this is simplified view of a very simple CMS built on top of Symfony
+CMF.  To fully understand all the possibilities of the CMF, a careful look
+into each component is needed.
 
-If you want to review the contents of the PHPCR database you can use the following command:
+If you want to review the contents of the PHPCR database you can use the
+following command:
 
 .. code-block:: bash
 
@@ -171,21 +181,25 @@ If you want to review the contents of the PHPCR database you can use the followi
 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 have a look at :doc:`../tutorials/creating-cms-using-cmf-and-sonata`. However if all you
-want is a simple way to add new pages that you can then edit via the inline editing, then you can
-use the SimpleCmsBundle ``page`` migrator. The Symfony CMF SE ships with an example yaml file stored
-in ``app/Resources/data/pages/test.yml``. The contents of this file can be loaded into the PHPCR
-database by calling:
+Symfony CMF SE does not provide any admin tools to create new pages. If you
+are interested in adding an admin UI have a look at
+:doc:`../tutorials/creating-cms-using-cmf-and-sonata`. However if all you want
+is a simple way to add new pages that you can then edit via the inline
+editing, then you can use the SimpleCmsBundle ``page`` migrator. The Symfony
+CMF SE ships with an example yaml file stored in
+``app/Resources/data/pages/test.yml``. The contents of this file can be loaded
+into the PHPCR database by calling:
 
 .. code-block:: bash
 
     $ php app/console doctrine:phpcr:migrator page --identifier=/cms/simple/test
 
-Note that the above identifier is mapped to ``app/Resources/data/pages/test.yml`` by stripping
-off the ``basepath`` configuration of the SimpleCmsBundle, which defaults to ``/cms/simple``.
-Therefore if you want to define a child page ``foo`` for ``/cms/simple/test`` you would need to
-create a file ````app/Resources/data/pages/test/foo.yml`` and then run the following command:
+Note that the above identifier is mapped to
+``app/Resources/data/pages/test.yml`` by stripping off the ``basepath``
+configuration of the SimpleCmsBundle, which defaults to ``/cms/simple``.
+Therefore if you want to define a child page ``foo`` for ``/cms/simple/test``
+you would need to create a file ``app/Resources/data/pages/test/foo.yml``
+and then run the following command:
 
 .. code-block:: bash