Extracting Strings for Translating

Last update: April 17, 2024

CREATED FOR:

  • Developer

Use xgettext-maven-plugin to extract strings from your source code that need translating. The Maven plugin extracts strings to an XLIFF file that you send for translating. Strings are extracted from the following locations:

  • Java source files
  • JavaScript source files
  • XML representations of SVN resources (JCR Nodes)

Configuring String Extraction

Configure how the xgettext-maven-plugin tool extracts strings for your project.

/filter { }
/parsers {
   /vaultxml { }
   /javascript { }
   /regexp {
      /files {
         /java { }
         /jsp { }
         /extjstemplate { }
      }
   }
}
/potentials { }
SectionDescription
/filterIdentifies the files that are parsed.
/parsers/vaultxmlConfigures the parsing of Vault files. Identifies the JCR nodes that contain externalized strings and localization hints. Also identifies JCR nodes to ignore.
/parsers/javascriptIdentifies the JavaScript functions that externalize strings. You do not need to change this section.
/parsers/regexpConfigures the parsing of Java, JSP, and ExtJS Template files. You do not need to change this section.
/potentialsThe formula for detecting strings to internationalize.

Identifying the Files to Parse

The /filter section of the i18n.any file identifies the files that the xgettext-maven-plugin tool parses. Add several include and exclude rules that identify files that are parsed and ignored, respectively. You should include all files and then exclude the files that you do not want to parse. Typically, you exclude file types that do not contribute to the UI, or files that define UI but are not being translated. The include and exclude rules have the following format:

{ /include "pattern" }
{ /exclude "pattern" }

The pattern part of a rule is used to match the names of the files to include or exclude. The pattern prefix indicate whether you are matching a JCR node (its representation in Vault) or the file system.

PrefixEffect
/Indicates a JCR path. Therefore, this prefix matches files below the jcr_root directory.
*Indicates a regular file on the file system.
noneNo prefix, or a pattern that begins with a folder or file name, indicates a regular file on the file system.

When used within a pattern, the / character indicates a subdirectory and the * character matches all. The following table lists several example rules.

Example ruleEffect
{ /include "*" }Include all files.
{ /exclude "*.pdf" }Exclude all PDF files.
{ /exclude "*/pom.xml" }Exclude POM files.
{ /exclude "/content/*" } { /include "/content/catalogs/geometrixx/templatepages" } { /include "/content/catalogs/geometrixx/templatepages/*" }

Exclude all files below the /content node.

Include the /content/catalogs/geometrixx/templatepages node.

Include all child nodes of /content/catalogs/geometrixx/templatepages.