Plugin Documentation

Goals available for this plugin:

Goal Description
i18n:available-converters Mojo used to display available BundleFormatConverter. Created: 09/05/11
i18n:bundle Generate an aggregate i18n bundle for all dependencies of the project. The main idea is to have a final unique i18n bundle for an application to launch, this really improve i18n loading time to have a unique named bundle, no need to seek in all dependencies... Moreover, this permits also to deal with order of i18n keys, more precisely, we want to use the higher level i18n key for an application. If the i18n key is present on a library, we want to be able to override it in application (or user wants it:)). This goal permits this using the dependencies graph order of artifacts.
i18n:check-bundles-integrity Check bundles integrity. That all keys have a value in all bundles.
i18n:collect-i18n-artifacts Detects any i18n artifacts in the dependencies of the project and store their references in a file. The generated file will be used by bundle mojo to generate the final aggregated bundle.
i18n:gen Merge new generated i18n bundles with older existing ones.
i18n:generate-csv-bundle To generate a csv file from the full bundle of the module. The csv file will have a first column with i18n keys, and a column for each locale defined in locales. Created on 7/26/14.
i18n:generateI18nEnumHelper Generate a i18n enum class helper. Created on 28/08/16.
i18n:get Recupere les différents fichiers des parsers en un fichier de proprietes.
i18n:help Display help information on i18n-maven-plugin.
Call mvn i18n:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
i18n:merge-back-csv-bundle To merge back from a csv bundle to a module i18n bundle files. Created on 7/26/14.
i18n:parserGWTJava To detect from GWT java files new I18n keys, says content of patterns :
  • @Key("XXX")
  • @LocalizableResource.Key("XXX")
  • @com.google.gwt.i18n.client.LocalizableResource.Key("XXX")
Note: this goal must always be invoked before the process-resources phase, otherwise all files will be considered as uptodate.
i18n:parserJava To parse java files to detect new i18n keys. Note: this goal must always be invoked before the process-resources phase, otherwise all files will be considered as uptodate.
i18n:parserStruts2 To parse struts2 jsp and obtain all keys.
i18n:parserValidation Find i18n keys from xworks xml validation files. Note: this goal must always be invoked before the process-resources phase, otherwise all files will be considered as uptodate.
i18n:parserXml To obtain i18n keys from xml files using the userRulesFiles (and an optional coreRuleFile if any serves your purpose). Note: this goal must always be invoked before the process-resources phase, otherwise all files will be considered as uptodate.
i18n:split-csv-bundle To split a previously csv i18n file into simple i18n bundles for the locales defined in locales. The order of locales will be used to extract for each locale i18n bundle (means the order defined in the csv file is not used). Make sure to use exactly the same order. Created on 7/26/14.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 2.0
JDK 1.8
Memory No minimum requirement.
Disk Space No minimum requirement.

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.nuiton.i18n</groupId>
          <artifactId>i18n-maven-plugin</artifactId>
          <version>4.1</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.nuiton.i18n</groupId>
        <artifactId>i18n-maven-plugin</artifactId>
        <version>4.1</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"