Difference between revisions of "Group Configuration Files"

From Lingoport Wiki
Jump to: navigation, search
(Group File Structure)
Line 35: Line 35:
 
...
 
...
 
</pre>
 
</pre>
Each of the group configuration files can be copied to the project 'config' directory is a project has a configuration different from most projects in that group.
+
Each of the group configuration files can be copied to the project 'config' directory if a project has a configuration different from other projects in that group.
   
 
This section describes the configuration at the group level
 
This section describes the configuration at the group level

Revision as of 20:20, 30 April 2015

Group Name

A group name must conform to the following specification: A set of alphanumeric characters without the following special characters:

  • < (less than)
  • > (greater than)
  •  : (colon)
  • " (double quote)
  • / (forward slash)
  • \ (backslash)
  • | (vertical bar or pipe)
  •  ? (question mark)
  • * (asterisk)
  • (space)
  •  % (percentage)

Group File Structure

Under the L10n Streamlining directory (typically ~jenkins/Lingoport_Data/L10nStreamlining), each group file structure follows this pattern:

<group_name>
├── config
│   ├── config_due_dates.xml
│   ├── config_file_cherry_picker.xml
│   ├── config_l10n_vendor.properties
│   ├── config_lingotek_locale_mapping.properties
│   ├── config_lrm_info.properties
│   └── config_pseudo_loc.xml
└── projects
    └── <project 1>
        ├── config
        │   ├── config_email_recipients.xml
        │   └── config_vcs.properties
        ...

Each of the group configuration files can be copied to the project 'config' directory if a project has a configuration different from other projects in that group.

This section describes the configuration at the group level

config_due_dates.xml

This file specifies how many working days a prep kit is expected to be translated based on the number of words. A typical file looks like this:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<due-date-config>
        <thresholds>
                <threshold max="50"   nb-work-days="2" />
                <threshold max="200"  nb-work-days="3" />
                <threshold max="500"  nb-work-days="5" />
                <threshold max="1000" nb-work-days="10" />
                <threshold max="5000" nb-work-days="15" />
                <threshold max=""     nb-work-days="20" />
        </thresholds>
</due-date-config>

You can add or remove thresholds.

config_file_cherry_picker.xml

This is a template file to be copied under the project config directory if needed.

It helps special situations where files to be sent for translation are far and few and possibly locale dependent. This should be used with care.

config_l10n_vendor.xml

This file specifies for all the group's project how files will be sent to translation. The details of this configuration must be worked out with the translation group, for instance, what ID's Lingotek will provide this company or this group within the company.

This file is configured at installation time by Lingoport and should not be modified thereafter.

A typical file looks like this:

#Default to lingotek but don't have any attributes. Send kit will fail and force
 the user to set up file
l10n.vendor=lingotek
#l10n.vendor=worldserver
#l10n.vendor=ftp

#Lingotek Attributes
#Contains the ids for community, workflow and access token
lingotek.api.id.access.token=d34866f82-cd29-3535-8a8c-48449109d0ac
lingotek.api.id.community=b43ece7c-b7fc-400d-890f-bfd4b009dcb1
lingotek.api.id.workflow=2b5498e0-f3c7-48889-9afa-cca4b38885af7

config_lingotek_locale_mapping.properties

This file maps the locales used in the application to the locales used by Lingotek. For instance, if 'fr' is a locale in the application, it may map to fr_fr or fr_ca depending on the situation.

A typical file is formatted this way:

de=de_de
en=en_us
es=es_mx
fr=fr_fr
...

config_lrm_info.properties

This file should not be modified. It helps with certain handling of data. A typical file looks like this:

json.comment.starts.with=_comment
#Default to changes only prep kits
prep.kit.changes.only=1

config_pseudo_loc.xml

This file determines how the base file (typically U.S. English) will be pseudo localized.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<pseudo-loc-config>
        <expansion>
                <lengths>
                        <length max="10" expand-percentage="200"/>
                        <length max="20" expand-percentage="100"/>
                        <length max="30" expand-percentage="80"/>
                        <length max="50" expand-percentage="60"/>
                        <length max="70" expand-percentage="40"/>
                        <length max=""   expand-percentage="30"/>
                </lengths>
                <expansion-char>-</expansion-char>
                <!-- End characters are ‘ П國カ내’ (with a leading space) -->
                <!-- П: A Cyrillic character - (for Russian or ‘R’) -->
                <!-- 國: A common Chinese character (Hanzi, Kanji or Hanja) defined in Unicode BMP or Plane 0 – (for Chinese or ‘C’) -->
                <!-- カ: A Katakana character (used for Japanese or ‘J’) -->
                <!-- 내: A Hangul character (for Korean or ‘K’) -->
                <expansion-end-chars> П國カ내</expansion-end-chars>
        </expansion>
        <start-char>[</start-char>
        <end-char>]</end-char>
        <!-- Value for accented characters is '1' if the text should be accented -->
        <accent-chars>1</accent-chars>
        <parameter-check>
                <resource-extensions>
                        <resource-extension>
                                <extension>properties</extension>
                                <parameter-regex-pattern><![CDATA[\{\w+\}|\\n|\\
t|\\r|%[ds]]]></parameter-regex-pattern>
                        </resource-extension>
                        <resource-extension>
                                <extension>xml</extension>
                                <parameter-regex-pattern><![CDATA[%d|%s|%\d+\$s|
%\d+\$d|\\n|\\t|\\r|%\{\w+\}]]></parameter-regex-pattern>
                        </resource-extension>
                        <resource-extension>
                                <extension>strings</extension>
                                <parameter-regex-pattern><![CDATA[(%([dsf]|(\d\$
[dsf@])|(\.\df)|@))|\\n|\\t|\\r|%\{\w+\}]]></parameter-regex-pattern>
                       </resource-extension>
                </resource-extensions>
        </parameter-check>
</pseudo-loc-config>

Lingoport configures this file at group creation and configuration and it should not be modified.