Difference between revisions of "Supported Resource Bundles"

From Lingoport Wiki
Jump to: navigation, search
(Standard LRM extensions)
(Lingoport Resource Manager Configuration)
Line 32: Line 32:
 
LRM creates projects using a [[Terms_and_Definitions#projectdefn|Project Definition XML]] file that contains information about the resources and types for translation. Here is a typical .xml definition for projects with .properties files.
 
LRM creates projects using a [[Terms_and_Definitions#projectdefn|Project Definition XML]] file that contains information about the resources and types for translation. Here is a typical .xml definition for projects with .properties files.
   
This will create a project called '''com.company.project''' in the group '''SVNFTP'''. The resource files are located in the '''<code>/var/lib/jenkins/jobs/SVNFTP.com.company.project/workspace</code>''' directory. The resources are targeting six different locales. The resource files to be translated are .properties files.
+
This will create a project called '''wiley''' in the group '''Acme'''. The resource files are located in the '''<code>/var/lib/jenkins/jobs/Acme.wiley/workspace</code>''' directory. The resources are targeting six different locales. The resource files to be translated are .properties files.
   
 
This is the LRM project name that will be created. LRM will create a project called com.company.project
 
This is the LRM project name that will be created. LRM will create a project called com.company.project

Revision as of 23:11, 13 September 2017

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

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:

Lingoport Resource Manager Configuration

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

This will create a project called wiley in the group Acme. The resource files are located in the /var/lib/jenkins/jobs/Acme.wiley/workspace directory. The resources are targeting six different locales. The resource files to be translated are .properties files.

This is the LRM project name that will be created. LRM will create a project called com.company.project

<project-name>com.company.project</project-name>

This is the LRM group name that the project will be under.

<group-name>SVNFTP</group-name>

This is the location of the resource files for source code associated with the com.company.project LRM project.

<top-level-dir>/var/lib/jenkins/jobs/SVNFTP.com.company.project/workspace</top-level-dir>

This is the locale to translate from

<default-locale>en_US</default-locale>

Here are the locales which will be translated into

 <target-locales>
   <locale>fr</locale>
   <locale>de_DE</locale>
   <locale>slv</locale>
   <locale>nob_NO_UNI</locale>
   <locale>zh_Hant</locale>
   <locale>ZHT_Hans</locale>
 </target-locales>

This tells LRM to look for .properties resource files.

<extension>properties</extension>

Here is a sample Project Definition file to create an LRM project. This example is for .properties files. Additional <resource-extension> stanzas can be added to include other extensions. Samples for the supported extensions can be found in <HOME>/lingoport/lrm-server-x.y/samples.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<lrmconf>
  <model-version>2.0.12</model-version>
  <project-name>com.company.project</project-name>
  <project-desc>This is a sample LRM Project definition file, configured to support Java properties files</project-desc>
  <!--group-name contains the group name that the LRM license is under-->
  <group-name>SVNFTP</group-name>
  <top-level-dir>/var/lib/jenkins/jobs/SVNFTP.com.company.project/workspace</top-level-dir>
  <detect-errors>
    <!--If set to '0' (false), then the 'missed translation' error will not be triggered-->
    <missed-trans-error>0</missed-trans-error>
    <parameter-mismatch-error>1</parameter-mismatch-error>
  </detect-errors>
  <pseudo-locale>eo</pseudo-locale>
  <default-locale>en_US</default-locale>
  <target-locales>
    <locale>fr</locale>
    <locale>de_DE</locale>
    <locale>slv</locale>
    <locale>nob_NO_UNI</locale>
    <locale>zh_Hant</locale>
    <locale>ZHT_Hans</locale>
  </target-locales>
    <resource-extension>
      <extension>properties</extension>
      <file-name-pattern>*_l_c_v</file-name-pattern>
      <!--If the base resource files use the file-name-pattern in their name -->
      <!--then set use-pattern-on-dflt-locale to 1, if not then set to 0-->
      <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>
      <!--Default pattern for properties is '![CDATA[\{\d+\}|%[ds]]]'-->
      <parameter-regex-pattern><![CDATA[\{\w+\}|%[ds]]]></parameter-regex-pattern>
    </resource-extension>
  </resource-extensions>
</lrmconf>