Merge translations into plone.app.locales

[esteele]

We have some packages that started their lives as non-core addons, but didn't merge their translations into plone.app.locales when they were added to core.

See:

• Move translations to plone.app.locales. plone.app.discussion#66
• move translations to plone domain and maybe even plone.app.locales plone.app.event#181
• move translations to plone.app.locales plone.app.dexterity#158
• Move Translations to plone.app.locales plone.app.multilingual#191
• Move Translations to plone.app.locales plone.app.versioningbehavior#19
• changed i18n_domain to "plone" plone.app.lockingbehavior#3
• Move translations to plone.app.locales plone.schemaeditor#34
• zopefoundation/plone.z3cform (still no ticket, pending an answer on Transfer plone.z3cform to plone org? buildout.coredev#139)
• Remove own i18n domain plone.schema#2
• Translations to p.a.locale plone.formwidget.recurrence#19
• Remove locales folder plone.formwidget.namedfile#19 (and the previous pr)
• Use plone i18n domain plone.formwidget.datetime#16
• Use plone i18n domain plone.formwidget.autocomplete#17
• Move Translations to plone.app.locales plone.formwidget.contenttree#22
• Move Translations to plone.app.locales plone.app.caching#20 (plone.app.caching.po files in plone/app/locales/locales-addons but need to be moved to plone domain)
• Moved translations to plone.app.locales plone.app.referenceablebehavior#7
• Move Translations to plone.app.locales plone.app.widgets#125 (python part, js already in widgets.pot generated from mockup)
• Change i18n_domain to "plone" plone.cachepurging#4
• Use plone i18n domain plone.caching#2
• Move translations into plone.app.locales plone.dexterity#79
• Update i18n domain plone.directives.form#4
• Move translations to plone.app.locales Products.CMFDiffTool#31

[edit by @jensens] added 2 packages
[edit by @gforcada] added a bunch more

HOW TO
[remixed by @gforcada from https://github.com/plone/plone.app.event/issues/181#issuecomment-96406149 thanks @vincentfretin]

• get a working buildout.coredev checkout
• checkout the target package (./bin/develop co $PACKAGE_NAME)
• modify the target package to use the plone domain (see plone/plone.app.discussion@0713bcd and plone/plone.app.discussion@19fe254)
• modify experimental/i18n.cfg in buildout.coredev 5.1 to include the target package in plone domain. See plone/buildout.coredev@802549d
• run bin/buildout -c experimental/i18n.cfg on buildout.coredev 5.1
• use bin/i18n plone to regenerate plone.pot and resync plone files. (If there is any removed messages, be sure to look if this is normal, it may be an issue you have to fix before continuing your work)
• use bin/i18ndude admix command to transfer translated messages from the target package to plone.po for each language. Something like this:

P_A_LOCALES="src/plone.app.locales/plone/app/locales/locales"
TARGET_PACKAGE="src/plone.app.discussion/plone/app/discussion/locales"
PO_FILE="plone.app.discusion.po"
locales=`cd ${TARGET_PACKAGE}; ls | /bin/grep -v .pot`

for locale in $locales;
do
    bin/i18ndude admix ${P_A_LOCALES}/$locale/LC_MESSAGES/plone.po ${TARGET_PACKAGE}/$locale/LC_MESSAGES/${PO_FILE} > ${P_A_LOCALES}/$locale/LC_MESSAGES/plone.po.tmp
    mv ${P_A_LOCALES}/$locale/LC_MESSAGES/plone.po.tmp ${P_A_LOCALES}/$locale/LC_MESSAGES/plone.po
done

• commit, push (on branches) and create pull requests for both the target package and plone.app.locales
• add an extra commit on the target package to remove the locales folder (don't forget to remove the i18n:registerTranslations directive in configure.zcml)
• another pull request on buildout.coredev with the experimental/i18n.cfg update
• they need to be merged all 3 together
• remember to add changelog entries on the target package and plone.app.locales!
• last thing: add the pull request on this comment and tick the checkbox!

[bloodbare]

There is also plone.app.multilingual

[vincentfretin]

and maybe plone.app.multilingual and plone.app.versioningbehavior

[claytonc]

I found plone.app.contenttypes and plone.app.lockingbehavior not translated.
I'm already translating it.
I will add in plone.app.locales.
The files "plone.app.contenttypes.pot" and "plone.app.lockingbehavior" has to be created inside locales-addons? Correct ?

[jensens]

plone.app.contenttypes are mainly in the plone i18n-domain. Is there an own plone.app.contenttypes i18n-domain defined somehwere? if yes: create a pot file for it.

plone.app.versioningbehavior is translated here:
https://github.com/plone/plone.app.versioningbehavior/tree/master/plone/app/versioningbehavior/locales
So files has just to be copied over to plone.app.locales and removed at the original place.

[vincentfretin]

plone.app.contenttypes translations are in the plone domain in plone.app.locales.

[claytonc]

Is it better to change "plone.app.contenttypes" domain at the file plone.app.contenttypes/plone/app/contenttypes/behaviors/configure.zcml to "plone"?

[jensens]

plone.app.lockingbehavior has one string Locking ind the domain plone.app.lockingbehavior - I propose to change the zcml and put it into the plone domain and translate it there.

[jensens]

+1 for using not that many i18n-domains.
if there are less than 5-10 messages i'd not use an own file.

[claytonc]

+1

[vincentfretin]

yes please change to i18n_domain="plone" in configure.zcml if it's still i18n_domain="plone.app.contenttypes"

[claytonc]

Okay! I changed i18n_domain and should I change plone.app.lockingbehavior too ?

[jensens]

yes please.

[gforcada]

On a fully checked out buildout.coredev (see branch all-sources) there were quite a few more packages that were defining their own translation domain.

I added all of them on the first message, edit and fix at will :-)

[claytonc]

In product plone.app.referenceablebehavior I will to change the zcml and put it into the plone domain and translate it there. And I will delete locales folder and edit configure.zcml removing reference for folder.

[claytonc]

And I will merge french translation.

[ale-rt]

Since 3.4.5 i18ndude supports chameleon, so there should be no need to "modify your local zope.tal".

This lines should also go:

• https://github.com/plone/buildout.coredev/blob/802549d6da0609063cd3edaf6099ec356e5354ca/experimental/i18n.cfg#L1-L5

[vincentfretin]

Thanks @ale-rt I didn't see the new version, I updated the instructions in the i18n.cfg file.

[vincentfretin]

@gforcada Thanks for beginning this work. I'm glad I'm not the only one anymore to know how to update Plone translations.
For the script in the first comment, I think it's not complete. This:

    bin/i18ndude admix ${P_A_LOCALES}/$locale/LC_MESSAGES/plone.po ${TARGET_PACKAGE}/$locale/LC_MESSAGES/${PO_FILE} > ${P_A_LOCALES}/$locale/LC_MESSAGES/${PO_FILE}.po

should be:

    bin/i18ndude admix ${P_A_LOCALES}/$locale/LC_MESSAGES/plone.po ${TARGET_PACKAGE}/$locale/LC_MESSAGES/${PO_FILE} > ${P_A_LOCALES}/$locale/LC_MESSAGES/plone.po.tmp
    mv ${P_A_LOCALES}/$locale/LC_MESSAGES/plone.po.tmp ${P_A_LOCALES}/$locale/LC_MESSAGES/plone.po

I edited the first comment with this solution.

[gforcada]

@vincentfretin the mv is on the next bullet point :-) I just removed it because now is redundant

[vincentfretin]

We should do a i18ndude find-untranslated on all packages too. I did it only for Products.CMFPlone at the ploneconf sprints and fixed several issues.

[vincentfretin]

@mauritsvanrees It should be good now.

[mauritsvanrees]

@vincentfretin Very good. Thank you!

[lukasgraf]

@vincentfretin I'm not clear about the background of this change, but your commit in plone.formwidget.datetime to depend on plone.app.locales >= 4.3.9 broke Plone 4.3 buildouts that include plone.app.contenttypes (1.1.x):

Version and requirements information containing plone.app.locales:
  [versions] constraint on plone.app.locales: 4.3.7
  Requirement of Products.CMFPlone: plone.app.locales
  Requirement of plone.formwidget.datetime[z3cform]: plone.app.locales>=4.3.9
  Requirement of plone.formwidget.datetime>=1.1: plone.app.locales>=4.3.9
  Requirement of plone.app.locales: setuptools
While:
  Installing instance.
Error: The requirement ('plone.app.locales>=4.3.9') is not allowed by your [versions] constraint (4.3.7)

For example, the plone.app.contenttypes 1.1.x buildout will fail like that.

---

http://dist.plone.org/release/4.3-latest/versions.cfg pins

plone.app.contenttypes = 1.1b5
plone.app.event = 1.1.5
plone.app.locales = 4.3.7

• p.a.event 1.1.5 depends on plone.formwidget.datetime>=1.1
• The most recent plone.formwidget.datetime then depends on plone.app.locales >= 4.3.9
• That pin conflicts with plone.app.locales = 4.3.7 from the 4.3-latest KGS.

(Let me know if you'd like me to open up a separate issue for this somewhere - I'll then move my comment accordingly).

[vincentfretin]

@lukasgraf The explicit dependency is intentional so you don't end up with the datetime widget only in English. I want the buildout to fail :) Several solutions here:

• pin plone.formwidget.datetime to 1.2 (instead of 1.3 you get when you don't pin)
• pin plone.app.locales to 4.3.9
• wait Plone 4.3.8 to be released which include plone.app.locales 4.3.9

[erral]

Moving plone.app.multilingual translations into plone.app.locales:

plone.app.multilingual master is used both for Plone 5.0.x and 5.1.x, so I included the translations in both 5.x and master branches of plone.app.locales.

plone/plone.app.multilingual#306

collective/plone.app.locales#200
collective/plone.app.locales#201

plone/buildout.coredev#429
plone/buildout.coredev#430

[vincentfretin]

LGTM @erral If nobody disagree, you can merge all those PR.

[erral]

The pull-requests for p.a.multilingual are failing in an unrelated way:

https://jenkins.plone.org/job/pull-request-5.0/415/#showFailuresLink
https://jenkins.plone.org/job/pull-request-5.1/955/#showFailuresLink
https://jenkins.plone.org/job/pull-request-5.2/466/#showFailuresLink

Should I merge or try to reproduce and fix before merging?

[erral]

Sorry, it's not unrelated. I have a missing msgid to move

[erral]

OK, p.a.multilingual tests are expected to fail until all pull requests are merged, because they depend on a translation coming from plone.app.locales. So I'm merging them.

[erral]

Moving plone.dexterity translations:

These are PRs to include plone.dexterity's translations into plone.app.locales.

These are for Plone 5.1.x:

plone/plone.dexterity#80
plone/buildout.coredev#431
collective/plone.app.locales#204

I messed up with the translations, so I retired the former PRs and issued new ones.

plone/plone.dexterity#82
plone/buildout.coredev#434
collective/plone.app.locales#208

These are the PR for Plone 5.0.x:

plone/plone.dexterity#81
plone/buildout.coredev#432
collective/plone.app.locales#205
plone/plone.dexterity#83
plone/buildout.coredev#435
collective/plone.app.locales#209

[erral]

PR for Products.CMFDiffTool:

plone/Products.CMFDiffTool#32

[erral]

PR for plone.app.caching

plone/buildout.coredev#439
plone/plone.app.caching#42
collective/plone.app.locales#210

[vincentfretin]

@erral Thanks for your work. You should start merging all those PR before you have any conflicts.

[erral]

Thanks for your guide too, it was very useful to get things done.

[erral]

I also created a PR to include those files in 5.2 branch of coredev: plone/buildout.coredev#440

[vincentfretin]

Yes indeed, it should be in sync with 5.1 branch, thanks.

[gforcada]

All done?!! Cool thanks to everyone for working on this!

Shall the issue be closed then?

[erral]

On the list above there is stille an open thing: plone.z3cform, but it's still an open issue whether it should be moved to plone organisation or not.

[gforcada]

Well, then we can close it and add on that ticket that as soon as we move it, if we ever do, translations should also get merged into plone.app.locales.