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

[WIP] Revisiting structure part 1 #551

Merged
merged 5 commits into from
Aug 25, 2014
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
4 changes: 2 additions & 2 deletions book/handling_multilang.rst
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,8 @@ Sonata PHPCR-ODM Admin

Using sonata admin is one way to make your content editable. A book
chapter on sonata admin is planned. Meanwhile, read
:doc:`Sonata Admin <../cookbook/creating_a_cms/sonata-admin>` in the
"Creating a CMS" tutorial.
:doc:`Sonata Admin <../tutorial/sonata-admin>` in the "Creating a CMS"
tutorial.

The first step is to configure sonata admin. You should place the
LuneticsLocaleBundle language switcher in the ``topnav`` bar. To do this,
Expand Down
2 changes: 1 addition & 1 deletion book/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,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:`../cookbook/creating_a_cms/sonata-admin`. However, if all you want
: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
editing, then you can use the SimpleCmsBundle ``page`` migrator. For example,
to add a page called "Testing", creating a file called
Expand Down
2 changes: 1 addition & 1 deletion book/static_content.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ SonataDoctrinePHPCRAdminBundle_, a back office generation tool.
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:`../cookbook/creating_a_cms/sonata-admin` for
(refer to :doc:`../tutorial/sonata-admin` for
instructions on that).

Configuration
Expand Down
4 changes: 2 additions & 2 deletions book/structuring_content.rst
Original file line number Diff line number Diff line change
Expand Up @@ -164,8 +164,8 @@ SonataDoctrinePHPCRAdminBundle_.

The included administration panels are automatically available but need to
be explicitly put on the dashboard if you want to use them. See
:doc:`../cookbook/creating_a_cms/sonata-admin` for instructions on how
to install SonataDoctrinePHPCRAdminBundle.
:doc:`../tutorial/sonata-admin` for instructions on how to install
SonataDoctrinePHPCRAdminBundle.

Configuration
~~~~~~~~~~~~~
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
BlockBundle Configuration
=========================
Configuration Reference
=======================

The BlockBundle provides integration with SonataBlockBundle and can be
configured under the ``cmf_block`` key in your application configuration. When
using XML, you can use the ``http://cmf.symfony.com/schema/dic/block``
namespace.
The BlockBundle can be configured under the ``cmf_block`` key in your
application configuration. When using XML, you can use the
``http://cmf.symfony.com/schema/dic/block`` namespace.

The BlockBundle *automatically* changes some defaults and adds configuration
to the SonataBlockBundle to make the integration work seamlessly. See the
Expand Down Expand Up @@ -114,7 +113,7 @@ is the following configuration:
enabled
"""""""

.. include:: partials/persistence_phpcr_enabled.rst.inc
.. include:: ../_partials/persistence_phpcr_enabled.rst.inc

block_basepath
""""""""""""""
Expand All @@ -123,13 +122,13 @@ block_basepath

The basepath for blocks in the PHPCR tree.

If the :doc:`CoreBundle <../../bundles/core/index>` is registered, this will default to
If the :doc:`CoreBundle <../core/introduction>` is registered, this will default to
the value of ``%cmf_core.persistence.phpcr.basepath%/content``.

manager_name
""""""""""""

.. include:: partials/persistence_phpcr_manager_name.rst.inc
.. include:: ../_partials/persistence_phpcr_manager_name.rst.inc

string_document_class
"""""""""""""""""""""
Expand Down Expand Up @@ -192,7 +191,7 @@ use_sonata_admin
If ``true``, the admin classes are activated. If set to ``auto``, they are
activated only if the SonataPhpcrAdminBundle is present.

If the :doc:`CoreBundle <../../bundles/core/index>` is registered, this will default to the value
If the :doc:`CoreBundle <../core/introduction>` is registered, this will default to the value
of ``cmf_core.persistence.phpcr.use_sonata_admin``.

string_admin_class
Expand Down Expand Up @@ -417,3 +416,4 @@ token
A unique secret key. A random one is generated by default.

.. _`SonataCacheBundle`: https://github.com/sonata-project/SonataCacheBundle

1 change: 1 addition & 0 deletions bundles/block/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ BlockBundle
create_your_own_blocks
cache
relation_to_sonata_block_bundle
configuration
1 change: 1 addition & 0 deletions bundles/block/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,7 @@ Read on
* :doc:`create_your_own_blocks`
* :doc:`cache`
* :doc:`relation_to_sonata_block_bundle`
* :doc:`configuration`

.. _`symfony-cmf/block-bundle`: https://packagist.org/packages/symfony-cmf/block-bundle
.. _`with composer`: http://getcomposer.org
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
ContentBundle configuration
===========================
Configuration Reference
=======================

The ContentBundle provides a document and controller for static content and
can be configured under the ``cmf_content`` key in your application
configuration. When using XML, you can use the
The ContentBundle can be configured under the ``cmf_content`` key in your
application configuration. When using XML, you can use the
``http://cmf.symfony.com/schema/dic/content`` namespace.

Configuration
Expand Down Expand Up @@ -74,7 +73,7 @@ is the following configuration:
enabled
*******

.. include:: partials/persistence_phpcr_enabled.rst.inc
.. include:: ../_partials/persistence_phpcr_enabled.rst.inc

admin_class
***********
Expand Down Expand Up @@ -106,5 +105,5 @@ If ``true``, the admin classes for SimpleCmsBundle pages are activated. If set
to ``auto``, the admin services are activated only if the
SonataPhpcrAdminBundle is present.

If the :doc:`CoreBundle <../../bundles/core/index>` is registered, this will
If the :doc:`CoreBundle <../core/introduction>` is registered, this will
default to the value of ``cmf_core.persistence.phpcr.use_sonata_admin``.
Original file line number Diff line number Diff line change
@@ -1,24 +1,15 @@
.. index::
single: Tutorial, REST
single: ContentBundle
single: ContentBundle; Rest

Exposing Content via REST
=========================

Many applications need to expose content via REST APIs to partners or to
enable integration into other applications. As the CMF is build on top
of Symfony2, it's possible to leverage many of the available bundles to
provide a REST API for content stored in the CMF. This cookbook will
detail how to provide a read API using the following bundles:

* :doc:`Cmf ContentBundle <../bundles/content/index>`;
* `FOSRestBundle`_;
* `JMSSerializerBundle`_.

It is assumed that you have:

* A working knowledge of the Symfony2 CMF framework;
* An application with the ContentBundle setup.
provide a REST API for content stored in the CMF. This guide will
detail how to provide a read API for your content using the following bundles
`FOSRestBundle`_ and `JMSSerializerBundle`_.

Installation
------------
Expand All @@ -31,9 +22,9 @@ to generate the REST output. The best choice is the JMSSerializerBundle:
.. code-block:: javascript

{
..
...
"require": {
..
...
"friendsofsymfony/rest-bundle": "1.*",
"jms/serializer-bundle": "0.13.*",
}
Expand Down
2 changes: 2 additions & 0 deletions bundles/content/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@ ContentBundle
:maxdepth: 2

introduction
configuration
exposing_content_via_rest
6 changes: 6 additions & 0 deletions bundles/content/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -226,5 +226,11 @@ removing static content from the admin panel. To enable the admin, use the
also provides :ref:`several useful extensions <bundles-core-persistence>` for
SonataAdminBundle.

Read On
-------

* :doc:`configuration`
* :doc:`exposing_content_via_rest`

.. _`with composer`: http://getcomposer.org
.. _`symfony-cmf/content-bundle`: https://packagist.org/packages/symfony-cmf/content-bundle
74 changes: 37 additions & 37 deletions reference/configuration/core.rst → bundles/core/configuration.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
CoreBundle Configuration
========================
Configuration Reference
=======================

The CoreBundle provides infrastructure for other CMF bundles and can be configured
under the ``cmf_core`` key in your application configuration. When using
XML, you can use the ``http://cmf.symfony.com/schema/dic/core`` namespace.
The CoreBundle can be configured under the ``cmf_core`` key in your application
configuration. When using XML, you can use the
``http://cmf.symfony.com/schema/dic/core`` namespace.

Configuration
-------------
Expand Down Expand Up @@ -117,19 +117,19 @@ is the following configuration:
enabled
"""""""

.. include:: partials/persistence_phpcr_enabled.rst.inc
.. include:: ../_partials/persistence_phpcr_enabled.rst.inc

Enabling this setting will also automatically enable the equivalent setting in the following Bundles:

* :doc:`BlockBundle <../../bundles/block/introduction>`
* :doc:`ContentBundle <../../bundles/content/introduction>`
* :doc:`CreateBundle <../../bundles/create/introduction>`
* :doc:`MediaBundle <../../bundles/media/introduction>`
* :doc:`MenuBundle <../..//bundles/menu/index>`
* :doc:`RoutingBundle <../../bundles/routing/introduction>`
* :doc:`SearchBundle <../../bundles/search/introduction>`
* :doc:`SimpleCmsBundle <../../bundles/simple_cms/introduction>`
* :doc:`TreeBrowserCmsBundle <../../bundles/tree_browser/introduction>`
* :doc:`BlockBundle <../block/introduction>`
* :doc:`ContentBundle <../content/introduction>`
* :doc:`CreateBundle <../create/introduction>`
* :doc:`MediaBundle <../media/introduction>`
* :doc:`MenuBundle <../menu/introduction>`
* :doc:`RoutingBundle <../routing/introduction>`
* :doc:`SearchBundle <../search/introduction>`
* :doc:`SimpleCmsBundle <../simple_cms/introduction>`
* :doc:`TreeBrowserCmsBundle <../tree_browser/introduction>`

basepath
""""""""
Expand All @@ -140,13 +140,13 @@ The basepath for CMS documents in the PHPCR tree.

Enabling this setting will also automatically enable the equivalent settings in the following Bundles:

* :doc:`BlockBundle <../../bundles/block/introduction>`
* :doc:`ContentBundle <../../bundles/content/introduction>`
* :doc:`MediaBundle <../../bundles/media/introduction>`
* :doc:`MenuBundle <../..//bundles/menu/index>`
* :doc:`RoutingBundle <../../bundles/routing/introduction>`
* :doc:`SearchBundle <../../bundles/search/introduction>`
* :doc:`SimpleCmsBundle <../../bundles/simple_cms/introduction>`
* :doc:`BlockBundle <../block/introduction>`
* :doc:`ContentBundle <../content/introduction>`
* :doc:`MediaBundle <../media/introduction>`
* :doc:`MenuBundle <../menu/introduction>`
* :doc:`RoutingBundle <../routing/introduction>`
* :doc:`SearchBundle <../search/introduction>`
* :doc:`SimpleCmsBundle <../simple_cms/introduction>`

manager_registry
""""""""""""""""
Expand All @@ -155,8 +155,8 @@ manager_registry

Enabling this setting will also automatically enable the equivalent settings in the following Bundles:

* :doc:`SearchBundle <../../bundles/search/introduction>`
* :doc:`SimpleCmsBundle <../../bundles/simple_cms/introduction>`
* :doc:`SearchBundle <../search/introduction>`
* :doc:`SimpleCmsBundle <../simple_cms/introduction>`

manager_name
""""""""""""
Expand All @@ -168,12 +168,12 @@ retrieve the default manager.<persistence>

Enabling this setting will also automatically enable the equivalent setting in the following Bundles:

* :doc:`BlockBundle <../../bundles/block/introduction>`
* :doc:`MediaBundle <../../bundles/media/introduction>`
* :doc:`MenuBundle <../..//bundles/menu/index>`
* :doc:`RoutingBundle <../../bundles/routing/introduction>`
* :doc:`SearchBundle <../../bundles/search/introduction>`
* :doc:`SimpleCmsBundle <../../bundles/simple_cms/introduction>`
* :doc:`BlockBundle <../block/introduction>`
* :doc:`MediaBundle <../media/introduction>`
* :doc:`MenuBundle <../menu/introduction>`
* :doc:`RoutingBundle <../routing/introduction>`
* :doc:`SearchBundle <../search/introduction>`
* :doc:`SimpleCmsBundle <../simple_cms/introduction>`

use_sonata_admin
""""""""""""""""
Expand All @@ -186,11 +186,11 @@ SonataPhpcrAdminBundle is present.

Enabling this setting will also automatically enable the equivalent setting in the following Bundles:

* :doc:`BlockBundle <../../bundles/block/introduction>`
* :doc:`ContentBundle <../../bundles/content/introduction>`
* :doc:`MenuBundle <../..//bundles/menu/index>`
* :doc:`RoutingBundle <../../bundles/routing/introduction>`
* :doc:`SimpleCmsBundle <../../bundles/simple_cms/introduction>`
* :doc:`BlockBundle <../block/introduction>`
* :doc:`ContentBundle <../content/introduction>`
* :doc:`MenuBundle <../menu/introduction>`
* :doc:`RoutingBundle <../routing/introduction>`
* :doc:`SimpleCmsBundle <../simple_cms/introduction>`

translation_strategy
""""""""""""""""""""
Expand All @@ -214,8 +214,8 @@ If multilang is enabled, the ``TranslatableExtension`` for
``SonataAdminBundle`` is enabled and the locales will be configured on all CMF
bundles that use this configuration:

* :doc:`RoutingBundle <../../bundles/routing/introduction>`
* :doc:`SimpleCmsBundle <../../bundles/simple_cms/introduction>`
* :doc:`RoutingBundle <../routing/introduction>`
* :doc:`SimpleCmsBundle <../simple_cms/introduction>`

.. configuration-block::

Expand Down
1 change: 1 addition & 0 deletions bundles/core/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ CoreBundle
templating
persistence
forms
configuration
1 change: 1 addition & 0 deletions bundles/core/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Sections
* :doc:`dependency_injection_tags`
* :doc:`templating`
* :doc:`persistence`
* :doc:`configuration`

.. _`symfony-cmf/core-bundle`: https://packagist.org/packages/symfony-cmf/core-bundle
.. _`with composer`: http://getcomposer.org
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
CreateBundle configuration
==========================
Configuration Reference
=======================

The CreateBundle provides front-end editing based on create.js and CreatePHP.
It can be configured under the ``cmf_create`` key in your application
configuration. When using XML you should use the
The CreateBundle can be configured under the ``cmf_create`` key in your
application configuration. When using XML you should use the
``http://cmf.symfony.com/schema/dic/create`` namespace.

.. note::
Expand Down Expand Up @@ -136,18 +135,18 @@ persistence for this bundle to work.
enabled
"""""""

.. include:: partials/persistence_phpcr_enabled.rst.inc
.. include:: ../_partials/persistence_phpcr_enabled.rst.inc

manager_name
""""""""""""

.. include:: partials/persistence_phpcr_manager_name.rst.inc
.. include:: ../_partials/persistence_phpcr_manager_name.rst.inc

image
"""""

These settings are only used with the optional hallo editor. The default
CKEditor uses the :doc:`ELfinder plugin <../../bundles/media/adapters/elfinder>`
CKEditor uses the :doc:`ELfinder plugin <../media/adapters/elfinder>`
provided by the MediaBundle.

If you need different image handling, you can either overwrite
Expand Down
1 change: 1 addition & 0 deletions bundles/create/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ CreateBundle
:maxdepth: 2

introduction
configuration
other-editors
developing-hallo
7 changes: 7 additions & 0 deletions bundles/create/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -513,6 +513,13 @@ configure the ``cmf_create.object_mapper_service_id``.
CreatePHP would support specific mappers per RDFa type. If you need that, dig
into the CreatePHP and CreateBundle and do a pull request to enable this feature.

Read On
-------

* :doc:`developing-hallo`
* :doc:`other-editors`
* :doc:`configuration`


.. _`create.js`: http://createjs.org
.. _`hallo.js`: http://hallojs.org
Expand Down
Loading