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

[NEW TOC] Tutorials to cookbook #250

Merged
merged 9 commits into from
Sep 12, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions book/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ for a new custom application.
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/installing_cmf_sandbox`".
":doc:`../cookbook/editions/cmf_sandbox`".

Preconditions
-------------
Expand All @@ -44,7 +44,7 @@ storage medium.
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`
:doc:`../cookbook/installing_configuring_doctrine_phpcr_odm`

Installation
------------
Expand Down Expand Up @@ -208,7 +208,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 have a look at
:doc:`../tutorials/creating_cms_using_cmf_and_sonata`. However if all you want
:doc:`../cookbook/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
Expand Down
8 changes: 4 additions & 4 deletions book/routing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Routing

This is an introduction to understand the concepts behind CMF routing. For the
reference documentation please see :doc:`../components/routing` and
:doc:`../bundles/routing`.
:doc:`../bundles/routing/introduction`.

Concept
-------
Expand Down Expand Up @@ -213,7 +213,7 @@ provider loads the route at the path in the request and all parent paths to
allow for some of the path segments being parameters.

For more detailed information on this implementation and how you can customize
or extend it, refer to :doc:`../bundles/routing`.
or extend it, refer to :doc:`../bundles/routing/introduction`.

The ``DynamicRouter`` is able to match the incoming request to a Route object
from the underlying provider. The details on how this matching process is
Expand Down Expand Up @@ -558,9 +558,9 @@ Further Notes
For more information on the Routing component of Symfony CMF, please refer to:

* :doc:`../components/routing` for most of the actual functionality implementation
* :doc:`../bundles/routing` for Symfony2 integration bundle for Routing Bundle
* :doc:`../bundles/routing/introduction` for Symfony2 integration bundle for Routing Bundle
* Symfony2's `Routing`_ component page
* :doc:`../tutorials/handling_multilang_documents` for some notes on multilingual routing
* :doc:`../cookbook/handling_multilang_documents` for some notes on multilingual routing

.. _`PHPCR-ODM`: https://github.com/doctrine/phpcr-odm
.. _`Routing`: http://symfony.com/doc/current/components/routing/introduction.html
9 changes: 5 additions & 4 deletions book/simplecms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,11 @@ that allows you to associate URLs with your :doc:`content <static_content>`
as well as a way to :doc:`structuring content <structuring_content>`, so
users can browse the content in a menu.

In the CMF these features are provided by the :doc:`../bundles/routing`, the
:doc:`../bundles/content` and the :doc:`../bundles/menu`. These bundles complement
each other but are independent, allowing you to choose which ones you want to use,
extend or ignore. However, in some cases, you might just want a simple implementation
In the CMF these features are provided by the
:doc:`../bundles/routing/introduction`, the :doc:`../bundles/content` and the
:doc:`../bundles/menu`. These bundles complement each other but are
independent, allowing you to choose which ones you want to use, extend or
ignore. However, in some cases, you might just want a simple implementation
that gathers all those capabilities into a ready-to-go package. That's exactly
what the :doc:`../bundles/simple_cms` provides.

Expand Down
2 changes: 1 addition & 1 deletion book/static_content.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ 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
(refer to :doc:`../cookbook/creating_cms_using_cmf_and_sonata` for
instructions on that).

Configuration
Expand Down
2 changes: 1 addition & 1 deletion book/structuring_content.rst
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ needed for integration with the backend admin tool

The included administration panels are automatically available but need to
be explicitly put on the dashboard if you want to use them. See
:doc:`../tutorials/creating_cms_using_cmf_and_sonata` for instructions on how
:doc:`../cookbook/creating_cms_using_cmf_and_sonata` for instructions on how
to install SonataDoctrinePhpcrAdminBundle.

Configuration
Expand Down
2 changes: 1 addition & 1 deletion bundles/blog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Notes on this document
Dependencies
------------

* :doc:`CmfRoutingBundle <routing>` is used to manage the routing;
* :doc:`CmfRoutingBundle <routing/introduction>` is used to manage the routing;
* :doc:`CmfRoutingAutoBundle<routing_auto>` is used to manage automatically generate routes;
* :doc:`PHPCR-ODM<phpcr_odm>` is used to persist the bundles documents.

Expand Down
2 changes: 1 addition & 1 deletion bundles/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Bundles
phpcr_odm
media
menu
routing
routing_auto
routing/index
search
simple_cms
doctrine_phpcr_admin
Expand Down
5 changes: 3 additions & 2 deletions bundles/map.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,10 @@

* :doc:`menu`

* **RoutingBundle**
* :doc:`routing/index`

* :doc:`routing`
* :doc:`routing/introduction`
* :doc:`routing/custom_repository`

* **RoutingAutoBundle**

Expand Down
2 changes: 1 addition & 1 deletion bundles/menu.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ provide your own implementations, this bundle also depends on:
* **CmfRoutingBundle** - if you want to generate routes for content objects.
Note that you need to explicitly enable the dynamic router as per default it
is not loaded. See the
:doc:`documentation of the cmf routing bundle <routing>` for more information.
:doc:`documentation of the cmf routing bundle <routing/introduction>` for more information.
* :doc:`PHPCR-ODM <phpcr_odm>` - to load route documents from the content
repository when using the ``PhpcrMenuProvider``.

Expand Down
7 changes: 3 additions & 4 deletions bundles/phpcr_odm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ configuration of the Doctrine ORM and MongoDB bundles.
Setup and Requirements
----------------------

See :doc:`../tutorials/installing_configuring_doctrine_phpcr_odm`
See :doc:`../cookbook/installing_configuring_doctrine_phpcr_odm`

Configuration
-------------
Expand Down Expand Up @@ -87,7 +87,7 @@ PHPCR Session with Jackalope Jackrabbit
"""""""""""""""""""""""""""""""""""""""

The only setup required is to install Apache Jackrabbit (see
:ref:`installing Jackrabbit <tutorials-installing-phpcr-jackrabbit>`).
:ref:`installing Jackrabbit <cookbook-installing-phpcr-jackrabbit>`).

The configuration needs the ``url`` parameter to point to your jackrabbit.
Additionally you can tune some other jackrabbit-specific options, for example
Expand Down Expand Up @@ -411,8 +411,7 @@ A full example looks as follows:
.. tip::

This example also uses different configurations per repository (see the
``repository_id`` attribute). This case is explained in
:doc:`../cookbook/phpcr_odm_custom_documentclass_mapper`.
``repository_id`` attribute).

.. _bundle-phpcr-odm-commands:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ following class provides a simple solution using an ODM Repository.
return a single ``Route``? The Dynamic Router allows us to return many
*candidate* routes, in other words, routes that *might* match the incoming
URL. This is important to enable the possibility of matching *dynamic*
routes, ``/page/{page_id}/edit`` for example. In our example we match the
routes, ``/page/{page_id}/edit`` for example. In our example we match the
given URL exactly and only ever return a single ``Route``.

Replacing the Default CMF Route Provider
Expand Down
8 changes: 8 additions & 0 deletions bundles/routing/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
RoutingBundle
=============

.. toctree::
:maxdepth: 2

introduction
custom_repository
10 changes: 5 additions & 5 deletions bundles/routing.rst → bundles/routing/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ RoutingBundle
=============

The `RoutingBundle`_ integrates dynamic routing into Symfony using
:doc:`../components/routing`.
:doc:`../../components/routing`.

The ``ChainRouter`` is meant to replace the default Symfony Router. All it
does is collect a prioritized list of routers and try to match requests and
Expand Down Expand Up @@ -303,7 +303,7 @@ If ``sonata-project/doctrine-phpcr-admin-bundle`` is added to the
composer.json require section and the SonataDoctrinePhpcrAdminBundle is loaded
in the application kernel, the route documents are exposed in the
SonataDoctrinePhpcrAdminBundle. For instructions on how to configure this
Bundle see :doc:`doctrine_phpcr_admin`.
Bundle see :doc:`../doctrine_phpcr_admin`.

By default, ``use_sonata_admin`` is automatically set based on whether
``SonataDoctrinePhpcrAdminBundle`` is available, but you can explicitly
Expand Down Expand Up @@ -421,15 +421,15 @@ into the chain.
Learn more from the Cookbook
----------------------------

* :doc:`../cookbook/using_a_custom_route_repository`
* :doc:`custom_repository`

Further notes
-------------

For more information on the Routing component of Symfony CMF, please refer to:

* ":doc:`../book/routing`" for an introductory guide on Routing bundle
* :doc:`../components/routing` for most of the actual functionality implementation
* ":doc:`../../book/routing`" for an introductory guide on Routing bundle
* :doc:`../../components/routing` for most of the actual functionality implementation
* Symfony2's `Routing`_ component page

.. _`RoutingBundle`: https://github.com/symfony-cmf/RoutingBundle#readme
Expand Down
13 changes: 7 additions & 6 deletions components/routing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,9 @@ The Component depends on the Symfony2 `Routing`_ component and the
``RouteProviderInterface`` with. We suggest using Doctrine as this
provides an easy way to map classes into a database.

The :doc:`../bundles/routing` provides implementations for everything
needed to get this component running with Doctrine PHPCR-ODM and soon
also the Doctrine ORM.
The :doc:`../bundles/routing/introduction` provides implementations for
everything needed to get this component running with Doctrine PHPCR-ODM
and soon also the Doctrine ORM.

ChainRouter
-----------
Expand Down Expand Up @@ -208,7 +208,7 @@ provider is to provide all routes that could potentially match, but **not** to
do any elaborate matching operations yet - this will be done in the later steps.

The underlying implementation of the ``RouteProviderInterface`` is not in the
scope of this component. The :doc:`RoutingBundle <../bundles/routing>`
scope of this component. The :doc:`RoutingBundle <../bundles/routing/introduction>`
provides a Route Provider for Doctrine PHPCR ODM.

To create and register your own Route Provider, create a class extending
Expand Down Expand Up @@ -361,7 +361,7 @@ Router in the chain or to another Route object provided by the Route.
Notice that the actual redirection logic is not handled by the bundle. You
should implement your own logic to handle the redirection. For an example of
implementing that redirection under the full Symfony2 stack, refer to
:doc:`the RoutingBundle <../bundles/routing>`.
:doc:`the RoutingBundle <../bundles/routing/introduction>`.

Generating URLs
~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -399,7 +399,8 @@ Symfony2 integration
As mentioned before, this component was designed to use independently of the
Symfony2 framework. However, if you wish to use it as part of your Symfony
CMF project, an integration bundle is also available. Read more about the
RoutingBundle in ":doc:`../bundles/routing`" in the bundles documentation.
RoutingBundle in ":doc:`../bundles/routing/introduction`" in the bundles
documentation.

.. _`Install it via Composer`: http://symfony.com/doc/current/components/using_components.html
.. _`Packagist`: https://packagist.org/packages/symfony-cmf/routing
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ using the CMF as well as `SonataAdminBundle`_ and
Preconditions
-------------

* :doc:`installing_cmf_core`
* :doc:`editions/cmf_core`
* `Symfony SecurityBundle`_ (required by the SonataAdminBundle default templates)

.. caution::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ solutions like CouchDB or Cassandra is entirely possible. Again, switching the
persistence solution would require no code changes as the business logic is
only bound to the PHPCR interfaces.

Please see :doc:`installing_configuring_doctrine_phpcr_odm` for more details
Please see :doc:`../installing_configuring_doctrine_phpcr_odm` for more details
on the available PHPCR implementations and their requirements and how to setup
Symfony2 with one of them.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ This tutorial is aimed at the experienced user who wants to learn more
about the details of the Symfony CMF. If this is your first encounter with
the Symfony CMF it would be a good idea to start with:

* :doc:`../book/installation` page for instructions on
* :doc:`../../book/installation` page for instructions on
how to quickly install the CMF (recommended for development)
* :doc:`../cookbook/installing_cmf_sandbox` for instructions on how to install
* :doc:`cmf_sandbox` for instructions on how to install
a demonstration sandbox.

.. index:: RoutingBundle, CoreBundle, MenuBundle, ContentBundle, SonataBlockBundle, KnpMenuBundle, install
Expand All @@ -23,7 +23,7 @@ Preconditions
-------------

* `Installation of Symfony2`_ (2.1.x)
* :doc:`installing_configuring_doctrine_phpcr_odm`
* :doc:`../installing_configuring_doctrine_phpcr_odm`

Installation
------------
Expand Down Expand Up @@ -93,7 +93,7 @@ Minimum Configuration
These steps are needed to ensure your ``AppKernel`` still runs.

If you haven't done so already, make sure you have followed these steps from
:doc:`installing_configuring_doctrine_phpcr_odm`:
:doc:`../installing_configuring_doctrine_phpcr_odm`:

* Initialize ``DoctrinePHPCRBundle`` in ``app/AppKernel.php``
* Ensure there is a ``doctrine_phpcr:`` section in ``app/config/config.yml``
Expand Down Expand Up @@ -129,12 +129,12 @@ which by default is not loaded, you will need to enable it as follows:
enabled: true

You might want to configure more on the dynamic router, i.e. to automatically
choose controllers based on content. See :doc:`../bundles/routing` for
details.
choose controllers based on content. See
:doc:`../../bundles/routing/introduction` for details.

For now this is the only configuration we need. Mastering the configuration of
the different bundles will be handled in further tutorials. If you're looking
the different bundles will be handled in further articles. If you're looking
for the configuration of a specific bundle take a look at the corresponding
:doc:`bundles entry <../index>`.
:doc:`bundles reference <../../reference/index>`.

.. _`Installation of Symfony2`: http://symfony.com/doc/2.1/book/installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ While it can be used as such, this sandbox does not intend to be a development
platform. If you are looking for installation instructions for a development
setup, please refer to:

* :doc:`../book/installation` page for instructions on
* :doc:`../../book/installation` page for instructions on
how to quickly install the CMF (recommended for development)
* :doc:`../tutorials/installing_cmf_core` for step-by-step installation and
* :doc:`cmf_core` for step-by-step installation and
configuration details (if you want to know all the details)

.. index:: sandbox, install
Expand All @@ -28,7 +28,7 @@ As Symfony CMF Sandbox is based on Symfony2, you should make sure you meet the
also needed to follow the installation steps listed below.

For the PHPCR repository requirements, see
:ref:`PHPCR-ODM requirements <tutorials-phpcr-odm-requirements>`
:ref:`PHPCR-ODM requirements <cookbook-phpcr-odm-requirements>`

Installation
------------
Expand Down
11 changes: 8 additions & 3 deletions cookbook/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,13 @@ The Cookbook
.. toctree::
:hidden:

phpcr_odm_custom_documentclass_mapper
using_a_custom_route_repository
installing_cmf_sandbox
database/choosing_storage_layer
editions/cmf_sandbox
editions/cmf_core
installing_configuring_doctrine_phpcr_odm
installing_configuring_inline_editing
creating_cms_using_cmf_and_sonata
using_blockbundle_and_contentbundle
handling_multilang_documents

.. include:: map.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Finally for information about PHPCR see the `official PHPCR website`_.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and this is about installation as well

.. index:: PHPCR, ODM

.. _tutorials-phpcr-odm-requirements:
.. _cookbook-phpcr-odm-requirements:

Requirements
------------
Expand Down Expand Up @@ -292,7 +292,7 @@ Setting up the Content Repository

.. index:: Jackrabbit

.. _tutorials-installing-phpcr-jackrabbit:
.. _cookbook-installing-phpcr-jackrabbit:

**Jackalope Jackrabbit**

Expand All @@ -315,7 +315,7 @@ Jackalope wiki.

.. index:: Doctrine, DBAL, RDBMS

.. _tutorials-installing-phpcr-doctrinedbal:
.. _cookbook-installing-phpcr-doctrinedbal:

**Jackalope Doctrine DBAL**

Expand All @@ -332,7 +332,7 @@ For more information on how to configure Doctrine DBAL with Symfony2, see the

.. index:: Midgard, RDBMS

.. _tutorials-installing-phpcr-midgard:
.. _cookbook-installing-phpcr-midgard:

**Midgard**

Expand Down
Loading