Scan translation keys from email themes #14719

jolelievre · 2019-07-17T15:22:51Z

Questions	Answers
Branch?	1.7.6.x
Description?	Change config to scan mails themes folders, update catalog with missing keys for emails, fix a few wording that were wrong in templates
Type?	bug fix
Category?	BO
BC breaks?	no
Deprecations?	no
Fixed ticket?	Fixes #14633 and fixes #14337
How to test?	~

This change is

.t9n.yml

eternoendless

LGTM, waiting for @LouiseBonnard

LouiseBonnard · 2019-07-19T08:57:58Z

Hi there, can you confirm it is too late to apply the changes requested here? Can I milestone it for 1.7.7?

LouiseBonnard · 2019-07-19T09:18:44Z

app/Resources/translations/default/AdminNotificationsError.xlf

@@ -1163,17 +1163,17 @@ Comment: check if some ids are in list_skip_actions and forbid deletion</note>
      <trans-unit id="3452da55a90ccedd184c7ba264b2afd5">
        <source>Due to memory limit restrictions, this image cannot be loaded. Please increase your memory_limit value via your server's configuration settings. </source>


With the space at the end?

LouiseBonnard · 2019-07-19T09:36:59Z

app/Resources/translations/default/messages.xlf

+        <note>Line: 537</note>
+      </trans-unit>
+      <trans-unit id="c7e728f436eee2692d6c6f756621a70e">
+        <source>An error occured, please check your zip file</source>


Suggested change

<source>An error occured, please check your zip file</source>

<source>An error occurred, please check your zip file</source>

But I think that this shouldn't be in the catalog, it has been removed from Crowdin since 1.7.4.

Actually, all these keys from the Theme Custo module do not have to be here. I remember that it has been removed because after the 1.7.4 release because it came with its own translation. Anyway, as seen with @colinegin and @eternoendless lately, a small cleaning among the native modules needs to be done since there should not be all modules translatable via Crowdin.

app/Resources/translations/default/messages.xlf

jolelievre · 2019-07-19T20:03:26Z

Alright this should be good, @LouiseBonnard @eternoendless if you can please check it one last time Thank you

app/Resources/translations/default/messages.xlf

mails/themes/classic/components/footer.html.twig

mails/themes/classic/core/log_alert.html.twig

mails/themes/modern/components/footer.html.twig

LouiseBonnard · 2019-07-22T08:36:53Z

mails/themes/modern/core/productoutofstock.html.twig

@@ -189,7 +189,7 @@
                                    <tr>
                                      <td align="left" style="font-size:0px;padding:10px 25px;word-break:break-word;">
                                        <div style="font-family:Open sans, arial, sans-serif;font-size:14px;line-height:25px;text-align:left;color:#363A41;">
-                                          {{ 'Replenish your inventory, go to the <span class="label">"Catalog" &gt; "Stocks"</span> section of your back office to manage your stock.'|trans({}, 'Emails.Body', locale)|raw }}
+                                          {{ 'Replenish your inventory, go to the <span class="label">"Catalog" > "Stocks"</span> section of your back office to manage your stock.'|trans({}, 'Emails.Body', locale)|raw }}


Suggested change

{{ 'Replenish your inventory, go to the "Catalog" > "Stocks" section of your back office to manage your stock.'|trans({}, 'Emails.Body', locale)|raw }}

{{ 'Replenish your inventory, go to the Catalog > Stocks section of your back office to manage your stock.'|trans({}, 'Emails.Body', locale)|raw }}

Shouldn't it be the same balises (I don't know the English word, aha) than before?

It is the same tag (😉)  If you compare it with the classic theme where we use  then yes it is normal, the theme css and integration are different. I'm not a big fan of including html in the translation though because it means they are not compatible with other themes..
But this would require to split the message into three parts, or maybe include placeholders like this:

'Replenish your inventory, go to the [bold]Catalog > Stocks[\bold] section of your back office to manage your stock.'

LouiseBonnard · 2019-07-22T08:38:20Z

mails/themes/modern/modules/ps_emailalerts/productoutofstock.html.twig

@@ -255,7 +255,7 @@
                                    <tr>
                                      <td align="left" style="font-size:0px;padding:10px 25px;padding-top:0;word-break:break-word;">
                                        <div style="font-family:Open sans, arial, sans-serif;font-size:14px;line-height:25px;text-align:left;color:#363A41;">
-                                          {{ 'Replenish your inventory, go to the <span class="label">"Catalog" &gt; "Stocks"</span> section of your back office to manage your stock.'|trans({}, 'Emails.Body', locale)|raw }}
+                                          {{ 'Replenish your inventory, go to the <span class="label">"Catalog" > "Stocks"</span> section of your back office to manage your stock.'|trans({}, 'Emails.Body', locale)|raw }}


app/Resources/translations/default/messages.xlf

LouiseBonnard · 2019-07-22T08:57:31Z

app/Resources/translations/default/messages.xlf

+  </file>
+  <file original="modules/ps_emailsubscription/ps_emailsubscription.php" source-language="en-US" target-language="en" datatype="plaintext">
+    <body>
+      <trans-unit id="2df860f82be52de57fc5e3f7ecac9431">


Same than Theme Custo, the two following strings have been removed from the Crowdin catalog since the 1.7.4 version, perhaps because they already have their own translation. I can see three solutions:

we can properly localize them and we put them in the Modules.Emailsubscription.Admin file, where they belong

we keep them as-is because we cannot change domain at this point

we delete them from the code here, but it could be risky

The new domain is managed in v2.4.0, but the one included in 176 is the 2.3.0
So we would need to update the included module, but I'm not sure we should do it in this version. I'm afraid we need to wait for the 177 version

Oh and this case is different from ps_themecusto which includes its own translations, this module has no translations embedded so we need to manage them in the core.
By the way even for ps_themecusto although it includes some translations, there are only three languages managed, but I guess it can be managed via the backoffice then?

Same comment as with gamification here

sarahdib · 2019-07-22T13:28:12Z

@jolelievre the issue 14633 is not solved :

For this issue 14337

Wording is ok for classic template but not for modern.

eternoendless · 2019-07-26T13:44:56Z

app/Resources/translations/default/AdminDesignNotification.xlf

-        <note>Line: 380</note>
-      </trans-unit>
-    </body>
-  </file>


Why are these wordings being deleted? We shouldn't delete any wording during the 1.7 lifecycle.

Maybe because the file was removed, but I'll revert this change so that nothing is removed

app/Resources/translations/default/messages.xlf

eternoendless · 2019-07-26T13:52:20Z

app/Resources/translations/default/messages.xlf

+  </file>
+  <file original="modules/ps_emailsubscription/ps_emailsubscription.php" source-language="en-US" target-language="en" datatype="plaintext">
+    <body>
+      <trans-unit id="2df860f82be52de57fc5e3f7ecac9431">


Same comment as with gamification here

eternoendless · 2019-07-26T13:54:15Z

mails/themes/classic/core/log_alert.html.twig

@@ -27,7 +27,7 @@
 {% endif %}
            <span>
              {{ '<span><strong>Warning:</strong></span> you have received a new log alert in your Back Office.'|trans({}, 'Emails.Body', locale)|raw }}<br/><br/>
-              {{ 'You can check for it in the <span><strong>"Tools" &gt; "Logs"</strong></span> section of your Back Office.'|trans({}, 'Emails.Body', locale)|raw }}
+              {{ 'You can check for it in the <span><strong>Advanced Parameters > Logs</strong></span> section of your back office.'|trans({}, 'Emails.Body', locale)|raw }}


Since this wording is being used raw, you need to keep the >

Suggested change

{{ 'You can check for it in the Advanced Parameters > Logs section of your back office.'|trans({}, 'Emails.Body', locale)|raw }}

{{ 'You can check for it in the Advanced Parameters > Logs section of your back office.'|trans({}, 'Emails.Body', locale)|raw }}

It would be best to get rid of the html in the wording, don't you think?

Suggested change

{{ 'You can check for it in the Advanced Parameters > Logs section of your back office.'|trans({}, 'Emails.Body', locale)|raw }}

{{ 'You can check for it in the [1]Advanced Parameters > Logs[/1] section of your back office.'|trans({'[1]' => '', '[/1]' => ''}, 'Emails.Body', locale)|raw }}

eternoendless · 2019-07-26T13:55:03Z

mails/themes/classic/core/productoutofstock.html.twig

@@ -28,7 +28,7 @@
            <span>
              {{ 'The remaining stock is now less than the specified minimum of'|trans({}, 'Emails.Body', locale)|raw }} <strong><span>{last_qty}.</span></strong><br/><br/>
              <strong><span>{{ 'Remaining stock:'|trans({}, 'Emails.Body', locale)|raw }}</span></strong> {qty}<br/><br/>
-              {{ 'You are advised to open the product\'s admin Product Page in order to replenish your inventory.'|trans({}, 'Emails.Body', locale)|raw }}
+              {{ 'Replenish your inventory, go to the <span><strong>Catalog > Stocks</span></strong> section of your back office to manage your stock.'|trans({}, 'Emails.Body', locale)|raw }}


Suggested change

{{ 'Replenish your inventory, go to the Catalog > Stocks section of your back office to manage your stock.'|trans({}, 'Emails.Body', locale)|raw }}

{{ 'Replenish your inventory, go to the Catalog > Stocks section of your back office to manage your stock.'|trans({}, 'Emails.Body', locale)|raw }}

eternoendless · 2019-07-26T13:55:14Z

mails/themes/classic/modules/ps_emailalerts/productoutofstock.html.twig

@@ -28,7 +28,7 @@
            <span>
              {{ 'The remaining stock is now less than the specified minimum of'|trans({}, 'Emails.Body', locale)|raw }} <strong><span>{last_qty}.</span></strong><br/><br/>
              <strong><span>{{ 'Remaining stock:'|trans({}, 'Emails.Body', locale)|raw }}</span></strong> {qty}<br/><br/>
-              {{ 'You are advised to open the product\'s admin Product Page in order to replenish your inventory.'|trans({}, 'Emails.Body', locale)|raw }}
+              {{ 'Replenish your inventory, go to the <span><strong>Catalog > Stocks</span></strong> section of your back office to manage your stock.'|trans({}, 'Emails.Body', locale)|raw }}


Suggested change

{{ 'Replenish your inventory, go to the Catalog > Stocks section of your back office to manage your stock.'|trans({}, 'Emails.Body', locale)|raw }}

{{ 'Replenish your inventory, go to the Catalog > Stocks section of your back office to manage your stock.'|trans({}, 'Emails.Body', locale)|raw }}

eternoendless · 2019-07-26T13:56:15Z

mails/themes/modern/core/order_canceled.html.twig

+                                    <tr>
+                                      <td align="left" style="font-size:0px;padding:10px 25px;word-break:break-word;">
+                                        <div style="font-family:Open sans, arial, sans-serif;font-size:14px;line-height:25px;text-align:left;color:#363A41;">
+                                          {{ 'Go to your customer account to learn more about it.'|trans({}, 'Emails.Body', locale)|raw }}


There's no HTML in this one, so why the raw?

You're right, removed!

eternoendless · 2019-07-26T14:01:05Z

mails/themes/modern/core/order_canceled.html.twig

-              <td
-                 class="" width="604px"
-              >
-


I suppose this removal is wanted?

Yes a text was moved inside inside a border, so the generated template was modified

…ng keys for emails

eternoendless

LGTM

marionf · 2019-08-07T10:06:27Z

Is it ready for QA ? I see no answer to this comment: #14719 (comment)

jolelievre · 2019-08-07T10:45:54Z

@marionf the PR is ready, although it's not simple to test because it mainly contains catalog updates, which then need to be sent to crowdin and translated so that the translation is effective.

You can test it manually for a few keys though, you need to copy a translation block from the default catalog, copy it in your fr-FR catalog - for example - and then modify the target field to check that it works.

Thus for the comment you mentioned you can copy this:

<file original="mails/themes/modern/core/order_conf.html.twig" source-language="en-US" target-language="en" datatype="plaintext">
    <body>
      <trans-unit id="fb077ecba55e5552916bde26d8b9e794">
        <source>Order confirmation</source>
        <target>Order confirmation</target>
        <note>Line: 3</note>
      </trans-unit>
      <trans-unit id="ca102bf009d3e0d62a4fc6918b20110e">
        <source>Thank you for shopping on [1]{shop_name}[/1]!</source>
        <target>Merci pour votre achat sur [1]{shop_name}[/1]!</target>
        <note>Line: 53</note>
      </trans-unit>
    </body>
  </file>

inside your app/Resources/translations/fr-FR/EmailsBody.fr-FR.xlf file

BUT on the other side the modif for this issue #14337 should be easier to test

jolelievre · 2019-08-07T10:49:03Z

By the way @eternoendless I just tested to translate manually a key containing > as we said, and as I feared it didn't match with the catalog key. So I had to modify the templates so that their keys contain a >
This is a quick fix but we should be careful about it in the next version, I don't know if the problem comes from the translator or the keys extraction (my guess is the later).

eternoendless · 2019-08-07T16:19:16Z

This should be investigated later, tracked by PrestaShop/TranslationToolsBundle#66

eternoendless

The catalogue must be re-exported again.

app/Resources/translations/default/EmailsBody.xlf

khouloudbelguith · 2019-08-08T14:53:37Z

Hi @jolelievre,

This ticket: #14337 is fixed except his issue: #14719 (comment)
To test this issue: #14633
I tried with this steps:

<file original="mails/themes/modern/core/order_conf.html.twig" source-language="en-US" target-language="en" datatype="plaintext">
    <body>
      <trans-unit id="fb077ecba55e5552916bde26d8b9e794">
        <source>Order confirmation</source>
        <target>Order confirmation</target>
        <note>Line: 3</note>
      </trans-unit>
      <trans-unit id="ca102bf009d3e0d62a4fc6918b20110e">
        <source>Thank you for shopping on [1]{shop_name}[/1]!</source>
        <target>Merci pour votre achat sur [1]{shop_name}[/1]!</target>
        <note>Line: 53</note>
      </trans-unit>
    </body>
  </file>

inside your app/Resources/translations/fr-FR/EmailsBody.fr-FR.xlf file

I tried to launch new installation, but I have this error:

Warning: Uncaught Symfony\Component\Debug\Exception\ContextErrorException: Warning: require(/projet/QA/QA/var/cache/dev/ContainerOkc5fca/getPrestashop_Core_CommandBusService.php): failed to open stream: No such file or directory in /projet/QA/QA/var/cache/dev/ContainerOkc5fca/appDevDebugProjectContainer.php:1692 Stack trace: #0 /projet/QA/QA/var/cache/dev/ContainerOkc5fca/appDevDebugProjectContainer.php(1692): require() #1 /projet/QA/QA/vendor/symfony/symfony/src/Symfony/Component/DependencyInjection/Container.php(304): ContainerOkc5fca\appDevDebugProjectContainer->load('getPrestashop_C...') #2 /projet/QA/QA/classes/Language.php(1165): Symfony\Component\DependencyInjection\Container->get('prestashop.core...') #3 /projet/QA/QA/classes/Language.php(1226): LanguageCore::generateEmailsLanguagePack(Array, Array, false) #4 /projet/QA/QA/classes/Language.php(1077): LanguageCore::updateLanguagePack('en', Array) #5 /projet/QA/QA/classes/Language.php(1268): LanguageCore::downloadAndInstallLanguagePack('en', NULL, NULL, false) # in /projet/QA/QA/var/cache/dev/ContainerOkc5fca/appDevDebugProjectContainer.php on line 1692

Thanks!

jolelievre · 2019-08-08T15:28:43Z

Hi @khouloudbelguith ,

you don't need to reinstall the shop, once you updated the xlf catalogue, you can see the change either in the Email theme preview page, or you can regenerate the emails for the french language and check the static files in mails/fr

jolelievre · 2019-08-08T15:30:14Z

About the error you get in the install process, it seems like a permission error on your cache folder during the install but I don't think it is linked to this issue nor the modif from this PR

khouloudbelguith · 2019-08-08T15:36:17Z

@jolelievre, thanks!
Yes, clear the cache => installation => OK
It is OK

Thanks!

khouloudbelguith · 2019-08-08T15:57:43Z

@jolelievre, In fact, in the BO => International => translation =>

Type of translation => Email translations
Select the type of email content => Body
Select your theme => Core
Select your language => Français

I tried to change the translations for the order_conf => successfully updated.
But in these changes are not applied
https://drive.google.com/file/d/18OwYleSBzuYBepmHJw1oXZ2zCDQuo-k5/view

Thanks!

jolelievre added this to the 1.7.6.1 milestone Jul 17, 2019

jolelievre requested a review from a team as a code owner July 17, 2019 15:22

prestonBot added 1.7.6.x Branch Bug Type: Bug labels Jul 17, 2019

PierreRambaud reviewed Jul 17, 2019

View reviewed changes

.t9n.yml Outdated Show resolved Hide resolved

PierreRambaud previously approved these changes Jul 18, 2019

View reviewed changes

PierreRambaud added the Waiting for QA Status: action required, waiting for test feedback label Jul 18, 2019

jolelievre added the Waiting for wording Status: action required, waiting for wording label Jul 18, 2019

eternoendless requested a review from LouiseBonnard July 18, 2019 13:19

eternoendless previously approved these changes Jul 18, 2019

View reviewed changes

LouiseBonnard reviewed Jul 19, 2019

View reviewed changes

jolelievre dismissed stale reviews from eternoendless and PierreRambaud via 984a908 July 19, 2019 18:39

jolelievre force-pushed the catalog-emails branch from 7665de2 to 1e522d0 Compare July 19, 2019 19:56

LouiseBonnard reviewed Jul 22, 2019

View reviewed changes

sarahdib added Waiting for author Status: action required, waiting for author feedback and removed Waiting for QA Status: action required, waiting for test feedback labels Jul 22, 2019

jolelievre mentioned this pull request Jul 22, 2019

Allow modifying email body contents #14809

Merged

LouiseBonnard added Wording ✔️ Status: check done, wording approved and removed Waiting for wording Status: action required, waiting for wording labels Jul 23, 2019

eternoendless changed the title ~~Scan trad keys from email themes~~ Scan translation keys from email themes Jul 26, 2019

prestonBot added the Waiting for wording Status: action required, waiting for wording label Jul 26, 2019

eternoendless requested changes Jul 26, 2019

View reviewed changes

jolelievre force-pushed the catalog-emails branch 3 times, most recently from e8a5bfd to 3c9afb1 Compare July 30, 2019 16:34

Change config to scan mails themes folders, update catalog with missi…

9720e38

…ng keys for emails

eternoendless previously approved these changes Aug 7, 2019

View reviewed changes

jolelievre dismissed eternoendless’s stale review via e14a8ea August 7, 2019 10:38

eternoendless mentioned this pull request Aug 7, 2019

Issue when extracting wordings containing HTML-escaped characters PrestaShop/TranslationToolsBundle#66

Open

eternoendless requested changes Aug 7, 2019

View reviewed changes

app/Resources/translations/default/EmailsBody.xlf Outdated Show resolved Hide resolved

Use real caret to match catalog translation keys

3d26fb6

jolelievre force-pushed the catalog-emails branch from e14a8ea to 3d26fb6 Compare August 8, 2019 07:56

Update XLF catalogues

6d33db1

eternoendless approved these changes Aug 8, 2019

View reviewed changes

eternoendless added Waiting for QA Status: action required, waiting for test feedback and removed Waiting for author Status: action required, waiting for author feedback Waiting for wording Status: action required, waiting for wording labels Aug 8, 2019

khouloudbelguith added Waiting for author Status: action required, waiting for author feedback and removed Waiting for QA Status: action required, waiting for test feedback labels Aug 8, 2019

khouloudbelguith removed the Waiting for author Status: action required, waiting for author feedback label Aug 8, 2019

khouloudbelguith added the Waiting for author Status: action required, waiting for author feedback label Aug 8, 2019

jolelievre merged commit 49b5b95 into PrestaShop:1.7.6.x Aug 8, 2019

eternoendless removed the Waiting for author Status: action required, waiting for author feedback label Aug 23, 2019

khouloudbelguith mentioned this pull request Sep 6, 2019

Can't translate emails #15433

Closed

jolelievre deleted the catalog-emails branch October 15, 2019 08:12

khouloudbelguith mentioned this pull request Jan 24, 2020

error in translation when using a theme other than classic in Prestashop 1.7.6.0 #17324

Closed

khouloudbelguith mentioned this pull request Feb 24, 2020

PS 1.7.6.3 e-mail Theme translate #17789

Closed

		@@ -1163,17 +1163,17 @@ Comment: check if some ids are in list_skip_actions and forbid deletion</note>
		<trans-unit id="3452da55a90ccedd184c7ba264b2afd5">
		<source>Due to memory limit restrictions, this image cannot be loaded. Please increase your memory_limit value via your server's configuration settings. </source>

	<source>An error occured, please check your zip file</source>
	<source>An error occurred, please check your zip file</source>

	{{ 'Replenish your inventory, go to the <span class="label">"Catalog" > "Stocks"</span> section of your back office to manage your stock.'\|trans({}, 'Emails.Body', locale)\|raw }}
	{{ 'Replenish your inventory, go to the <span class="label">Catalog > Stocks</span> section of your back office to manage your stock.'\|trans({}, 'Emails.Body', locale)\|raw }}

	{{ 'You can check for it in the <span><strong>Advanced Parameters > Logs</strong></span> section of your back office.'\|trans({}, 'Emails.Body', locale)\|raw }}
	{{ 'You can check for it in the <span><strong>Advanced Parameters > Logs</strong></span> section of your back office.'\|trans({}, 'Emails.Body', locale)\|raw }}

	{{ 'You can check for it in the <span><strong>Advanced Parameters > Logs</strong></span> section of your back office.'\|trans({}, 'Emails.Body', locale)\|raw }}
	{{ 'You can check for it in the [1]Advanced Parameters > Logs[/1] section of your back office.'\|trans({'[1]' => '<span><strong>', '[/1]' => '</strong></span>'}, 'Emails.Body', locale)\|raw }}

Scan translation keys from email themes #14719

Scan translation keys from email themes #14719

Conversation

jolelievre commented Jul 17, 2019 • edited by eternoendless

eternoendless left a comment

Choose a reason for hiding this comment

LouiseBonnard commented Jul 19, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jolelievre commented Jul 19, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sarahdib commented Jul 22, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eternoendless left a comment

Choose a reason for hiding this comment

marionf commented Aug 7, 2019 • edited

jolelievre commented Aug 7, 2019

jolelievre commented Aug 7, 2019

eternoendless commented Aug 7, 2019

eternoendless left a comment

Choose a reason for hiding this comment

khouloudbelguith commented Aug 8, 2019

jolelievre commented Aug 8, 2019

jolelievre commented Aug 8, 2019

khouloudbelguith commented Aug 8, 2019

khouloudbelguith commented Aug 8, 2019

jolelievre commented Jul 17, 2019 •

edited by eternoendless

marionf commented Aug 7, 2019 •

edited