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

fix a typo #832

Merged
merged 2 commits into from
Aug 15, 2017
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/routing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -519,8 +519,8 @@ handle ``StaticContent`` as :ref:`explained above <start-routing-getting-control

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

Further Notes
-------------
Expand Down
8 changes: 4 additions & 4 deletions bundles/block/cache.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The CmfBlockBundle additionally provides its own adapters for:
.. note::

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

Dependencies
------------
Expand Down Expand Up @@ -164,7 +164,7 @@ If the cache is checked and the cache adapter returned that no cache was found,
the workflow proceeds like this:

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

Expand All @@ -178,7 +178,7 @@ the workflow proceeds like this:
Cache Keys
----------

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

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

.. _bundle-block-cache-rendering:
.. _bundles-block-cache-rendering:

Block Rendering
---------------
Expand Down
4 changes: 2 additions & 2 deletions bundles/block/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ application configuration. When using XML, you can use the

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

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

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

``prefix``
Expand Down
8 changes: 4 additions & 4 deletions bundles/block/create_your_own_blocks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Follow these steps to create a block:
* define a block document class;
* if needed, create a block service and declare it (optional);
* instantiate a data object representing your block in the repository, see
:ref:`bundle-block-document`;
* render the block, see :ref:`bundle-block-rendering`;
:ref:`bundles-block-document`;
* render the block, see :ref:`bundles-block-rendering`;

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

.. _bundle-block-execute:
.. _bundles-block-execute:

The Execute Method
~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -223,7 +223,7 @@ places afterwards, cascading as follows:

* Default settings from the block service;
* If you use a 3rd party bundle you might want to change them in the bundle
configuration for your application see :ref:`bundle-block-configuration`;
configuration for your application see :ref:`bundles-block-configuration`;
* Settings can be altered through template helpers (see example below);
* And settings can also be altered in a block document. Do this only for
settings that are individual to the specific block instance rather than
Expand Down
22 changes: 11 additions & 11 deletions bundles/block/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ sonata bundles in addition to the CmfBlockBundle::
// ...
}

.. _bundle-block-configuration:
.. _bundles-block-configuration:

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

.. _bundle-block-updated-sonata-defaults:
.. _bundles-block-updated-sonata-defaults:

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

.. note::

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

.. _bundle-block-document:
.. _bundles-block-document:

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

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

.. note::

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

.. _bundle-block-service:
.. _bundles-block-service:

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

.. _bundle-block-rendering:
.. _bundles-block-rendering:

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

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

.. configuration-block::
Expand Down Expand Up @@ -271,7 +271,7 @@ block as follows:
)) ?>

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

.. _bundle-block-embed:
.. _bundles-block-embed:

Embedding Blocks in WYSIWYG Content
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

Expand Down
2 changes: 1 addition & 1 deletion bundles/block/types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ Create a document::

$documentManager->persist($myRssBlock);

.. _bundle-block-rss-settings:
.. _bundles-block-rss-settings:

The available settings are:

Expand Down
10 changes: 5 additions & 5 deletions bundles/core/publish_workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ to view unpublished content as well::
// ...
}

.. _bundle-core-publish-workflow-twig_function:
.. _bundles-core-publish-workflow-twig_function:

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

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

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

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

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

.. _bundle-core-workflow-custom-voters:
.. _bundles-core-workflow-custom-voters:

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

.. _bundle-core-workflow-request_listener:
.. _bundles-core-workflow-request_listener:

Publication Request Listener
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
30 changes: 15 additions & 15 deletions bundles/core/templating.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,21 +96,21 @@ Walking the PHPCR tree
Helper methods
..............

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

Code examples
.............
Expand Down
6 changes: 3 additions & 3 deletions bundles/create/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ bundles in your kernel and properly configure Assetic as described below.
To upload and display images the :doc:`MediaBundle <../media/introduction>` is
used. CKEditor uses the :doc:`elfinder adapter <../media/adapters/elfinder>`.

.. _bundle-create-ckeditor:
.. _bundles-create-ckeditor:

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

.. _bundle-create-usage-embed:
.. _bundles-create-usage-embed:

Rendering Content
-----------------
Expand Down
4 changes: 2 additions & 2 deletions bundles/create/other-editors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Other Editors

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

.. _bundle-create-hallo:
.. _bundles-create-hallo:

Using Hallo.js Editor
---------------------
Expand Down Expand Up @@ -78,7 +78,7 @@ the additional image controller routing file in your main routing configuration:

return $collection;

.. _bundle-create-custom:
.. _bundles-create-custom:

Custom Editors
--------------
Expand Down
2 changes: 1 addition & 1 deletion bundles/phpcr_odm/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Defines the PHPCR workspace to use for this PHPCR session.
Every PHPCR implementation should provide the workspace called *default*,
but you can choose a different one. There is the
``doctrine:phpcr:workspace:create`` command to initialize a new workspace.
See also :ref:`bundle-phpcr-odm-commands`.
See also :ref:`bundles-phpcr-odm-commands`.

``username and password``
"""""""""""""""""""""""""
Expand Down
2 changes: 1 addition & 1 deletion bundles/phpcr_odm/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,7 @@ There are 3 main services provided by this bundle:
* ``doctrine_phpcr.odm.default_document_manager`` - The PHPCR-ODM document
manager instance.

.. _bundle-phpcr-odm-commands:
.. _bundles-phpcr-odm-commands:

Doctrine PHPCR Commands
-----------------------
Expand Down
2 changes: 1 addition & 1 deletion bundles/phpcr_odm/multiple_sessions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ of the ``session`` information. Each session has a name and the configuration
following the same schema as what is directly in ``session``. You can also
overwrite which session to use as ``default_session``.

.. _bundle-phpcr-odm-multiple-phpcr-sessions:
.. _bundles-phpcr-odm-multiple-phpcr-sessions:

Multiple PHPCR Sessions
-----------------------
Expand Down
Loading