https://github.com/hoereth/i18n-maven-plugin
:tropical_fish: A language file generator for creating error-free Java properties, Xcode strings files, Javascript files. You will maintain your translations in one XML file.
https://github.com/hoereth/i18n-maven-plugin
generate-resources i18n java javascript maven-plugin properties translation
Last synced: 6 months ago
JSON representation
:tropical_fish: A language file generator for creating error-free Java properties, Xcode strings files, Javascript files. You will maintain your translations in one XML file.
- Host: GitHub
- URL: https://github.com/hoereth/i18n-maven-plugin
- Owner: hoereth
- License: mit
- Created: 2018-01-12T22:56:55.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-09-06T10:08:44.000Z (almost 5 years ago)
- Last Synced: 2025-07-30T10:44:41.336Z (11 months ago)
- Topics: generate-resources, i18n, java, javascript, maven-plugin, properties, translation
- Language: Java
- Homepage:
- Size: 368 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# :tropical_fish: i18n-maven-plugin
Generator for language files. Currently supported target formats: [JAVA](doc/README_JAVA.md), [STRINGS (Xcode)](doc/README_STRINGS.md), [JAVASCRIPT](doc/README_JAVASCRIPT.md).
## Maven Goals
* de.pentabyte.tools:i18n-maven-plugin:**translate** ([i18n.xml](src/test/resources/i18n.xml) => language files)
* de.pentabyte.tools:i18n-maven-plugin:**reengineer** (language files => [i18n.xml](src/test/resources/i18n.xml), only available for [JAVA](doc/README_JAVA.md) & [STRINGS](doc/README_STRINGS.md)).
## Motivation
Language files are designed for application performance NOT for easy maintenance. Technical translation mistakes usually remain undetected. This plugin suggests that you rather maintain your translations in a structured and bullet-proof [i18n.xml](src/test/resources/i18n.xml) table file. The plugin will then generate the language files of your choice. This is one more build step, but the following issues will be taken care of:
### Correct Syntax
The plugin will create the language files for you with all their peculiarities. Examples:
* JAVA properties: They must be **Latin1** encoded (for Java <= 8, [Java 9](https://docs.oracle.com/javase/9/docs/api/java/util/Properties.html) has changed the default to UTF-8). UTF-8 characters can be escaped like this: **ä = \u00E4**. You have to deal with edge cases like the exclamation mark or colon character - they need to be escaped with a backslash (**\\! \\:**). Logical line breaks need to be terminated with a backslash.
* STRINGS (Xcode): They must be UTF-16 encoded.
### Consistency
No more typos in the keys. No more forgotten translations. The plugin even offers a language fallback mechanism, which allows you to temporarily fill missing translations with a secondary language (see _<locale-config>_ element of example [i18n.xml](src/test/resources/i18n.xml#L9) file).
### Redundancy
The XML design gets rid off quite a few redundancies. On top off that, the plugin provides a placeholder mechanism to avoid redundant translations. Example: "The application ${someTranslationKey.forAppName} will now exit."
### Structure
No need for "fake" grouping via composite key structures. XML naturally supports nested structures. The translations of all languages will be next to each other, which helps the translator. I might even say that I started to enjoy doing translations. ;) Also, you will find the perfect location to add a description for each translation entry to further explain the intent to the translator.
## Getting started
### i18n.xml Table File(s)
These will be the source of your translations for any kind of programming language. You can have more than one per project. You can put it anywhere in your project, because we will usually configure the plugin to pick up all files named **i18n.xml**. Please see [this example i18n.xml file](src/test/resources/i18n.xml), which is configured to result in all different kinds of language files. Editing is almost self-explanatory, if your editor supports the provided XSD schema.
### Configuration
The plugin provides these configuration params:
- **tableDirectory** — Recursivly check for all "i18n.xml"-Tables within that directory. Default: *${basedir}*
- **tableFile** — Path of i18n-Table. (for when you only have one)
- **inputBasename** — Base name of XML-Table-File(s). Default: *i18n*
- **targetDir** — Base directory of generated source code files. Use case: accessor files. Default: *${basedir}/src/main/java*
Please note that you can alternatively specifiy the following parameters within the _<output>_ element of each of your [i18n.xml](src/test/resources/i18n.xml#L17) files:
- **outputDirectory** — Language Files should be written here. Defaults to directory of respective table file.
- **outputFormat** — [JAVA_PROPERTIES](doc/README_JAVA.md), [STRINGS](doc/README_STRINGS.md), [JAVASCRIPT](doc/README_JAVASCRIPT.md)
- **outputBasename** — Base name of language files. Defaults according to outputFormat.
- **keySeparator** — Keys of nested entries will be separated with this value. Default: *dot*.
### Target Format
To get more into detail, please continue reading the appropriate README file. However, you can mix formats within one project. You will also find information about the usage of the reengineer plugin, if available:
- [JAVA project with Properties Files](doc/README_JAVA.md)
- [Xcode project with Strings Files](doc/README_STRINGS.md)
- [Web project with Javascript Files](doc/README_JAVASCRIPT.md)