Supported Resource Bundles

What resource file types are supported by LRM?

Standard LRM extensions

• .htm and .html files using the html parser
• .json (Mostly JavaScript, and other programming languages) using the json parser
• .msg (C, C++, ...) using the msg parser
• .po files using the po parser
• .properties files (Java-type resources) using properties parser
• .resx files (used in the .Net world) using xml parser and the ResxParser.xml format definition
• .rc (Delphi, ...) using the rc parser
• .rjs (for JavaScript) using the js parser
• .rxml using the xml parser and the RxmlParser.xml format definition)
• .strings (Mobile iOS) using the strings parser
• strings.xml (Android) using the xml parser and the AndroidParser.xml format definition
• .txt files using the text parser
• .yaml, .yml using the yaml parser

Unique Extensions

Any file extension can be handled by LRM as long as the corresponding parser type is defined. The file must be able to be parsed correctly by the defined parser type or an error will occur. The parser types are:

• html parser
• js parser
• json parser
• msg parser
• po parser
• properties parser
• rc parser
• strings parser
• text parser
• xml parser
• yaml parser

Lingoport Resource Manager Configuration

LRM creates projects using a Project Definition XML file that contains information about the resources and types for translation and then calling the Create Project Command. Here is a typical .xml definition for projects with .properties files.

Note-a project should be created using either the project definition file directly or through the Jenkins LRM Plugin.

Project Info

Project information includes the following:

• Project Name - the repository name. This cannot be changed once the project is created.
• Project desc - description, if any, for the project
• Group Name - the owner of the repository. This cannot be changed once the project is created.
• Top Level Directory - The top level directory is an absolute path. Usually it is something like /var/lib/jenkins/jobs/Acme.wiley/workspace. There are times where there is 1 repository for multiple projects. In this case the top level directory may be /var/lib/jenkins/jobs/Acme.wiley/workspace/wileyProject1. This value cannot be changed once the project is created.

ProjectDefinition.xml example

This example is the project info for the wiley repository under the Acme group. (Under git, Acme would be the owner of the wiley repo)

<project-name>wiley</project-name>
<project-desc>Wiley Project</project-desc>
<group-name>Acme</group-name>
<top-level-dir>/var/lib/jenkins/jobs/Acme.wiley/workspace</top-level-dir>

Detect Errors Flags

These flags direct LRM on the types of errors to detect.

• Missed Translations - If set to 1, then a Missed Translation error will occur if the base resource file text is the same as the translated file text. Usually this flag is set to 0.
• Parameter Mismatch Error - If set to 1 then a Parameter Mismatch error will occur if the parameters in the translated file do not match the base resource file parameters.

ProjectDefinition.xml example

A project setup with the following detect error flags will not detect missed translations but will detect parameter mismatch errors.

<detect-errors>
  <missed-trans-error>0</missed-trans-error>
  <parameter-mismatch-error>1</parameter-mismatch-error>
<detect-errors>

Locales

There are 3 types of java locales, that can be defined in a project:

• Pseudo Locale - The locale for the project's pseudo-locale files.
• Target locales - Must be exclusive of the project's base and pseudo-locales.
• Base Locale - The locale of the project's base resource file.

ProjectDefinition.xml example

The following defines eo as the pseudo-locale, en as the base locale and fr_FR, de_DE (case sensitive) as the target locales. The locales defined are in the format of a java locale (using underscores) and may not reflect the name of the resource files. The file name patterns are defined here.

 <pseudo-locale>eo</pseudo-locale>
 <target-locales>
   <locale>fr_FR</locale>
   <locale>de_DE</locale>
 </target-locales>
 <default-locale>en</default-locale>

Resource Extensions

A LRM project can have multiple extensions defined. The information need per extension is:

• extension - this can be one of the LRM standard extensions or a unique extension.
• parser-type - A parser-type is required for unique extension.
• file name pattern - if applicable, this is the pattern for the name of project's resource files. For example, the translated file names file1_zh-Hans_HK.rc, file1_fr.rc and file1_de-de.rc would have the pattern *_l-c_v. Where l is the language, c is the country/script and v is the variant/region.
• use name pattern on default locale flag- If the base resource files use the file-name-pattern in their name then this flag is 1 otherwise 0. For example, the base resource file file1.rc does not have a pattern so the flag would be 0.
• file location pattern - if applicable, this is the pattern for the folders containing the resource files. These folder can be of 2 types:
  • Language pattern - For example, *-l_c_v where the folder containing the English resource files could be values-en.
  • Microsoft LCID code pattern - For example, *_LCID where the folder containing the English(US) (en_us) resource files could be values_1033.

The location pattern may contain a wildcard for directory names. These are all valid location patterns:

• *-l-c-v/*/* - directory depth is 3
• *-l-c-v/some*folder - directory depth is 2
• *_LCID/*/*/locales - directory depth is 4

The location pattern can not contain wildcards for directory depth (**). These are invalid location patterns:

• *-l-c-v/** (INVALID)
• *-l-c-v/**/locales (INVALID)

• use location pattern on default locale flag - If the folder, containing the base resource files, use the pattern then this flag is 1 otherwise 0.
• encoding for the base and non-base resource files - Usually this will be UTF-8.
• parameter-regex-pattern - This defines the regex pattern for parameters such as formatting and messaging.

ProjectDefinition.xml example

The following will define the following directory structure.

src

resources

file1_en-US.xml

file1_fr-FR.xml

file1_de-DE.xml

values

example.resx

values-1033

example.resx

values-1036

example.resx

<resource-extensions>
   <resource-extension>
     <extension>resx</extension>
     <file-name-pattern/>
     <use-pattern-on-dflt-locale>0</use-pattern-on-dflt-locale>
     <file-location-pattern>*-LCID</file-location-pattern>
     <use-location-pattern-on-dflt-locale>0</use-location-pattern-on-dflt-locale>
     <base-file-encoding>UTF-8</base-file-encoding>
     <localized-file-encoding>UTF-8</localized-file-encoding>
     <parameter-regex-pattern><![CDATA[%[ds]|%\d+\$[ds]|%\{\w+\}]]></parameter-regex-pattern>
   </resource-extension>
   <resource-extension>
     <extension>xml</extension>
     <file-name-pattern>*_l-c-v</file-name-pattern>
     <use-pattern-on-dflt-locale>1</use-pattern-on-dflt-locale>
     <file-location-pattern/>
     <use-location-pattern-on-dflt-locale>0</use-location-pattern-on-dflt-locale>
     <base-file-encoding>UTF-8</base-file-encoding>
     <localized-file-encoding>UTF-8</localized-file-encoding>
     <parameter-regex-pattern><![CDATA[%d|%s|%\d+\$s|%\d+\$d|%\{\w+\}]]></parameter-regex-pattern>
   </resource-extension>
</resource-extensions>

Include/Exclude Files/Directories

The include portion of the project definition can be used to include folder or files from the search for resource files. The default is all folders and files will be included.

The exclude portion of the project definition can be used to exclude folder or files from the search for resource files. The default is that no folders/files will be excluded.

ProjectDefinition.xml example

The following definition directs the search to only those resource files with src as a top-level directory. Any resource files under a test folder will be ignored as well as the config.properties file.

 <dirset>
   <includes>
     <include-dir-file>**/src/**</include-dir-file>
   </includes>
   <excludes>
     <exclude-dir-file>**/test/**</exclude-dir-file>
     <exclude-dir-file>**/config.properties</exclude-dir-file>
   </excludes>
 </dirset>