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

Commit 94ecfd0

Browse files
authored
Merge pull request #832 from symfony-cmf/fix-typo
fix a typo
2 parents 6abcd61 + 5d80924 commit 94ecfd0

16 files changed

+66
-66
lines changed

book/routing.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -519,8 +519,8 @@ handle ``StaticContent`` as :ref:`explained above <start-routing-getting-control
519519

520520
The PHPCR-ODM routes support more things, for example route parameters,
521521
requirements and defaults. This is explained in the
522-
:ref:`route document section in the RoutingBundle documentation <bundle-routing-document>`.
523-
You can also find :ref:`route entity documentation and Doctrine ORM integration <bundle-routing-entity>`.
522+
:ref:`route document section in the RoutingBundle documentation <bundles-routing-document>`.
523+
You can also find :ref:`route entity documentation and Doctrine ORM integration <bundles-routing-entity>`.
524524

525525
Further Notes
526526
-------------

bundles/block/cache.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The CmfBlockBundle additionally provides its own adapters for:
1515
.. note::
1616

1717
It is advised to store all settings in the block document when using cache.
18-
See also :ref:`bundle-block-cache-rendering`.
18+
See also :ref:`bundles-block-cache-rendering`.
1919

2020
Dependencies
2121
------------
@@ -164,7 +164,7 @@ If the cache is checked and the cache adapter returned that no cache was found,
164164
the workflow proceeds like this:
165165

166166
* The block service is asked to render the block
167-
:ref:`as usual <bundle-block-execute>`;
167+
:ref:`as usual <bundles-block-execute>`;
168168
* If the ``Response`` is cacheable, the configured adapter creates a cache
169169
element containing:
170170

@@ -178,7 +178,7 @@ the workflow proceeds like this:
178178
Cache Keys
179179
----------
180180

181-
It is the responsibility of the :ref:`block service <bundle-block-service>` to generate the cache keys in
181+
It is the responsibility of the :ref:`block service <bundles-block-service>` to generate the cache keys in
182182
the method ``getCacheKeys``.
183183

184184
The block services shipped with the Symfony CMF BlockBunde use the
@@ -219,7 +219,7 @@ The BlockBundle also has a cache invalidation listener that calls the
219219
``flush`` method of a cache adapter automatically when a cached block document
220220
is updated or removed.
221221

222-
.. _bundle-block-cache-rendering:
222+
.. _bundles-block-cache-rendering:
223223

224224
Block Rendering
225225
---------------

bundles/block/configuration.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ application configuration. When using XML, you can use the
77

88
The BlockBundle *automatically* changes some defaults and adds configuration
99
to the SonataBlockBundle to make the integration work seamlessly. See the
10-
:ref:`updated SonataBlockBundle defaults <bundle-block-updated-sonata-defaults>`
10+
:ref:`updated SonataBlockBundle defaults <bundles-block-updated-sonata-defaults>`
1111
for more information.
1212

1313
Configuration
@@ -96,7 +96,7 @@ the value of ``%cmf_core.persistence.phpcr.basepath%/content``.
9696
The BlockBundle provides a Twig filter ``cmf_embed_blocks`` that
9797
looks through the content and looks for special tags to render blocks.
9898

99-
See :ref:`embed blocks in content <bundle-block-embed>` for using the
99+
See :ref:`embed blocks in content <bundles-block-embed>` for using the
100100
``cmf_embed_blocks`` filter.
101101

102102
``prefix``

bundles/block/create_your_own_blocks.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Follow these steps to create a block:
66
* define a block document class;
77
* if needed, create a block service and declare it (optional);
88
* instantiate a data object representing your block in the repository, see
9-
:ref:`bundle-block-document`;
10-
* render the block, see :ref:`bundle-block-rendering`;
9+
:ref:`bundles-block-document`;
10+
* render the block, see :ref:`bundles-block-rendering`;
1111

1212
Lets say you are working on a project where you have to integrate data
1313
received from several RSS feeds. You could create an ActionBlock for each of
@@ -193,7 +193,7 @@ that knows how to fetch the feed data of an ``RssBlock``::
193193
}
194194
}
195195

196-
.. _bundle-block-execute:
196+
.. _bundles-block-execute:
197197

198198
The Execute Method
199199
~~~~~~~~~~~~~~~~~~
@@ -223,7 +223,7 @@ places afterwards, cascading as follows:
223223

224224
* Default settings from the block service;
225225
* If you use a 3rd party bundle you might want to change them in the bundle
226-
configuration for your application see :ref:`bundle-block-configuration`;
226+
configuration for your application see :ref:`bundles-block-configuration`;
227227
* Settings can be altered through template helpers (see example below);
228228
* And settings can also be altered in a block document. Do this only for
229229
settings that are individual to the specific block instance rather than

bundles/block/introduction.rst

+11-11
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ sonata bundles in addition to the CmfBlockBundle::
4141
// ...
4242
}
4343

44-
.. _bundle-block-configuration:
44+
.. _bundles-block-configuration:
4545

4646
Usage
4747
-----
@@ -151,7 +151,7 @@ specific settings for one of the block classes.
151151
:ref:`Block Sonata Admin Extension <bundles-block-types-admin_extension>`
152152
that adds editing of the ``BaseBlock`` general block options.
153153

154-
.. _bundle-block-updated-sonata-defaults:
154+
.. _bundles-block-updated-sonata-defaults:
155155

156156
Updated SonataBlockBundle Defaults
157157
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -165,15 +165,15 @@ updated:
165165
a ``div`` and slugifies the PHPCR path as id; The base template is
166166
kept compatible with the Sonata base template for non-cmf blocks;
167167
* **RssBlock configuration** adds the
168-
:ref:`default RssBlock settings <bundle-block-rss-settings>`.
168+
:ref:`default RssBlock settings <bundles-block-rss-settings>`.
169169

170170
.. note::
171171

172172
Settings are only prepended, meaning the default value is changed. You can
173173
still change the values by setting the configuration values in your
174174
application configuration file.
175175

176-
.. _bundle-block-document:
176+
.. _bundles-block-document:
177177

178178
Block Document
179179
--------------
@@ -201,7 +201,7 @@ the block. The other properties (title and body) are specific to the
201201
``Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\SimpleBlock``.
202202

203203
The simple block is now ready to be rendered, see
204-
:ref:`bundle-block-rendering`.
204+
:ref:`bundles-block-rendering`.
205205

206206
.. note::
207207

@@ -217,7 +217,7 @@ render the block. It aggregates and merges all settings from configuration,
217217
the block service, the block document and settings passed to the Twig template
218218
helper. Therefore, use the BlockContext to get or alter a setting if needed.
219219

220-
.. _bundle-block-service:
220+
.. _bundles-block-service:
221221

222222
Block Service
223223
-------------
@@ -230,7 +230,7 @@ When using the provided blocks, you do not need to worry about the block
230230
service. It is only relevant when
231231
:doc:`creating your own blocks <create_your_own_blocks>`.
232232

233-
.. _bundle-block-rendering:
233+
.. _bundles-block-rendering:
234234

235235
Block rendering
236236
---------------
@@ -239,7 +239,7 @@ Rendering is handled by the SonataBlockBundle ``sonata_block_render`` Twig
239239
function. The block name is either an absolute PHPCR path or the name of the
240240
block relative to the ``cmfMainContent`` document.
241241

242-
To render the example from the :ref:`bundle-block-document` section, just add
242+
To render the example from the :ref:`bundles-block-document` section, just add
243243
the following code to your Twig template:
244244

245245
.. configuration-block::
@@ -271,7 +271,7 @@ block as follows:
271271
)) ?>
272272

273273
This will make the BlockBundle render the specified block if the main content
274-
(as per the :ref:`routing <bundle-routing-dynamic-match>`) maps a field named
274+
(as per the :ref:`routing <bundles-routing-dynamic-match>`) maps a field named
275275
``sidebarBlock``. If different main contents are rendered using different
276276
templates, make sure all that should support this block actually include the
277277
snippet above.
@@ -289,15 +289,15 @@ receives the block object (equivalent to a Request object) and a ``Response``
289289
object. The purpose of the ``execute`` method to set the content of the
290290
response object - typically by rendering a Twig template.
291291

292-
.. _bundle-block-embed:
292+
.. _bundles-block-embed:
293293

294294
Embedding Blocks in WYSIWYG Content
295295
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
296296

297297
The CmfBlockBundle provides a Twig filter ``cmf_embed_blocks`` that
298298
scans through a content and looks for special tags to render blocks. To use
299299
the tag, you need to apply the ``cmf_embed_blocks`` filter to your output. This
300-
feature is a rather hacky solution for web editors to place blocks anywhere in
300+
feature is a hack to allow web editors to place blocks anywhere in
301301
their HTML content. If you can, render your blocks directly in the template.
302302
A better solution would be to build composed pages is to build it from blocks.
303303

bundles/block/types.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ Create a document::
129129

130130
$documentManager->persist($myRssBlock);
131131

132-
.. _bundle-block-rss-settings:
132+
.. _bundles-block-rss-settings:
133133

134134
The available settings are:
135135

bundles/core/publish_workflow.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ to view unpublished content as well::
111111
// ...
112112
}
113113

114-
.. _bundle-core-publish-workflow-twig_function:
114+
.. _bundles-core-publish-workflow-twig_function:
115115

116116
To check publication in a template, use the Twig function ``cmf_is_published``,
117117
in PHP templating the ``$view['cmf']->isPublished`` method:
@@ -156,7 +156,7 @@ in PHP templating the ``$view['cmf']->isPublished`` method:
156156
CMF. Those helpers already use the publish workflow where applicable.
157157

158158
Code that loads content should do the publish checks. Thanks to a
159-
:ref:`request listener <bundle-core-workflow-request_listener>`, routes and
159+
:ref:`request listener <bundles-core-workflow-request_listener>`, routes and
160160
the main content provided by the
161161
:doc:`DynamicRouter <../routing/dynamic>` are checked automatically already.
162162

@@ -264,7 +264,7 @@ As voting is unanimous, each voter returns ``ACCESS_GRANTED`` if its criteria
264264
is met, but if a single voter returns ``ACCESS_DENIED``, the content is
265265
considered not published.
266266

267-
You can also implement your :ref:`own voters <bundle-core-workflow-custom-voters>`
267+
You can also implement your :ref:`own voters <bundles-core-workflow-custom-voters>`
268268
for additional publication behavior.
269269

270270
PublishableVoter
@@ -287,7 +287,7 @@ and end date. A date may be null to indicate "always started" resp.
287287
* **getPublishEndDate**: If non-null, the date from which the document
288288
should stop being published.
289289

290-
.. _bundle-core-workflow-custom-voters:
290+
.. _bundles-core-workflow-custom-voters:
291291

292292
Custom Voters
293293
.............
@@ -346,7 +346,7 @@ should not call it to avoid triggering an exception. If a voter only gives
346346
access if the current user fulfills some requirement, it simply has to return
347347
``ACCESS_DENIED`` if there is no current user.
348348

349-
.. _bundle-core-workflow-request_listener:
349+
.. _bundles-core-workflow-request_listener:
350350

351351
Publication Request Listener
352352
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

bundles/core/templating.rst

+15-15
Original file line numberDiff line numberDiff line change
@@ -96,21 +96,21 @@ Walking the PHPCR tree
9696
Helper methods
9797
..............
9898

99-
+---------------------------+---------------------+------------------------+--------------------------------------------------------------------------+
100-
| ``cmf_document_locales`` | ``getLocalesFor`` | ``$document``, | Get the locales of the provided document. If ``$includeFallbacks`` is |
101-
| | | ``$includeFallbacks``, | ``true``, all fallback locales are provided as well, even if no |
102-
| | | ``false`` | translation in that language exists. |
103-
+---------------------------+---------------------+------------------------+--------------------------------------------------------------------------+
104-
| ``cmf_is_linkable`` | ``isLinkable`` | ``$document`` | Check if the provided object can be used to generate a URL. If this |
105-
| | | | check returns true, it should be save to pass it to ``path`` or ``url``. |
106-
| | | | An object is considered linkable if it either *is* an instance of |
107-
| | | | ``Route`` or implements the ``RouteReferrersReadInterface`` *and* |
108-
| | | | actually returns a route. |
109-
+---------------------------+---------------------+------------------------+--------------------------------------------------------------------------+
110-
| ``cmf_is_published`` | ``isPublished`` | ``$document`` | Check with the publish workflow if the provided object is published. See |
111-
| | | | also :ref:`cmf_is_published <bundle-core-publish-workflow-twig_function>`|
112-
| | | | for an example. |
113-
+---------------------------+---------------------+------------------------+--------------------------------------------------------------------------+
99+
+---------------------------+---------------------+------------------------+---------------------------------------------------------------------------+
100+
| ``cmf_document_locales`` | ``getLocalesFor`` | ``$document``, | Get the locales of the provided document. If ``$includeFallbacks`` is |
101+
| | | ``$includeFallbacks``, | ``true``, all fallback locales are provided as well, even if no |
102+
| | | ``false`` | translation in that language exists. |
103+
+---------------------------+---------------------+------------------------+---------------------------------------------------------------------------+
104+
| ``cmf_is_linkable`` | ``isLinkable`` | ``$document`` | Check if the provided object can be used to generate a URL. If this |
105+
| | | | check returns true, it should be save to pass it to ``path`` or ``url``. |
106+
| | | | An object is considered linkable if it either *is* an instance of |
107+
| | | | ``Route`` or implements the ``RouteReferrersReadInterface`` *and* |
108+
| | | | actually returns a route. |
109+
+---------------------------+---------------------+------------------------+---------------------------------------------------------------------------+
110+
| ``cmf_is_published`` | ``isPublished`` | ``$document`` | Check with the publish workflow if the provided object is published. See |
111+
| | | | also :ref:`cmf_is_published <bundles-core-publish-workflow-twig_function>`|
112+
| | | | for an example. |
113+
+---------------------------+---------------------+------------------------+---------------------------------------------------------------------------+
114114

115115
Code examples
116116
.............

bundles/create/introduction.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ bundles in your kernel and properly configure Assetic as described below.
8282
To upload and display images the :doc:`MediaBundle <../media/introduction>` is
8383
used. CKEditor uses the :doc:`elfinder adapter <../media/adapters/elfinder>`.
8484

85-
.. _bundle-create-ckeditor:
85+
.. _bundles-create-ckeditor:
8686

8787
Installation
8888
------------
@@ -390,9 +390,9 @@ higher, the method reads:
390390
use the hallo editor, a plugin is enabled to use the tag editor to edit
391391
``skos:related`` collections of attributes. For customization of the editor
392392
configuration further, you will need to use a
393-
:ref:`custom template to load the editor<bundle-create-custom>`.
393+
:ref:`custom template to load the editor<bundles-create-custom>`.
394394

395-
.. _bundle-create-usage-embed:
395+
.. _bundles-create-usage-embed:
396396

397397
Rendering Content
398398
-----------------

bundles/create/other-editors.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Other Editors
77

88
.. include:: ../_partials/unmaintained.rst.inc
99

10-
.. _bundle-create-hallo:
10+
.. _bundles-create-hallo:
1111

1212
Using Hallo.js Editor
1313
---------------------
@@ -78,7 +78,7 @@ the additional image controller routing file in your main routing configuration:
7878
7979
return $collection;
8080
81-
.. _bundle-create-custom:
81+
.. _bundles-create-custom:
8282

8383
Custom Editors
8484
--------------

bundles/phpcr_odm/configuration.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Defines the PHPCR workspace to use for this PHPCR session.
9595
Every PHPCR implementation should provide the workspace called *default*,
9696
but you can choose a different one. There is the
9797
``doctrine:phpcr:workspace:create`` command to initialize a new workspace.
98-
See also :ref:`bundle-phpcr-odm-commands`.
98+
See also :ref:`bundles-phpcr-odm-commands`.
9999

100100
``username and password``
101101
"""""""""""""""""""""""""

bundles/phpcr_odm/introduction.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,7 @@ There are 3 main services provided by this bundle:
410410
* ``doctrine_phpcr.odm.default_document_manager`` - The PHPCR-ODM document
411411
manager instance.
412412

413-
.. _bundle-phpcr-odm-commands:
413+
.. _bundles-phpcr-odm-commands:
414414

415415
Doctrine PHPCR Commands
416416
-----------------------

bundles/phpcr_odm/multiple_sessions.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ of the ``session`` information. Each session has a name and the configuration
99
following the same schema as what is directly in ``session``. You can also
1010
overwrite which session to use as ``default_session``.
1111

12-
.. _bundle-phpcr-odm-multiple-phpcr-sessions:
12+
.. _bundles-phpcr-odm-multiple-phpcr-sessions:
1313

1414
Multiple PHPCR Sessions
1515
-----------------------

0 commit comments

Comments
 (0)