Use placeholders for URLs in translation strings

[leofeyer]

So that we can change the URLs without creating unnecessary work for the translators. See contao/to.contao.org#80 for more information.

[leofeyer]

On second thought, passing the replacement strings to the trans() method ties the template to our translator. This way, the template is no longer compatible with the default Twig parser, which it would be if we continued to use format().

@contao/developers What do you think? Do we care?

[Toflar]

I don't understand the issue. You want to translate a string, this always ties it to a translator? And what do you mean by "default Twig parser"? trans is a filter added by the fullstack framework of Symfony (or the Bridge more specifically) so it's already tied to the framework and it's not a Twig standalone filter at all.
Or in other words, if that were an issue, we were also not allowed to decorate the translator and use it the way we are already using it in many places (like here for example).

[fritzmg]

The template is part of contao/core-bundle and contao/core-bundle decorates the Translator - thus there should never be an issue.

[leofeyer]

Ok, then I will merge this as soon as it has been approved.

[Toflar]

LGTM but I think we should still ask @m-vo for a review just because it's affecting Twig and I don't want to interfere with his plans here.

[leofeyer]

Agreed, although none of these templates are related to his work. This is Contao 4.13 after all. 😄

[m-vo]

Changes look good to me.

There is one thing we could think about, though: With HTML in the translated strings, we need to bypass the escaper (|raw). But ideally, we would encode anything but the link, which we could totally do now in Contao 5 with insert tags and the insert_tag_raw filter:

<trans-unit id="XPT.tokenExplainTwo">
    <source>Learn more about speeding up your workflow by using {{link_open::%s::blank}}keyboard shortcuts{{link_close}}.</source>
</trans-unit>

<p>{{ 'XPT.tokenExplainTwo'|trans(['https://to.contao.org/support'])|insert_tag_raw }}</p>

Wdyt?

[ausi]

I don’t like the idea of using insert tags, especially things like {{link_open::*}} are problematic IMO.

I think the “correct” solution would be that the link comes from the templates like this (pseudocode):

<trans-unit id="message">
    <source>Learn more about speeding up your workflow by using [keyboard shortcuts].</source>
</trans-unit>

{{ 'message'|trans({'[' => '<a href="…">', ']' => '</a>'}) }}

Not sure if this can be implemented in a way so that the message still gets encoded correctly.

But for now I think we can keep it as it is.