Produit par Maven

i18n:generate-csv-bundle

Nom complet :

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.

Attributs :

  • Exige un projet Maven pour être exécuté.
  • Exige une résolution des dépendances des artefacts dans le scope : runtime.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Depuis la version : 3.3.
  • S'associe par défaut dans la phase du cycle de vie : generate-resources.

Paramètres requis

Nom Type Depuis Description
<bundleCsvFileName> String 3.3 Location of the csv file to split.
Valeur par défaut : ${i18n.bundleOutputName}-i18n.csv.
Propriété utilisateur : i18n.bundleCsvFile.
<bundleOutputDir> File 3.3 Root directory where to generate aggregated bundles (this directory will be added as resources of the project).
Valeur par défaut : ${project.build.directory}/generated-sources/resources.
Propriété utilisateur : i18n.bundleOutputDir.
<bundleOutputName> String 3.3 Name of the bundle to use.
Valeur par défaut : ${project.artifactId}-i18n.
Propriété utilisateur : 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

Valeur par défaut : META-INF.
Propriété utilisateur : i18n.bundleOutputPackage.
<bundles> String 3.3 Locales to treate, separated by comma. Example : 
fr_FR,en_GB

Valeur par défaut : fr_FR,en_GB.
Propriété utilisateur : i18n.bundles.
<encoding> String 3.3 Encoding used to load and store properties.
Valeur par défaut : ${project.build.sourceEncoding}.
Propriété utilisateur : i18n.encoding.

Paramètres optionnels

Nom Type Depuis 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.
Valeur par défaut : true.
Propriété utilisateur : 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.
Propriété utilisateur : i18n.bundleCsvDirectory.
<bundleCsvSeparator> char 3.3 Char separator in the csv bundle file.
Valeur par défaut : .
Propriété utilisateur : i18n.bundleCsvSeparator.
<bundleInputEncoding> String 3.3 Encoding used to read any i18n property files. If not defined, will use the encoding parameter.
Propriété utilisateur : i18n.bundleInputEncoding.
<bundleOutputEncoding> String 3.3 Encoding used to write any files. If not defined, will use the encoding parameter.
Propriété utilisateur : i18n.bundleOutputEncoding.
<silent> boolean 1.0.0-rc-5 Silent flag to see only errors in console.
Valeur par défaut : false.
Propriété utilisateur : i18n.silent.
<verbose> boolean 3.3 Verbose flag. Note : if not setted, we used the maven.verbose property.
Valeur par défaut : ${maven.verbose}.
Propriété utilisateur : i18n.verbose.

Détails des paramètres

<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
  • Depuis : 3.3
  • Exigé : Non
  • Propriété utilisateur : i18n.addInClassPath
  • Défaut : 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
  • Depuis : 3.3
  • Exigé : Non
  • Propriété utilisateur : i18n.bundleCsvDirectory

<bundleCsvFileName>

Location of the csv file to split.
  • Type : java.lang.String
  • Depuis : 3.3
  • Exigé : Oui
  • Propriété utilisateur : i18n.bundleCsvFile
  • Défaut : ${i18n.bundleOutputName}-i18n.csv

<bundleCsvSeparator>

Char separator in the csv bundle file.
  • Type : char
  • Depuis : 3.3
  • Exigé : Non
  • Propriété utilisateur : i18n.bundleCsvSeparator
  • Défaut :

<bundleInputEncoding>

Encoding used to read any i18n property files. If not defined, will use the encoding parameter.
  • Type : java.lang.String
  • Depuis : 3.3
  • Exigé : Non
  • Propriété utilisateur : i18n.bundleInputEncoding

<bundleOutputDir>

Root directory where to generate aggregated bundles (this directory will be added as resources of the project).
  • Type : java.io.File
  • Depuis : 3.3
  • Exigé : Oui
  • Propriété utilisateur : i18n.bundleOutputDir
  • Défaut : ${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
  • Depuis : 3.3
  • Exigé : Non
  • Propriété utilisateur : i18n.bundleOutputEncoding

<bundleOutputName>

Name of the bundle to use.
  • Type : java.lang.String
  • Depuis : 3.3
  • Exigé : Oui
  • Propriété utilisateur : i18n.bundleOutputName
  • Défaut : ${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
  • Depuis : 3.3
  • Exigé : Oui
  • Propriété utilisateur : i18n.bundleOutputPackage
  • Défaut : META-INF

<bundles>

Locales to treate, separated by comma. Example : 
fr_FR,en_GB
  • Type : java.lang.String
  • Depuis : 3.3
  • Exigé : Oui
  • Propriété utilisateur : i18n.bundles
  • Défaut : fr_FR,en_GB

<encoding>

Encoding used to load and store properties.
  • Type : java.lang.String
  • Depuis : 3.3
  • Exigé : Oui
  • Propriété utilisateur : i18n.encoding
  • Défaut : ${project.build.sourceEncoding}

<silent>

Silent flag to see only errors in console.
  • Type : boolean
  • Depuis : 1.0.0-rc-5
  • Exigé : Non
  • Propriété utilisateur : i18n.silent
  • Défaut : false

<verbose>

Verbose flag. Note : if not setted, we used the maven.verbose property.
  • Type : boolean
  • Depuis : 3.3
  • Exigé : Non
  • Propriété utilisateur : i18n.verbose
  • Défaut : ${maven.verbose}