Products.cmfplone: Merge translations into plone.app.locales

Created on 15 Sep 2015 · 64Comments · Source: plone/Products.CMFPlone

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:

[X] plone/plone.app.discussion#66
[x] plone/plone.app.event#181
[x] plone/plone.app.dexterity#158
[x] plone/plone.app.multilingual#191
[x] plone/plone.app.versioningbehavior#19
[X] plone/plone.app.lockingbehavior#3
[x] plone/plone.schemaeditor#34
[ ] zopefoundation/plone.z3cform (still no ticket, pending an answer on plone/buildout.coredev#139)
[X] plone/plone.schema#2
[x] plone/plone.formwidget.recurrence#19
[x] plone/plone.formwidget.namedfile#19 (and the previous pr)
[x] plone/plone.formwidget.datetime#16
[x] plone/plone.formwidget.autocomplete#17
[x] plone/plone.formwidget.contenttree#22
[x] plone/plone.app.caching#20 (plone.app.caching.po files in plone/app/locales/locales-addons but need to be moved to plone domain)
[X] plone/plone.app.referenceablebehavior#7
[x] plone/plone.app.widgets#125 (python part, js already in widgets.pot generated from mockup)
[X] plone/plone.cachepurging#4
[x] plone/plone.caching#2
[x] plone/plone.dexterity#79
[X] plone/plone.directives.form#4
[x] plone/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 https://github.com/plone/plone.app.discussion/commit/0713bcd8bc14a9f8d7fd5bb7f80083871d465435 and https://github.com/plone/plone.app.discussion/commit/19fe2549163ebe7effb844b5d456680a51bca1f9)
modify experimental/i18n.cfg in buildout.coredev 5.1 to include the target package in plone domain. See https://github.com/plone/buildout.coredev/commit/802549d6da0609063cd3edaf6099ec356e5354ca
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!

enhancement low easy

Source

esteele

Most helpful comment

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

Shall the issue be closed then?

gforcada on 20 Mar 2018

🎉2

All 64 comments

There is also plone.app.multilingual

bloodbare on 15 Sep 2015

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

vincentfretin on 16 Sep 2015

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 ?

claytonc on 4 Nov 2015

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.

jensens on 4 Nov 2015

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

vincentfretin on 4 Nov 2015

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

claytonc on 4 Nov 2015

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 on 4 Nov 2015

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

jensens on 4 Nov 2015

claytonc on 4 Nov 2015

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

vincentfretin on 4 Nov 2015

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

claytonc on 4 Nov 2015

yes please.

jensens on 4 Nov 2015

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 :-)

gforcada on 5 Nov 2015

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 on 6 Nov 2015

And I will merge french translation.

claytonc on 6 Nov 2015

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