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

Commit de816ed

Browse files
committed
Fix versionadded directive
1 parent cc55011 commit de816ed

File tree

2 files changed

+18
-9
lines changed

2 files changed

+18
-9
lines changed

bundles/seo/configuration.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ When the `phpcr`_ persistence layer is enabled, this defaults to
267267
error
268268
~~~~~
269269

270-
.. versionadded::
270+
.. versionadded:: 1.2
271271
The ``error`` settings were introduced in SeoBundle 1.2.
272272

273273
.. seealso::
@@ -308,10 +308,10 @@ will be used instead.
308308

309309
Exclusion rules allow to match the following fields:
310310

311-
* path
312-
* host
313-
* methods
314-
* ips
311+
* ``path``
312+
* ``host``
313+
* ``methods``
314+
* ``ips``
315315

316316
For instance, to not use the special exception controller for the ``/admin``
317317
routes, use:

bundles/seo/error_pages.rst

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ this on the error page.
1616
Using the Exception Controller
1717
------------------------------
1818

19-
To use the exception controller provided by this bundle, configure the twig
20-
bundle:
19+
When you want to add suggestions to the error pages, register the
20+
``SuggestionProviderController`` provided by this bundle as the exception
21+
controller:
2122

2223
.. configuration-block::
2324

@@ -49,14 +50,20 @@ bundle:
4950
'exception_controller' => 'cmf_seo.error.suggestion_provider.controller:showAction',
5051
));
5152
53+
.. seealso::
54+
55+
You can read more about exception controllers in the `Symfony documentation`_.
56+
5257
After this, you need to enable some suggestion providers. Suggestion providers
5358
provide relevant other pages, which are displayed on the error page. The bundle
5459
comes with two built-in providers:
5560

5661
``ParentSuggestionProvider``
57-
This provides the parent page of the not found page.
62+
This provides the parent page of the not found page (e.g. ``/blog`` when
63+
``/blog/foo`` resulted in a 404 page).
5864
``SiblingSuggestionProvider``
59-
This provides the siblings of the current page.
65+
This provides the siblings of the current page (e.g. ``/blog/something``
66+
when ``/blog/foo`` resulted in a 404 page).
6067

6168
.. note::
6269

@@ -177,3 +184,5 @@ Now, register this new class as a service and tag it as
177184
$container->setDefinition('app.suggestions.homepage', $definition);
178185
179186
The tag allows a ``group`` attribute, in order to group suggested links.
187+
188+
.. _Symfony Documentation: http://symfony.com/doc/current/cookbook/controller/error_pages.html#overriding-the-default-exceptioncontroller

0 commit comments

Comments
 (0)