Errai i18n Approach

Proposed approach:

1. Multiple message bundles

1. Automatically add “errai-i18n.json” if one is present??
2. @Bundle annotation declares additional bundles
3. @Bundle points to a root JSON message bundle file
4. The JSON file must exist and 0 or more translation files MAY exist
5. Each blah.json (set of files) results in a Translation being created

2. TranslationService to aggregate the Translations

1. @ApplicationScoped
2. Each Translation is added to the registry and aggregated

3. When translating a template:

1. Use the TranslationService to lookup i18n values from i18n keys

1. Lookup is done using current Locale info

2. Visit the Template element, find all translatable nodes

1. If a node has a data-i18n-skip attribute, it is *not* translatable
2. If a node has only text content, it is translatable
3. If a node has a data-i18n-key attribute, it is translatable
4. Once a translatable node is found, stop visiting down
5. If a node has either placeholder or title attributes, then those attributes are translatable
6. NOTE: solve the img src= problem (data-i18n-attributes=”[csv]”)

3. For each translatable node,

1. Generate translation key for node

1. Look for data-i18n-key attribute
2. If not found, generate key from text content
3. Prefix key with template short name

2. Lookup new value in TranslationService (might be HTML - how to make this safe?)
3. Replace translatable node content with value from TranslationService
4. Use current locale to lookup new value - from most to least specific (e.g. look first in _de_DE, then look in _de, then look in root).

Usage Notes

• Need an automatic way to exclude some content from translation candidacy.

• If an element has no children (text-only) and has a data-field attribute, it should probably not be translated

• Problem getting jtidy to be on the classpath when running in Eclipse hosted mode
• Would be nice to be able to inject the translation service

• Useful when formatting dates/numbers in dynamic content
• Provides a way to use the translation service without using templates?  Directly to fields perhaps?

• Also pull in errai-bundle.json standard bundle file(s)
• Use IDs for i18n keys (and data-field attributes)
• Share visit/traverse algorithm between runtime and compile time