Merge remote-tracking branch 'origin/1.3'

Author: wouterj

book/handling_multilang.rst

@@ -347,4 +347,4 @@ save the edited document in the same language as it was loaded.
 .. _`this discussion about ICU`: https://github.com/symfony/symfony/issues/5279#issuecomment-11710480
 .. _`cmf-sandbox config.yml file`: https://github.com/symfony-cmf/cmf-sandbox/blob/master/app/config/config.yml
 .. _`PHPCR-ODM documentation on multi-language`: http://docs.doctrine-project.org/projects/doctrine-phpcr-odm/en/latest/reference/multilang.html
-.. _`issue`: https://github.com/symfony-cmf/CreateBundle/issues/39
+.. _`issue`: https://github.com/symfony-cmf/create-bundle/issues/39

bundles/block/introduction.rst

@@ -420,4 +420,4 @@ Read on
 .. _`Symfony CMF Sandbox`: https://github.com/symfony-cmf/cmf-sandbox
 .. _`prepended configuration`: https://symfony.com/doc/current/components/dependency_injection/compilation.html#prepending-configuration-passed-to-the-extension
 .. _`SonataBlockBundle`: https://github.com/sonata-project/SonataBlockBundle
-.. _`discussion how to fix this`: https://github.com/symfony-cmf/BlockBundle/issues/143
+.. _`discussion how to fix this`: https://github.com/symfony-cmf/block-bundle/issues/143

bundles/content/exposing_content_via_rest.rst

@@ -154,4 +154,4 @@ for details.
 .. _`FOSRestBundle view layer`: https://symfony.com/doc/master/bundles/FOSRestBundle/2-the-view-layer.html
 .. _Composer: https://getcomposer.org/
 .. _`documentation of the JMS serializer`: http://jmsyst.com/libs/#serializer
-.. _`default response format changed between 1.0 and 1.1 of the ContentBundle`: https://github.com/symfony-cmf/ContentBundle/pull/91
+.. _`default response format changed between 1.0 and 1.1 of the ContentBundle`: https://github.com/symfony-cmf/content-bundle/pull/91

bundles/core/templating.rst

@@ -29,12 +29,19 @@ Basic repository operations
 
 * **cmf_find|find(path)**: Get the document for the provided path or null if not found.
   No publish workflow check is done.
+* **cmf_find_translation|findTranslation($pathOrDocument, $locale, $fallback = true)**: Get the document translation
+  for the provided path/document and locale or null if not found. The document will stay in the last requested locale
+  for the rest of the request.
+  No publish workflow check is done.
 * **cmf_find_many|findMany($paths, $limit = false, $offset = false, $ignoreRole = false, $class = false)**:
   Get a list of documents for the provided paths.
 * **cmf_nodename|getNodeName($document)**: Get the node name of the provided document.
 * **cmf_path|getPath($document)**: Get the path of the provided document.
 * **cmf_parent_path|getParentPath($document)**: Get the path of the parent of the provided document.
 
+.. versionadded:: 1.3.1
+    The cmf_find_translation twig function has been added in version 1.3.1 of the CMF CoreBundle.
+
 Walking the PHPCR tree
 ......................
 

bundles/create/other-editors.rst

@@ -114,4 +114,4 @@ editor parameter:
     help, please see the github issue for `aloha`_ integration.
 
 .. _`Aloha editor`: http://www.alohaeditor.org/Content.Node/index.html
-.. _`aloha`: https://github.com/symfony-cmf/CreateBundle/issues/32
+.. _`aloha`: https://github.com/symfony-cmf/create-bundle/issues/32

bundles/media/form_types.rst

@@ -10,11 +10,11 @@ transformers.
 .. caution::
 
     The form types described in this chapter are only available if the PHPCR storage
-    is activated. Implementation for other storage systems would be welcome 
+    is activated. Implementation for other storage systems would be welcome
     contributions.
 
 A default twig template is also included for these form types.
-To use it you will need to add the ``fields.html.twig`` template from the 
+To use it you will need to add the ``fields.html.twig`` template from the
 MediaBundle to the ``form.resources`` section in twig config:
 
 .. configuration-block::
@@ -153,13 +153,13 @@ cmf_media_file
 
 .. versionadded: 1.3
     The ``cmf_media_file`` form type was introduced in MediaBundle 1.3.
-    
+
 The ``cmf_media_file`` form maps to an object that implements the
 ``Symfony\Cmf\Bundle\MediaBundle\FileInterface``.
 It renders as a file upload button with a link for downloading the existing
 file, if any.
 
 .. _`LiipImagineBundle`: https://github.com/liip/LiipImagineBundle
 .. _`trying to make this automatic`: https://groups.google.com/forum/?fromgroups=#!topic/symfony2/CrooBoaAlO4
-.. _`ImagineBlock::setImage`: https://github.com/symfony-cmf/BlockBundle/blob/master/Doctrine/Phpcr/ImagineBlock.php#L121
-.. _`MediaBundle issue`: https://github.com/symfony-cmf/MediaBundle/issues/9
+.. _`ImagineBlock::setImage`: https://github.com/symfony-cmf/block-bundle/blob/master/Doctrine/Phpcr/ImagineBlock.php#L121
+.. _`MediaBundle issue`: https://github.com/symfony-cmf/media-bundle/issues/9

bundles/media/introduction.rst

@@ -217,7 +217,7 @@ The media bundle contains a Twig extension, it contains the following functions:
           <img src="<?php echo $view['cmf_media']->displayUrl($image) ?>" alt="" />
 
     If :doc:`LiipImagine <adapters/liip_imagine>` is enabled you can also pass :doc:`filter </bundles/LiipImagineBundle/filters>` and `runtime_config` like below:
-    
+
       .. code-block:: html+jinja
 
         <a href="{{ cmf_media_display_url(file, {
@@ -288,7 +288,7 @@ and Symfony bundles:
 
 .. _`symfony-cmf/media-bundle`: https://packagist.org/packages/symfony-cmf/media-bundle
 .. _`with composer`: https://getcomposer.org
-.. _`MediaBundle`: https://github.com/symfony-cmf/MediaBundle#readme
+.. _`MediaBundle`: https://github.com/symfony-cmf/media-bundle#readme
 .. _`KnpLabs/Gaufrette`: https://github.com/KnpLabs/Gaufrette
 .. _`phpcr/phpcr-utils`: https://github.com/phpcr/phpcr-utils
 .. _`jms/serializer-bundle`: https://github.com/schmittjoh/JMSSerializerBundle

bundles/routing/introduction.rst

@@ -106,7 +106,7 @@ For more information on Routing in the Symfony CMF, please refer to:
 
 .. _`with composer`: https://getcomposer.org
 .. _`symfony-cmf/routing-bundle`: https://packagist.org/packages/symfony-cmf/routing-bundle
-.. _`RoutingBundle`: https://github.com/symfony-cmf/RoutingBundle#readme
+.. _`RoutingBundle`: https://github.com/symfony-cmf/routing-bundle#readme
 .. _`PHPCR-ODM`: http://www.doctrine-project.org/projects/phpcr-odm.html
 .. _`documentation for DependencyInjection tags`: https://symfony.com/doc/2.1/reference/dic_tags.html
 .. _`Routing`: https://symfony.com/doc/current/components/routing/introduction.html

bundles/seo/alternate_locale.rst

@@ -0,0 +1,107 @@
+Alternate Locale Handling
+=========================
+
+.. versionadded:: 1.1
+    Support for handling alternate locales was added in SeoBundle version 1.1.0.
+
+Alternate locales are a way of telling search engines how to find translations
+of the current page. The SeoBundle provides a way to manage alternate locales
+and render them together with the other SEO information.
+
+When the alternate locale handling is set up and found alternates, you will
+find links like the following in the ``<head>`` part of your HTML pages:
+
+.. code-block:: html
+
+    <link rel="alternate" href="/fr/le-titre" hreflang="fr">
+    <link rel="alternate" href="/de/der-titel" hreflang="de">
+
+When using PHPCR-ODM, there is almost no work to do, as the bundle can use the
+Doctrine meta data to figure out which translations exists for a content. More
+information on translating content with the PHPCR-ODM is in the chapter
+:doc:`Doctrine PHPCR-ODM Multilanguage Support <../phpcr_odm/multilang>`.
+
+Setting Up Alternate Locale Support
+-----------------------------------
+
+Enable alternate locale support:
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        # app/config/config.yml
+        cmf_seo:
+            alternate_locale: ~
+
+    .. code-block:: xml
+
+        <!-- app/config/config.xml -->
+        <?xml version="1.0" encoding="UTF-8" ?>
+        <container xmlns="http://symfony.com/schema/dic/services">
+            <config xmlns="http://cmf.symfony.com/schema/dic/seo">
+                <alternate-locale />
+            </config>
+        </container>
+
+    .. code-block:: php
+
+        $container->loadFromExtension('cmf_seo', array(
+            'alternate_locale' => true,
+        ));
+
+If you are using PHPCR-ODM, enabling ``phpcr: ~`` in the seo bundle
+configuration will activate a listener that extracts the alternate locales
+from the PHPCR-ODM meta data. For other storage systems, you will need to
+write a provider and configure the bundle to use that provider - see below.
+
+Rendering Alternate Locales
+---------------------------
+
+The alternate locales are rendered together with the other SEO metadata by the
+twig function ``sonata_seo_metadatas``.
+
+Creating a Custom Alternate Locales Provider
+--------------------------------------------
+
+The alternate locale provider is asked to provide translated URLs for a content
+object. The bundle comes with a provider for PHPCR-ODM. For other persistence
+layers or custom requirements on the translated URLs you need to create your
+own provider implementing the ``AlternateLocaleProviderInterface``. For some
+inspiration, have a look at
+``Symfony\Cmf\Bundle\SeoBundle\Doctrine\Phpcr\AlternateLocaleProvider``.
+
+Define a service for your provider, so that you can configure the seo bundle to
+use your custom alternate locale provider instead of the default one. Set the
+``alternate_locale.provider_id`` to the service you just created:
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        # app/config/config.yml
+        cmf_seo:
+            alternate_locale:
+                provider_id: alternate_locale.provider
+
+    .. code-block:: xml
+
+        <!-- app/config/config.xml -->
+        <?xml version="1.0" encoding="UTF-8" ?>
+        <container xmlns="http://symfony.com/schema/dic/services">
+            <config xmlns="http://cmf.symfony.com/schema/dic/seo">
+                <alternate-locale provider-id="alternate_locale.provider" />
+            </config>
+        </container>
+
+    .. code-block:: php
+
+        $container->loadFromExtension('cmf_seo', array(
+            'alternate_locale' => array (
+                'provider_id' => 'alternate_locale.provider',
+            ),
+        ));
+
+.. versionadded:: 1.2
+    When :doc:`Sitemaps <sitemap>` are enabled, alternate locales are also
+    added to the Sitemap.

bundles/seo/configuration.rst

@@ -353,3 +353,52 @@ routes, use:
                 ),
             ),
         ));
+
+``alternate_locale``
+~~~~~~~~~~~~~~~~~~~~
+
+.. versionadded:: 1.1
+    Support for alternate locales was added in version 1.1 of the SeoBundle.
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        # app/config/config.yml
+        cmf_seo:
+            alternate_locale:
+                enabled: true
+                provider_id: app.alternate_locale.provider
+
+    .. code-block:: xml
+
+        <!-- app/config/config.xml -->
+        <?xml version="1.0" encoding="UTF-8" ?>
+        <container xmlns="http://symfony.com/schema/dic/services">
+            <config xmlns="http://cmf.symfony.com/schema/dic/seo">
+                <alternate-locale  enabled="true" provider-id="app.alternate_locale.provider" />
+            </config>
+        </container>
+
+    .. code-block:: php
+
+        $container->loadFromExtension('cmf_seo', array(
+            'alternate_locale' => array (
+                'enabled' => true,
+                'provider_id' => app.alternate_locale.provider,
+            ),
+        ));
+
+``enabled``
+"""""""""""
+
+**type**: ``boolean`` **default**: ``true``
+
+Whether or not the the :ref:`bundles-seo-alternate-locale` should be loaded
+
+``provider_id``
+"""""""""""""""
+
+**type**: ``string`` **default**: ``null``
+
+Specify the service id of a custom :doc:`AlternateLocaleProvider <../seo/alternate_locale>`.