Built by Maven

i18n:generate-csv-bundle

Full name:

org.nuiton.i18n:i18n-maven-plugin:4.1:generate-csv-bundle

Description:

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.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 3.3.
  • Binds by default to the lifecycle phase: generate-resources.

Required Parameters

Name Type Since Description
<bundleCsvFileName> String 3.3 Location of the csv file to split.
Default value is: ${i18n.bundleOutputName}-i18n.csv.
User property is: i18n.bundleCsvFile.
<bundleOutputDir> File 3.3 Root directory where to generate aggregated bundles (this directory will be added as resources of the project).
Default value is: ${project.build.directory}/generated-sources/resources.
User property is: i18n.bundleOutputDir.
<bundleOutputName> String 3.3 Name of the bundle to use.
Default value is: ${project.artifactId}-i18n.
User property is: i18n.bundleOutputName.
<bundleOutputPackage> String 3.3 Package name of the generate aggregated bundles. Note: By default we use the META-INF package since it is the favorite package of I18n runtime initializer. The package name is dotted as it will be stored as folder like in Java language. Example : 
    package name : foo.bar
    directory    : foo/bar

Default value is: META-INF.
User property is: i18n.bundleOutputPackage.
<bundles> String 3.3 Locales to treate, separated by comma. Example : 
fr_FR,en_GB

Default value is: fr_FR,en_GB.
User property is: i18n.bundles.
<encoding> String 3.3 Encoding used to load and store properties.
Default value is: ${project.build.sourceEncoding}.
User property is: i18n.encoding.

Optional Parameters

Name Type Since Description
<addInClassPath> boolean 3.3 To add the generated csv file in the classpath. If bundleCsvDirectory is filled, then will add the generated csv file at the root of class-path, otherwise will add add it in the bundleOutputPackage package.
Default value is: true.
User property is: i18n.addInClassPath.
<bundleCsvDirectory> File 3.3 If you want to specify where to generate the csv file. If not filled, then will generate it in the same directory where bundles are stored.
User property is: i18n.bundleCsvDirectory.
<bundleCsvSeparator> char 3.3 Char separator in the csv bundle file.
Default value is: .
User property is: i18n.bundleCsvSeparator.
<bundleInputEncoding> String 3.3 Encoding used to read any i18n property files. If not defined, will use the encoding parameter.
User property is: i18n.bundleInputEncoding.
<bundleOutputEncoding> String 3.3 Encoding used to write any files. If not defined, will use the encoding parameter.
User property is: i18n.bundleOutputEncoding.
<silent> boolean 1.0.0-rc-5 Silent flag to see only errors in console.
Default value is: false.
User property is: i18n.silent.
<verbose> boolean 3.3 Verbose flag. Note : if not setted, we used the maven.verbose property.
Default value is: ${maven.verbose}.
User property is: i18n.verbose.

Parameter Details

<addInClassPath>

To add the generated csv file in the classpath. If bundleCsvDirectory is filled, then will add the generated csv file at the root of class-path, otherwise will add add it in the bundleOutputPackage package.
  • Type: boolean
  • Since: 3.3
  • Required: No
  • User Property: i18n.addInClassPath
  • Default: true

<bundleCsvDirectory>

If you want to specify where to generate the csv file. If not filled, then will generate it in the same directory where bundles are stored.
  • Type: java.io.File
  • Since: 3.3
  • Required: No
  • User Property: i18n.bundleCsvDirectory

<bundleCsvFileName>

Location of the csv file to split.
  • Type: java.lang.String
  • Since: 3.3
  • Required: Yes
  • User Property: i18n.bundleCsvFile
  • Default: ${i18n.bundleOutputName}-i18n.csv

<bundleCsvSeparator>

Char separator in the csv bundle file.
  • Type: char
  • Since: 3.3
  • Required: No
  • User Property: i18n.bundleCsvSeparator
  • Default:

<bundleInputEncoding>

Encoding used to read any i18n property files. If not defined, will use the encoding parameter.
  • Type: java.lang.String
  • Since: 3.3
  • Required: No
  • User Property: i18n.bundleInputEncoding

<bundleOutputDir>

Root directory where to generate aggregated bundles (this directory will be added as resources of the project).
  • Type: java.io.File
  • Since: 3.3
  • Required: Yes
  • User Property: i18n.bundleOutputDir
  • Default: ${project.build.directory}/generated-sources/resources

<bundleOutputEncoding>

Encoding used to write any files. If not defined, will use the encoding parameter.
  • Type: java.lang.String
  • Since: 3.3
  • Required: No
  • User Property: i18n.bundleOutputEncoding

<bundleOutputName>

Name of the bundle to use.
  • Type: java.lang.String
  • Since: 3.3
  • Required: Yes
  • User Property: i18n.bundleOutputName
  • Default: ${project.artifactId}-i18n

<bundleOutputPackage>

Package name of the generate aggregated bundles. Note: By default we use the META-INF package since it is the favorite package of I18n runtime initializer. The package name is dotted as it will be stored as folder like in Java language. Example : 
    package name : foo.bar
    directory    : foo/bar
  • Type: java.lang.String
  • Since: 3.3
  • Required: Yes
  • User Property: i18n.bundleOutputPackage
  • Default: META-INF

<bundles>

Locales to treate, separated by comma. Example : 
fr_FR,en_GB
  • Type: java.lang.String
  • Since: 3.3
  • Required: Yes
  • User Property: i18n.bundles
  • Default: fr_FR,en_GB

<encoding>

Encoding used to load and store properties.
  • Type: java.lang.String
  • Since: 3.3
  • Required: Yes
  • User Property: i18n.encoding
  • Default: ${project.build.sourceEncoding}

<silent>

Silent flag to see only errors in console.
  • Type: boolean
  • Since: 1.0.0-rc-5
  • Required: No
  • User Property: i18n.silent
  • Default: false

<verbose>

Verbose flag. Note : if not setted, we used the maven.verbose property.
  • Type: boolean
  • Since: 3.3
  • Required: No
  • User Property: i18n.verbose
  • Default: ${maven.verbose}