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

Commit 3fb34e8

Browse files
wouterjwouterj
committed
Merge branch 'master' into dev
Conflicts: bundles/create/introduction.rst
2 parents b16c241 + 3ac840c commit 3fb34e8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+365
-304
lines changed

‎book/handling_multilang.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,8 @@ Sonata PHPCR-ODM Admin
152152

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

158158
The first step is to configure sonata admin. You should place the
159159
LuneticsLocaleBundle language switcher in the ``topnav`` bar. To do this,

‎book/installation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ Adding new pages
215215

216216
Symfony CMF SE does not provide any admin tools to create new pages. If you
217217
are interested in adding an admin UI one solution can be found in
218-
:doc:`../cookbook/creating_a_cms/sonata-admin`. However, if all you want
218+
:doc:`../tutorial/sonata-admin`. However, if all you want
219219
is a simple way to add new pages that you can then edit via the inline
220220
editing, then you can use the SimpleCmsBundle ``page`` migrator. For example,
221221
to add a page called "Testing", creating a file called

‎book/static_content.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ SonataDoctrinePHPCRAdminBundle_, a back office generation tool.
6060
In ContentBundle, the required administration panels are already declared in
6161
the ``Admin`` folder and configured in ``Resources/config/admin.xml``, and
6262
will automatically be loaded if you install the SonataDoctrinePHPCRAdminBundle
63-
(refer to :doc:`../cookbook/creating_a_cms/sonata-admin` for
63+
(refer to :doc:`../tutorial/sonata-admin` for
6464
instructions on that).
6565

6666
Configuration

‎book/structuring_content.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,8 @@ SonataDoctrinePHPCRAdminBundle_.
164164

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

170170
Configuration
171171
~~~~~~~~~~~~~

‎reference/configuration/partials/persistence_phpcr_enabled.rst.inc renamed to ‎bundles/_partials/persistence_phpcr_enabled.rst.inc

File renamed without changes.

‎reference/configuration/partials/persistence_phpcr_manager_name.rst.inc renamed to ‎bundles/_partials/persistence_phpcr_manager_name.rst.inc

File renamed without changes.

‎reference/configuration/partials/persistence_phpcr_sonata_admin_enabled.rst.inc renamed to ‎bundles/_partials/persistence_phpcr_sonata_admin_enabled.rst.inc

File renamed without changes.

‎reference/configuration/block.rst renamed to ‎bundles/block/configuration.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
BlockBundle Configuration
2-
=========================
1+
Configuration Reference
2+
=======================
33

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

98
The BlockBundle *automatically* changes some defaults and adds configuration
109
to the SonataBlockBundle to make the integration work seamlessly. See the
@@ -114,7 +113,7 @@ is the following configuration:
114113
enabled
115114
"""""""
116115

117-
.. include:: partials/persistence_phpcr_enabled.rst.inc
116+
.. include:: ../_partials/persistence_phpcr_enabled.rst.inc
118117

119118
block_basepath
120119
""""""""""""""
@@ -123,13 +122,13 @@ block_basepath
123122

124123
The basepath for blocks in the PHPCR tree.
125124

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

129128
manager_name
130129
""""""""""""
131130

132-
.. include:: partials/persistence_phpcr_manager_name.rst.inc
131+
.. include:: ../_partials/persistence_phpcr_manager_name.rst.inc
133132

134133
string_document_class
135134
"""""""""""""""""""""
@@ -192,7 +191,7 @@ use_sonata_admin
192191
If ``true``, the admin classes are activated. If set to ``auto``, they are
193192
activated only if the SonataPhpcrAdminBundle is present.
194193

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

198197
string_admin_class
@@ -417,3 +416,4 @@ token
417416
A unique secret key. A random one is generated by default.
418417

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

‎bundles/block/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@ BlockBundle
99
create_your_own_blocks
1010
cache
1111
relation_to_sonata_block_bundle
12+
configuration

‎bundles/block/introduction.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -390,6 +390,7 @@ Read on
390390
* :doc:`create_your_own_blocks`
391391
* :doc:`cache`
392392
* :doc:`relation_to_sonata_block_bundle`
393+
* :doc:`configuration`
393394

394395
.. _`symfony-cmf/block-bundle`: https://packagist.org/packages/symfony-cmf/block-bundle
395396
.. _`with composer`: http://getcomposer.org

‎reference/configuration/content.rst renamed to ‎bundles/content/configuration.rst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
ContentBundle configuration
2-
===========================
1+
Configuration Reference
2+
=======================
33

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

98
Configuration
@@ -74,7 +73,7 @@ is the following configuration:
7473
enabled
7574
*******
7675

77-
.. include:: partials/persistence_phpcr_enabled.rst.inc
76+
.. include:: ../_partials/persistence_phpcr_enabled.rst.inc
7877

7978
admin_class
8079
***********
@@ -106,5 +105,5 @@ If ``true``, the admin classes for SimpleCmsBundle pages are activated. If set
106105
to ``auto``, the admin services are activated only if the
107106
SonataPhpcrAdminBundle is present.
108107

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

‎cookbook/exposing_content_via_rest.rst renamed to ‎bundles/content/exposing_content_via_rest.rst

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,15 @@
11
.. index::
2-
single: Tutorial, REST
3-
single: ContentBundle
2+
single: ContentBundle; Rest
43

54
Exposing Content via REST
65
=========================
76

87
Many applications need to expose content via REST APIs to partners or to
98
enable integration into other applications. As the CMF is build on top
109
of Symfony2, it's possible to leverage many of the available bundles to
11-
provide a REST API for content stored in the CMF. This cookbook will
12-
detail how to provide a read API using the following bundles:
13-
14-
* :doc:`Cmf ContentBundle <../bundles/content/index>`;
15-
* `FOSRestBundle`_;
16-
* `JMSSerializerBundle`_.
17-
18-
It is assumed that you have:
19-
20-
* A working knowledge of the Symfony2 CMF framework;
21-
* An application with the ContentBundle setup.
10+
provide a REST API for content stored in the CMF. This guide will
11+
detail how to provide a read API for your content using the following bundles
12+
`FOSRestBundle`_ and `JMSSerializerBundle`_.
2213

2314
Installation
2415
------------
@@ -31,9 +22,9 @@ to generate the REST output. The best choice is the JMSSerializerBundle:
3122
.. code-block:: javascript
3223
3324
{
34-
..
25+
...
3526
"require": {
36-
..
27+
...
3728
"friendsofsymfony/rest-bundle": "1.*",
3829
"jms/serializer-bundle": "0.13.*",
3930
}

‎bundles/content/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@ ContentBundle
55
:maxdepth: 2
66

77
introduction
8+
configuration
9+
exposing_content_via_rest

‎bundles/content/introduction.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,5 +226,11 @@ removing static content from the admin panel. To enable the admin, use the
226226
also provides :ref:`several useful extensions <bundles-core-persistence>` for
227227
SonataAdminBundle.
228228

229+
Read On
230+
-------
231+
232+
* :doc:`configuration`
233+
* :doc:`exposing_content_via_rest`
234+
229235
.. _`with composer`: http://getcomposer.org
230236
.. _`symfony-cmf/content-bundle`: https://packagist.org/packages/symfony-cmf/content-bundle

‎reference/configuration/core.rst renamed to ‎bundles/core/configuration.rst

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
CoreBundle Configuration
2-
========================
1+
Configuration Reference
2+
=======================
33

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

88
Configuration
99
-------------
@@ -117,19 +117,19 @@ is the following configuration:
117117
enabled
118118
"""""""
119119

120-
.. include:: partials/persistence_phpcr_enabled.rst.inc
120+
.. include:: ../_partials/persistence_phpcr_enabled.rst.inc
121121

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

124-
* :doc:`BlockBundle <../../bundles/block/introduction>`
125-
* :doc:`ContentBundle <../../bundles/content/introduction>`
126-
* :doc:`CreateBundle <../../bundles/create/introduction>`
127-
* :doc:`MediaBundle <../../bundles/media/introduction>`
128-
* :doc:`MenuBundle <../..//bundles/menu/index>`
129-
* :doc:`RoutingBundle <../../bundles/routing/introduction>`
130-
* :doc:`SearchBundle <../../bundles/search/introduction>`
131-
* :doc:`SimpleCmsBundle <../../bundles/simple_cms/introduction>`
132-
* :doc:`TreeBrowserCmsBundle <../../bundles/tree_browser/introduction>`
124+
* :doc:`BlockBundle <../block/introduction>`
125+
* :doc:`ContentBundle <../content/introduction>`
126+
* :doc:`CreateBundle <../create/introduction>`
127+
* :doc:`MediaBundle <../media/introduction>`
128+
* :doc:`MenuBundle <../menu/introduction>`
129+
* :doc:`RoutingBundle <../routing/introduction>`
130+
* :doc:`SearchBundle <../search/introduction>`
131+
* :doc:`SimpleCmsBundle <../simple_cms/introduction>`
132+
* :doc:`TreeBrowserCmsBundle <../tree_browser/introduction>`
133133

134134
basepath
135135
""""""""
@@ -140,13 +140,13 @@ The basepath for CMS documents in the PHPCR tree.
140140

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

143-
* :doc:`BlockBundle <../../bundles/block/introduction>`
144-
* :doc:`ContentBundle <../../bundles/content/introduction>`
145-
* :doc:`MediaBundle <../../bundles/media/introduction>`
146-
* :doc:`MenuBundle <../..//bundles/menu/index>`
147-
* :doc:`RoutingBundle <../../bundles/routing/introduction>`
148-
* :doc:`SearchBundle <../../bundles/search/introduction>`
149-
* :doc:`SimpleCmsBundle <../../bundles/simple_cms/introduction>`
143+
* :doc:`BlockBundle <../block/introduction>`
144+
* :doc:`ContentBundle <../content/introduction>`
145+
* :doc:`MediaBundle <../media/introduction>`
146+
* :doc:`MenuBundle <../menu/introduction>`
147+
* :doc:`RoutingBundle <../routing/introduction>`
148+
* :doc:`SearchBundle <../search/introduction>`
149+
* :doc:`SimpleCmsBundle <../simple_cms/introduction>`
150150

151151
manager_registry
152152
""""""""""""""""
@@ -155,8 +155,8 @@ manager_registry
155155

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

158-
* :doc:`SearchBundle <../../bundles/search/introduction>`
159-
* :doc:`SimpleCmsBundle <../../bundles/simple_cms/introduction>`
158+
* :doc:`SearchBundle <../search/introduction>`
159+
* :doc:`SimpleCmsBundle <../simple_cms/introduction>`
160160

161161
manager_name
162162
""""""""""""
@@ -168,12 +168,12 @@ retrieve the default manager.<persistence>
168168

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

171-
* :doc:`BlockBundle <../../bundles/block/introduction>`
172-
* :doc:`MediaBundle <../../bundles/media/introduction>`
173-
* :doc:`MenuBundle <../..//bundles/menu/index>`
174-
* :doc:`RoutingBundle <../../bundles/routing/introduction>`
175-
* :doc:`SearchBundle <../../bundles/search/introduction>`
176-
* :doc:`SimpleCmsBundle <../../bundles/simple_cms/introduction>`
171+
* :doc:`BlockBundle <../block/introduction>`
172+
* :doc:`MediaBundle <../media/introduction>`
173+
* :doc:`MenuBundle <../menu/introduction>`
174+
* :doc:`RoutingBundle <../routing/introduction>`
175+
* :doc:`SearchBundle <../search/introduction>`
176+
* :doc:`SimpleCmsBundle <../simple_cms/introduction>`
177177

178178
use_sonata_admin
179179
""""""""""""""""
@@ -186,11 +186,11 @@ SonataPhpcrAdminBundle is present.
186186

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

189-
* :doc:`BlockBundle <../../bundles/block/introduction>`
190-
* :doc:`ContentBundle <../../bundles/content/introduction>`
191-
* :doc:`MenuBundle <../..//bundles/menu/index>`
192-
* :doc:`RoutingBundle <../../bundles/routing/introduction>`
193-
* :doc:`SimpleCmsBundle <../../bundles/simple_cms/introduction>`
189+
* :doc:`BlockBundle <../block/introduction>`
190+
* :doc:`ContentBundle <../content/introduction>`
191+
* :doc:`MenuBundle <../menu/introduction>`
192+
* :doc:`RoutingBundle <../routing/introduction>`
193+
* :doc:`SimpleCmsBundle <../simple_cms/introduction>`
194194

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

217-
* :doc:`RoutingBundle <../../bundles/routing/introduction>`
218-
* :doc:`SimpleCmsBundle <../../bundles/simple_cms/introduction>`
217+
* :doc:`RoutingBundle <../routing/introduction>`
218+
* :doc:`SimpleCmsBundle <../simple_cms/introduction>`
219219

220220
.. configuration-block::
221221

‎bundles/core/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@ CoreBundle
1010
templating
1111
persistence
1212
forms
13+
configuration

‎bundles/core/introduction.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Sections
3030
* :doc:`dependency_injection_tags`
3131
* :doc:`templating`
3232
* :doc:`persistence`
33+
* :doc:`configuration`
3334

3435
.. _`symfony-cmf/core-bundle`: https://packagist.org/packages/symfony-cmf/core-bundle
3536
.. _`with composer`: http://getcomposer.org

‎reference/configuration/create.rst renamed to ‎bundles/create/configuration.rst

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
CreateBundle configuration
2-
==========================
1+
Configuration Reference
2+
=======================
33

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

98
.. note::
@@ -139,18 +138,18 @@ persistence for this bundle to work.
139138
enabled
140139
"""""""
141140

142-
.. include:: partials/persistence_phpcr_enabled.rst.inc
141+
.. include:: ../_partials/persistence_phpcr_enabled.rst.inc
143142

144143
manager_name
145144
""""""""""""
146145

147-
.. include:: partials/persistence_phpcr_manager_name.rst.inc
146+
.. include:: ../_partials/persistence_phpcr_manager_name.rst.inc
148147

149148
image
150149
"""""
151150

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

156155
If you need different image handling, you can either overwrite

‎bundles/create/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,6 @@ CreateBundle
55
:maxdepth: 2
66

77
introduction
8+
configuration
89
other-editors
910
developing-hallo

‎bundles/create/introduction.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -579,6 +579,13 @@ and implement your logic in the workflows run method.
579579

580580
Currently the bundle only supports delete workflows but that will change in the future.
581581

582+
Read On
583+
-------
584+
585+
* :doc:`developing-hallo`
586+
* :doc:`other-editors`
587+
* :doc:`configuration`
588+
582589
.. _`create.js`: http://createjs.org
583590
.. _`hallo.js`: http://hallojs.org
584591
.. _`CKEditor`: http://ckeditor.com/

0 commit comments

Comments
 (0)