Skip to main content

Multilingual extensions core package

Project description


This package contains the core functionality for the next generation multilingual engine for Plone.

For more information about, please visit:

These are the main artifacts and its purposes:

  • the canonical organizes the information about a “translation-group”
  • it’s using a dictionary with language-codes as keys and uuids (provided by plone.uuid) as values
  • persistent storage, which holds the canonicals in an IOBTree
  • the OOBTree’s key is the UUID of the content, the according value is the canonical
  • adapter for ITranslatable
  • provides the translations API
  • ITranslationLocator - where to put a translation
  • ITranslationIdChooser - generates a valid id for a translation
  • ITranslationCloner - copy the language-independent content to the translation
  • ITranslationFactory - creates the translation

In order to have a test we have a type called Demo that has an adapter called DemoLanguage that will allow to get the language of the object:

>>> from plone.multilingual.interfaces import ITranslationManager
>>> from plone.multilingual.interfaces import ILanguage
>>> from import setRoles, login, TEST_USER_ID, TEST_USER_NAME

>>> portal = layer['portal']
>>> setRoles(portal, TEST_USER_ID, ['Manager'])
>>> login(portal, TEST_USER_NAME)
>>> portal.invokeFactory('Folder', 'ob1', title=u"An archetypes based folder")

>>> ILanguage(portal['ob1']).set_language('ca')

Ensuring that the new object gets its UUID:

>>> from plone.uuid.interfaces import IUUID
>>> ob1_uuid = IUUID(portal['ob1'])
>>> isinstance(ob1_uuid, str)

We create a new translation in ‘en’ language:

>>> ITranslationManager(portal['ob1']).add_translation('en')

We try to create a new translation in ‘ca’ that already exists:

>>> ITranslationManager(portal['ob1']).add_translation('ca')
Traceback (most recent call last):
KeyError: 'Translation already exists'

We try to create a new translation without language:

>>> ITranslationManager(portal['ob1']).add_translation(None)
Traceback (most recent call last):
KeyError: 'There is no target language'

We get the ‘en’ translation:

>>> ITranslationManager(portal['ob1']).get_translation('en')
<ATFolder at /plone/ob1-en>
>>> ILanguage(ITranslationManager(portal['ob1']).get_translation('en')).get_language() == 'en'

let’s get all the translations:

>>> ITranslationManager(portal['ob1']).get_translations()
{'ca': <ATFolder at /plone/ob1>, 'en': <ATFolder at /plone/ob1-en>}

let’s get only the languages:

>>> ITranslationManager(portal['ob1']).get_translated_languages()
['ca', 'en']


>>> ITranslationManager(portal['ob1']).has_translation('en')

>>> ITranslationManager(portal['ob1']).has_translation('it')

register_translation with invalid language:

>>> ITranslationManager(portal['ob1']).remove_translation('en')
>>> ITranslationManager(portal['ob1']).register_translation('', portal['ob1-en'])
Traceback (most recent call last):
KeyError: 'There is no target language'

register a translation with content:

>>> ITranslationManager(portal['ob1']).register_translation('en', portal['ob1-en'])
>>> ITranslationManager(portal['ob1']).get_translations()
{'ca': <ATFolder at /plone/ob1>, 'en': <ATFolder at /plone/ob1-en>}

changing the content-language (there should act a subscriber):

>>> ILanguage(portal['ob1-en']).set_language('it')
>>> from zope.event import notify
>>> from zope.lifecycleevent import ObjectModifiedEvent
>>> notify(ObjectModifiedEvent(portal['ob1-en']))
>>> ITranslationManager(portal['ob1']).get_translations()
{'ca': <ATFolder at /plone/ob1>, 'it': <ATFolder at /plone/ob1-en>}

test the delete-subscriber:

>>> from OFS.event import ObjectWillBeRemovedEvent
>>> notify(ObjectWillBeRemovedEvent(ITranslationManager(portal['ob1']).get_translation('it')))
>>> ITranslationManager(portal['ob1']).get_translations()
{'ca': <ATFolder at /plone/ob1>}



>>> from plone.multilingual.interfaces import ITranslationIdChooser
>>> chooser = ITranslationIdChooser(portal['ob1-en'])
>>> chooser(portal, 'es')


>>> ITranslationManager(portal['ob1']).add_translation('es')
>>> child_id = portal.ob1.invokeFactory('Folder', 'ob1_child', language="ca")

>>> from plone.multilingual.interfaces import ITranslationLocator
>>> locator = ITranslationLocator(portal['ob1-en'])
>>> locator('es') == portal

>>> child_locator = ITranslationLocator(portal.ob1.ob1_child)
>>> child_locator('es') == portal['ob1-es']

>>> ITranslationManager(portal['ob1']).remove_translation('es')

Convert intids to uuids upgrade step

An upgrade step is available in case of having an existing site with the experimental 0.1 plone.multilingual version:

>>> from plone.multilingual.upgrades.to02 import upgrade


You must reinstall the plone.multilingual package in order to install the required new utility in place before upgrading. If you are using a version of Dexterity below 2.0, you must install the package and enable the Referenceable ( behavior for all your Dexterity content types before you attempt to upgrade your site.

You can run the @@pml-upgrade view at the root of your site or follow the upgrade step in portal_setup > upgrades. If you can’t see the upgrade step, press Show old upgrades and select the Convert translation based intids to uuids (0.1 → 02)

Upgrade to catalog

>>> from plone.multilingual.upgrades.to03 import upgrade

we shouldn’t find the storage-utility anymore:

>>> from plone.multilingual.interfaces import IMultilingualStorage
>>> gsm = portal.getSiteManager()
>>> gsm.queryUtility(IMultilingualStorage) is None


1.0 2013-04-16

  • Moved adding catalog indexes to a setuphandler step in PAM. Added testing profile to still add those indexes via Generic Setup, but only for testing [pysailor]

1.0rc1 2013-01-26

  • Moved the external tool to catalog and added content attribute [ramon]
  • Upgrade steps from b3 to rc1 [ramon]
  • Fixed bugs on subscribers [sneridagh]
  • Make import of upgrade step “to02” depend on the existence of plone.dexterity [pysailor]
  • Added get_restricted_translations [ramon]

1.0b3 2012-10-04

  • added TestSubscribers to test subscribers for IObjectAddedEvent, IObjectCopiedEvent and IObjectMovedEvent [gborelli]
  • Do not raise a KeyError when registering or adding a language independent translation. [maurits]
  • Take account on the use case where user could do and do changes on the translations groups and its members. Be sure that it does not leaves any traces of orphan objects in the storage. [ramon, sneridagh]
  • Added Copy/Paste subscribers [ramon]
  • Moved generic AddContent subscribers to check language integrity [ramon]
  • Bug solving on ITranslationLocator [ramon]
  • Updating language, checking translations integrity [ramon]

1.0b2 - 2012-07-09

  • Change Language Independent identifier to ‘’ [ramon]
  • Fixed the uninstall profile. [maurits]

1.0b1 - 2012-04-03

  • No changes.

0.2b3 - 2012-04-03

  • Remove get_field_names from api. [jcbrand]
  • Add IDefaultLanguageIndependentFieldsManager and adapter. [jcbrand]
  • Reindex object after creation. [ramon]

0.1a2 - 2011-10-20

  • Updated testing facilities to Plone Core packages style. [sneridagh]
  • Migrated from bare intids to plone.uuid facilities. [sneridagh]
  • Due to the previous change from this version to above, it’s only compatible with Plone 4.1 and above. [sneridagh]
  • Added upgrade step and upgrade browser view to convert the 0.1a1 intids based utility to the 0.1a2 uuids based one. [sneridagh]

0.1a1 - 2011-10-03

  • Initial version [ramon, awello, sneridagh]

Project details

Release history Release notifications

History Node


History Node


History Node


History Node


This version
History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
plone.multilingual-1.0-py2.7.egg (45.3 kB) Copy SHA256 hash SHA256 Egg 2.7 Apr 16, 2013
plone.multilingual-1.0.tar.gz (19.5 kB) Copy SHA256 hash SHA256 Source None Apr 16, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page