Skip to content
This repository was archived by the owner on Sep 16, 2021. It is now read-only.

Commit 141fd9a

Browse files
committed
Merge pull request #287 from symfony-cmf/installation
minor tweaks to the SE installation guide
2 parents 862bb7d + 647eb96 commit 141fd9a

File tree

2 files changed

+22
-13
lines changed

2 files changed

+22
-13
lines changed

book/installation.rst

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,15 @@ And then access the CMF via:
137137
use another driver than SQLite. Leaving the field blank in the
138138
web-configurator will set it to ``null``.
139139

140+
.. note::
141+
142+
The proper term to use for the default database of the CMF is
143+
*content repository*. The idea behind this name is essentially to describe a
144+
specialized database created specifically for content management systems.
145+
The acronym *PHPCR* actually stands for *PHP content repository*. But as
146+
mentioned before, the CMF is storage agnostic so its possible to combine
147+
the CMF with other storage mechanism, like Doctrine ORM, Propel etc.
148+
140149
Overview
141150
--------
142151

@@ -168,13 +177,13 @@ into a browsable website. The overall, simplified process is:
168177

169178
* When a request is received, the :doc:`Symfony CMF Routing's Dynamic Router <routing>`
170179
is used to handle the incoming request;
171-
* The Dynamic Router is able to match the requested URL with a specific
172-
ContentBundle's Content stored in the database;
173-
* The retrieved content's information is used to determine which controller to
180+
* The Dynamic Router is able to match the requested URL to a ``Page`` document
181+
provided by SimpleCmsBundle and stored inside the database;
182+
* The retrieved document information is used to determine which controller to
174183
pass it on to, and which template to use;
175-
* As configured, the retrieved content is passed to ContentBundle's
176-
``ContentController``, which will handle it and render AcmeMainBundle's
177-
``layout.html.twig``.
184+
* As configured, the retrieved document is passed to ``ContentController``
185+
provided by the ContentBundle, which render document into ``layout.html.twig``
186+
of the AcmeMainBundle.
178187

179188
Again, this is simplified view of a very simple CMS built on top of Symfony
180189
CMF. To fully understand all the possibilities of the CMF, continue reading
@@ -216,7 +225,8 @@ into the PHPCR database by calling:
216225
217226
Note that the above identifier is mapped to
218227
``app/Resources/data/pages/test.yml`` by stripping off the ``basepath``
219-
configuration of the SimpleCmsBundle (which defaults to ``/cms/simple``)....
228+
configuration of the SimpleCmsBundle (which defaults to ``/cms/simple``).
229+
220230
Therefore if you want to define a child page ``foo`` for ``/cms/simple/test``
221231
you would need to create a file ``app/Resources/data/pages/test/foo.yml``
222232
and then run the following command:

book/routing.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Routing
66
=======
77

88
This is an introduction to understand the concepts behind CMF routing. For the
9-
reference documentation please see :doc:`../components/routing` and
10-
:doc:`../bundles/routing/introduction`.
9+
reference documentation please see the documentation for the
10+
:doc:`../components/routing` component and :doc:`../bundles/routing/introduction`.
1111

1212
Concept
1313
-------
@@ -28,17 +28,16 @@ dynamic, user-defined routes, nor does it scale well to a large number of routes
2828
The Solution
2929
~~~~~~~~~~~~
3030

31-
In order to address these issues, a new routing system was developed that
32-
takes into account the typical needs of CMS routing:
31+
In order to address these issues, a new routing system needed to be developed
32+
that takes into account the typical needs of CMS routing:
3333

3434
* User-defined URLs;
3535
* Multi-site;
3636
* Multi-language;
3737
* Tree-like structure for easier management;
3838
* Content, Menu and Route separation for added flexibility.
3939

40-
With these requirements in mind, the Symfony CMF Routing component was
41-
developed.
40+
The Symfony CMF Routing component was created with these requirements in mind.
4241

4342
The ``ChainRouter``
4443
-------------------

0 commit comments

Comments
 (0)