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

Commit 0d6c932

Browse files
committed
Merged reference into the bundle docs
1 parent b496e0a commit 0d6c932

37 files changed

+206
-152
lines changed

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``.

bundles/content/index.rst

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

77
introduction
8+
configuration

bundles/content/introduction.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,5 +226,10 @@ 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+
229234
.. _`with composer`: http://getcomposer.org
230235
.. _`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::
@@ -136,18 +135,18 @@ persistence for this bundle to work.
136135
enabled
137136
"""""""
138137

139-
.. include:: partials/persistence_phpcr_enabled.rst.inc
138+
.. include:: ../_partials/persistence_phpcr_enabled.rst.inc
140139

141140
manager_name
142141
""""""""""""
143142

144-
.. include:: partials/persistence_phpcr_manager_name.rst.inc
143+
.. include:: ../_partials/persistence_phpcr_manager_name.rst.inc
145144

146145
image
147146
"""""
148147

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

153152
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
@@ -513,6 +513,13 @@ configure the ``cmf_create.object_mapper_service_id``.
513513
CreatePHP would support specific mappers per RDFa type. If you need that, dig
514514
into the CreatePHP and CreateBundle and do a pull request to enable this feature.
515515

516+
Read On
517+
-------
518+
519+
* :doc:`developing-hallo`
520+
* :doc:`other-editors`
521+
* :doc:`configuration`
522+
516523

517524
.. _`create.js`: http://createjs.org
518525
.. _`hallo.js`: http://hallojs.org

bundles/map.rst.inc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ library or they introduce a complete new concept.
1111
* :doc:`block/create_your_own_blocks`
1212
* :doc:`block/cache`
1313
* :doc:`block/relation_to_sonata_block_bundle`
14+
* :doc:`block/configuration`
1415

1516
* :doc:`core/index`
1617

@@ -20,18 +21,21 @@ library or they introduce a complete new concept.
2021
* :doc:`core/templating`
2122
* :doc:`core/persistence`
2223
* :doc:`core/forms`
24+
* :doc:`core/configuration`
2325

2426
* :doc:`create/index`
2527

2628
* :doc:`create/introduction`
2729
* :doc:`create/other-editors`
2830
* :doc:`create/developing-hallo`
31+
* :doc:`create/configuration`
2932

3033
* :doc:`media/index`
3134

3235
* :doc:`media/introduction`
3336
* :doc:`media/form_types`
3437
* :doc:`media/adapters/index`
38+
* :doc:`media/configuration`
3539

3640
* :doc:`menu/index`
3741

@@ -40,12 +44,14 @@ library or they introduce a complete new concept.
4044
* :doc:`menu/menu_factory`
4145
* :doc:`menu/menu_provider`
4246
* :doc:`menu/voters`
47+
* :doc:`menu/configuration`
4348

4449
* :doc:`routing/index`
4550

4651
* :doc:`routing/introduction`
4752
* :doc:`routing/dynamic`
4853
* :doc:`routing/dynamic_customize`
54+
* :doc:`routing/configuration`
4955

5056
* :doc:`routing_auto/index` (in development)
5157

@@ -57,16 +63,19 @@ library or they introduce a complete new concept.
5763
* :doc:`search/index`
5864

5965
* :doc:`search/introduction`
66+
* :doc:`search/configuration`
6067

6168
* :doc:`seo/index`
6269

6370
* :doc:`seo/introduction`
6471
* :doc:`seo/seo_aware`
6572
* :doc:`seo/extractors`
73+
* :doc:`seo/configuration`
6674

6775
* :doc:`tree_browser/index`
6876

6977
* :doc:`tree_browser/introduction`
78+
* :doc:`tree_browser/configuration`
7079

7180
Showcase Bundles
7281
~~~~~~~~~~~~~~~~
@@ -83,6 +92,7 @@ bundle based on the key bundles.
8392
* :doc:`content/index`
8493

8594
* :doc:`content/introduction`
95+
* :doc:`content/configuration`
8696

8797
* :doc:`simple_cms/index`
8898

@@ -91,6 +101,7 @@ bundle based on the key bundles.
91101
* :doc:`simple_cms/rendering`
92102
* :doc:`simple_cms/menus`
93103
* :doc:`simple_cms/extending_page_class`
104+
* :doc:`simple_cms/configuration`
94105

95106
Contributed Bundles
96107
~~~~~~~~~~~~~~~~~~~
@@ -106,6 +117,7 @@ help with integrating PHPCR concepts into the Symfony Framework.
106117
* :doc:`phpcr_odm/fixtures_initializers`
107118
* :doc:`phpcr_odm/multilang`
108119
* :doc:`phpcr_odm/multiple_sessions`
120+
* :doc:`phpcr_odm/configuration`
109121

110122
* SonataDoctrinePHPCRAdminBundle_
111123

0 commit comments

Comments
 (0)