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

Commit f8847e6

Browse files
committed
Escaped configuration headings
1 parent 24b55d0 commit f8847e6

File tree

17 files changed

+387
-394
lines changed

17 files changed

+387
-394
lines changed

book/handling_multilang.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ transparently.
1515
.. caution::
1616

1717
You also need the ``intl`` php extension installed and enabled (otherwise
18-
composer will tell you it can't find ext-intl). If you get issues that some
18+
composer will tell you it can't find ``ext-intl``). If you get issues that some
1919
locales can not be loaded, have a look at `this discussion about ICU`_.
2020

2121
Initial Language Choice: Lunetics LocaleBundle

bundles/block/configuration.rst

Lines changed: 62 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ Configuration
1515

1616
.. _reference-config-block-persistence:
1717

18-
persistence
19-
~~~~~~~~~~~
18+
``persistence``
19+
~~~~~~~~~~~~~~~
2020

21-
phpcr
22-
.....
21+
``phpcr``
22+
.........
2323

2424
This defines the persistence driver. The default configuration of persistence
2525
is the following configuration:
@@ -110,13 +110,13 @@ is the following configuration:
110110
));
111111
112112
113-
enabled
114-
"""""""
113+
``enabled``
114+
"""""""""""
115115

116116
.. include:: ../_partials/persistence_phpcr_enabled.rst.inc
117117

118-
block_basepath
119-
""""""""""""""
118+
``block_basepath``
119+
""""""""""""""""""
120120

121121
**type**: ``string`` **default**: ``/cms/content``
122122

@@ -125,41 +125,41 @@ The basepath for blocks in the PHPCR tree.
125125
If the :doc:`CoreBundle <../core/introduction>` is registered, this will default to
126126
the value of ``%cmf_core.persistence.phpcr.basepath%/content``.
127127

128-
manager_name
129-
""""""""""""
128+
``manager_name``
129+
""""""""""""""""
130130

131131
.. include:: ../_partials/persistence_phpcr_manager_name.rst.inc
132132

133-
string_document_class
134-
"""""""""""""""""""""
133+
``string_document_class``
134+
"""""""""""""""""""""""""
135135

136136
**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\StringBlock``
137137

138138
The string block document class.
139139

140-
simple_document_class
141-
"""""""""""""""""""""
140+
``simple_document_class``
141+
"""""""""""""""""""""""""
142142

143143
**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\SimpleBlock``
144144

145145
The simple block document class.
146146

147-
container_document_class
148-
""""""""""""""""""""""""
147+
``container_document_class``
148+
""""""""""""""""""""""""""""
149149

150150
**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ContainerBlock``
151151

152152
The container block document class.
153153

154-
reference_document_class
155-
""""""""""""""""""""""""
154+
``reference_document_class``
155+
""""""""""""""""""""""""""""
156156

157157
**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ReferenceBlock``
158158

159159
The reference block document class.
160160

161-
action_document_class
162-
"""""""""""""""""""""
161+
``action_document_class``
162+
"""""""""""""""""""""""""
163163

164164
**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ActionBlock``
165165

@@ -168,23 +168,23 @@ The action block document class.
168168
If phpcr is enabled ``use_sonata_admin`` is enabled, the class value is set in
169169
``Resources/config/admin.xml``.
170170

171-
slideshow_document_class
172-
""""""""""""""""""""""""
171+
``slideshow_document_class``
172+
""""""""""""""""""""""""""""
173173

174174
**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\SlideshowBlock``
175175

176176
The slideshow block document class.
177177

178-
imagine_document_class
179-
""""""""""""""""""""""
178+
``imagine_document_class``
179+
""""""""""""""""""""""""""
180180

181181
**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\ImagineBlock``
182182

183183
The imagine block document class. This document will only work properly if
184184
you set up the LiipImagineBundle.
185185

186-
use_sonata_admin
187-
""""""""""""""""
186+
``use_sonata_admin``
187+
""""""""""""""""""""
188188

189189
**type**: ``enum`` **valid values**: ``true|false|auto`` **default**: ``auto``
190190

@@ -194,105 +194,105 @@ activated only if the SonataPhpcrAdminBundle is present.
194194
If the :doc:`CoreBundle <../core/introduction>` is registered, this will default to the value
195195
of ``cmf_core.persistence.phpcr.use_sonata_admin``.
196196

197-
string_admin_class
198-
""""""""""""""""""
197+
``string_admin_class``
198+
""""""""""""""""""""""
199199

200200
**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\StringBlockAdmin``
201201

202202
The sonata admin class of the string block.
203203

204-
simple_admin_class
205-
""""""""""""""""""
204+
``simple_admin_class``
205+
""""""""""""""""""""""
206206

207207
**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\SimpleBlockAdmin``
208208

209209
The sonata admin class of the simple block.
210210

211-
container_admin_class
212-
"""""""""""""""""""""
211+
``container_admin_class``
212+
"""""""""""""""""""""""""
213213

214214
**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\ContainerBlockAdmin``
215215

216216
The sonata admin class of the container block.
217217

218-
reference_admin_class
219-
"""""""""""""""""""""
218+
``reference_admin_class``
219+
"""""""""""""""""""""""""
220220

221221
**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\ReferenceBlockAdmin``
222222

223223
The sonata admin class of the reference block.
224224

225-
action_admin_class
226-
""""""""""""""""""
225+
``action_admin_class``
226+
""""""""""""""""""""""
227227

228228
**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\ActionBlockAdmin``
229229

230230
The sonata admin class of the action block.
231231

232-
slideshow_admin_class
233-
"""""""""""""""""""""
232+
``slideshow_admin_class``
233+
"""""""""""""""""""""""""
234234

235235
**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\Imagine\SlideshowBlockAdmin``
236236

237237
The sonata admin class of the slideshow block.
238238

239239
This admin will only be loaded if ``use_imagine`` is enabled.
240240

241-
imagine_admin_class
242-
"""""""""""""""""""
241+
``imagine_admin_class``
242+
"""""""""""""""""""""""
243243

244244
**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\BlockBundle\Admin\Imagine\ImagineBlockAdmin``
245245

246246
The sonata admin class of the imagine block.
247247

248248
This admin will only be loaded if ``use_imagine`` is enabled.
249249

250-
Twig
251-
~~~~
250+
``twig``
251+
~~~~~~~~
252252

253253
.. _reference-config-block-twig-cmf-embed-blocks:
254254

255-
cmf_embed_blocks
256-
................
255+
``cmf_embed_blocks``
256+
....................
257257

258258
The BlockBundle provides a Twig filter ``cmf_embed_blocks`` that
259259
looks through the content and looks for special tags to render blocks.
260260

261261
See :ref:`embed blocks in content <bundle-block-embed>` for using the
262262
``cmf_embed_blocks`` filter.
263263

264-
prefix
265-
""""""
264+
``prefix``
265+
""""""""""
266266

267267
**type**: ``string`` **default**: ``%embed-block|``
268268

269269
The part before the actual path to the block.
270270

271-
postfix
272-
"""""""
271+
``postfix``
272+
"""""""""""
273273

274274
**type**: ``string`` **default**: ``|end%``
275275

276276
The part after the actual path to the block.
277277

278-
use_imagine
279-
~~~~~~~~~~~
278+
``use_imagine``
279+
~~~~~~~~~~~~~~~
280280

281281
**type**: ``enum`` **valid values**: ``true|false|auto`` **default**: ``auto``
282282

283283
If ``true``, the imagine related block classes and admin classes are activated.
284284
If set to ``auto``, they are activated only if the LiipImagineBundle is present.
285285

286-
caches
287-
~~~~~~
286+
``caches``
287+
~~~~~~~~~~
288288

289289
The BlockBundle integrates with the `SonataCacheBundle`_ to provide several
290290
caching solutions.
291291

292292
.. _reference-config-block-caches-esi:
293293

294-
varnish
295-
.......
294+
``varnish``
295+
...........
296296

297297
This extends the default VarnishCache adapter of the SonataCacheBundle.
298298

@@ -349,22 +349,22 @@ This extends the default VarnishCache adapter of the SonataCacheBundle.
349349
),
350350
));
351351
352-
token
353-
"""""
352+
``token``
353+
"""""""""
354354

355355
**type**: ``string`` **default**: ``hash('sha256', uniqid(mt_rand(), true))``
356356

357357
A unique secret key. A random one is generated by default.
358358

359-
servers
360-
"""""""
359+
``servers``
360+
"""""""""""
361361

362362
**type**: ``array``
363363

364364
.. _reference-config-block-caches-ssi:
365365

366-
ssi
367-
...
366+
``ssi``
367+
.......
368368

369369
This extends the default SsiCache adapter of the SonataCacheBundle.
370370

@@ -408,8 +408,8 @@ This extends the default SsiCache adapter of the SonataCacheBundle.
408408
),
409409
));
410410
411-
token
412-
"""""
411+
``token``
412+
"""""""""
413413

414414
**type**: ``string`` **default**: ``hash('sha256', uniqid(mt_rand(), true))``
415415

bundles/content/configuration.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ application configuration. When using XML, you can use the
88
Configuration
99
-------------
1010

11-
default_template
12-
~~~~~~~~~~~~~~~~
11+
``default_template``
12+
~~~~~~~~~~~~~~~~~~~~
1313

1414
**type**: ``string`` **default**: ``null``
1515

@@ -19,8 +19,8 @@ request format and the current locale.
1919

2020
.. _config-content-persistence:
2121

22-
persistence
23-
~~~~~~~~~~~
22+
``persistence``
23+
~~~~~~~~~~~~~~~
2424

2525
This defines the persistence driver. The default configuration of persistence
2626
is the following configuration:
@@ -70,34 +70,34 @@ is the following configuration:
7070
'use_sonata_admin' => 'auto',
7171
));
7272
73-
enabled
74-
*******
73+
``enabled``
74+
***********
7575

7676
.. include:: ../_partials/persistence_phpcr_enabled.rst.inc
7777

78-
admin_class
79-
***********
78+
``admin_class``
79+
***************
8080

8181
**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\ContentBundle\Admin\StaticContentAdmin``
8282

8383
The admin class to use when :ref:`Sonata Admin is activated <quick-tour-third-party-sonata>`.
8484

85-
document_class
86-
**************
85+
``document_class``
86+
******************
8787

8888
**type**: ``string`` **default**: ``Symfony\Cmf\Bundle\ContentBundle\Doctrine\Phpcr\StaticContent``
8989

9090
The Content class to use.
9191

92-
content_basepath
93-
****************
92+
``content_basepath``
93+
********************
9494

9595
**type**: ``string`` **default**: ``/cms/content``
9696

9797
The basepath for Content documents in the PHPCR tree.
9898

99-
use_sonata_admin
100-
****************
99+
``use_sonata_admin``
100+
********************
101101

102102
**type**: ``enum`` **valid values**: ``true|false|auto`` **default**: ``auto``
103103

0 commit comments

Comments
 (0)