gettext:gettext

Full name:

ninja.leaping:gettext-maven-plugin:1.2.5-SNAPSHOT:gettext

Description:

Invokes xgettext to extract messages from source code and store them in the keys.pot file.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: generate-resources.

Required Parameters

Name Type Since Description
encoding String - The encoding of the source Java files. utf-8 is a superset of ascii.
Default value is: utf-8.
keysFile String - Filename of the .pot file.
Default value is: keys.pot.
keywords String - The keywords the xgettext parser will look for to extract messages. The default value works with libraries that use the _-format method, as recommended by Gettext documentation.
Default value is: -k_ -k_n1,2.
outputDirectory File - The output directory for generated class or properties files.
Default value is: ${project.build.directory}/generated-sources/gettext.
poDirectory File - The output directory for the keys.pot directory for merging .po files.
Default value is: ${basedir}/src/main/po.
sourceDirectory File - Source directory. This directory is searched recursively for .java files.
Default value is: ${project.build.sourceDirectory}.
xgettextCmd String - The xgettext command.
Default value is: xgettext.

Optional Parameters

Name Type Since Description
extraSourceFiles FileSet -

Parameter Details

encoding:

The encoding of the source Java files. utf-8 is a superset of ascii.
  • Type: java.lang.String
  • Required: Yes
  • Default: utf-8

extraSourceFiles:

  • Type: org.apache.maven.model.FileSet
  • Required: No

keysFile:

Filename of the .pot file.
  • Type: java.lang.String
  • Required: Yes
  • Default: keys.pot

keywords:

The keywords the xgettext parser will look for to extract messages. The default value works with libraries that use the _-format method, as recommended by Gettext documentation.
  • Type: java.lang.String
  • Required: Yes
  • Default: -k_ -k_n1,2

outputDirectory:

The output directory for generated class or properties files.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/generated-sources/gettext

poDirectory:

The output directory for the keys.pot directory for merging .po files.
  • Type: java.io.File
  • Required: Yes
  • Default: ${basedir}/src/main/po

sourceDirectory:

Source directory. This directory is searched recursively for .java files.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.sourceDirectory}

xgettextCmd:

The xgettext command.
  • Type: java.lang.String
  • Required: Yes
  • Default: xgettext