jarn.jsi18n 1.1

Usage

Your package should depend on jarn.jsi18n and include it in its meta-data dependencies.

In order to instantiate a MessageFactory and use it you will need to load the i18n catalog. Typically, this will be done in a way similar to:

$(document).ready(function () {
    jarn.i18n.loadCatalog('plone', 'el');
    _ = jarn.i18n.MessageFactory('plone')
});

The second parameter in loadCatalog specifying the language is optional, when omitted the lang attribute in the html tag is used.

Now that we have a message factory we can use it to get translated strings:

> _('Contributor');
Συντελεστής

or with keyword parameters:

> _('Groups are: ${names}', {names: 'Jarnians'})
"Οι ομάδες είναι: Jarnians "

You can if you wish load multiple catalogs (or languages for the same catalog) and instantiate their respective factories, for instance:

> jarn.i18n.loadCatalog('plone', 'es');
> _es = jarn.i18n.MessageFactory('plone', 'es');
> _es('Contributor');
"Contribuyente"

Caching

If the client browser supports local storage it will be used to store the catalogs that you load. This makes it possible to avoid making an ajax request every time in order to load the full catalog. The stored catalog is by default valid for 24 hours. You can set the time-to-live by calling jarn.i18n.setTTL(millis) passing in milliseconds for how long the local storage cache should remain valid. Note that if local storage is supported, and the cache has not expired, the browser will NOT reload a catalog even if it changes in the filesystem.

1.1 - 2014-07-10

• Fix for Internet Explorer 8, defining Date.now() in jsi18n.js: IE8 does not know Date.now() by default [kysr]

1.0 - 2013-01-25

• courtesy release so people don’t get version 0.11 over 0.3. Also, about time for a 1.0…

0.3 - 2012-12-17

• Do not cache null catalog contents [cambell-bika]

• simpler MessageFactory [mmariani]

0.2 - 2011-12-6

• A few bug fixes. [ggozad]

• Test coverage with jasmine.js [ggozad]

0.11 - 2011-11-01

• Fix typos.

0.1 - 2011-11-01

• First release.