Difference between revisions of "LRM po Support"
(→Example of .po files as well as file extensions using the po parser type) |
(→Example Project Definition File) |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 40: | Line 40: | ||
</pre> |
</pre> |
||
| − | == |
+ | == ''po'' parser type == |
| + | === valid po syntax === |
||
| + | Files that use the ''po'' parser are expected to have valid po syntax |
||
| + | === .po uses the ''po'' parser type=== |
||
| + | When defining a project containing LRM Standard .po resource files, there is no need to define a ''<parser-type>'' as the ''po'' parser will always be used. |
||
| + | |||
| + | === unique file extension needs to define ''json'' parser type === |
||
| + | If a unique file extension is a valid po file, then the ''<parser-type>'' should be ''po'' in the project definition file. |
||
| + | |||
| + | == Example of Project Definition for Resources == |
||
| + | The following is an example of po resource file definitions. See [[Supported_Resource_Bundles#Resource_Extensions| resource extensions]] for more information. |
||
| − | <?xml version="1.0" encoding="UTF-8"?> |
||
| − | <lrmconf> |
||
| − | <model-version>1.0.0</model-version> |
||
| − | <project-name>DemoPo</project-name> |
||
| − | <project-desc>This is a sample LRM Project definition file, configured to support po resource files</project-desc> |
||
| − | <!--group-name contains either the company name or the group name. --> |
||
| − | <group-name>acme</group-name> |
||
| − | <!-- Example, linux --> |
||
| − | <!--<top-level-dir>/var/lib/job/workspace/acme/source</top-level-dir>--> |
||
| − | <top-level-dir>C:\acme\source</top-level-dir> |
||
| − | <detect-errors> |
||
| − | <!--If set to '0' (false), then the 'missed translation' error will not be triggered--> |
||
| − | <!--if the non-base file has the same text as the base file.--> |
||
| − | <!--Missed Translation error will still occur if the base file has a different key or if--> |
||
| − | <!--the base file has changed since it was last prepped.--> |
||
| − | <missed-trans-error>1</missed-trans-error> |
||
| − | <parameter-mismatch-error>1</parameter-mismatch-error> |
||
| − | </detect-errors> |
||
| − | <!--If you wish to create Track Back resource files, enter the Track Back locale such as `br`--> |
||
| − | <!--The track back locale is mutually exclusive of the base (default) locale, target locales and pseudo-locale--> |
||
| − | <track-back-locale>br</track-back-locale> |
||
| − | <!--If you wish to pseudo-localized your files enter a pseudo-locale--> |
||
| − | <!--The pseudo-locale is mutually exclusive of the base (default) locale and target locales--> |
||
| − | <pseudo-locale>eo</pseudo-locale> |
||
| − | <!--Target locales are the locales where the corresponding resource files will be translated. --> |
||
| − | <!--These target locales are mutually exclusive of the base (default) locale--> |
||
| − | <target-locales> |
||
| − | <locale>es_MX</locale> |
||
| − | <locale>fr_CA</locale> |
||
| − | <locale>fr_FR</locale> |
||
| − | </target-locales> |
||
| − | <!--Default locale is the base locale. This is the locale where corresponding resource files will not be translated.--> |
||
| − | <!--The base (default) locale is mutually exclusive of the target locales--> |
||
| − | <default-locale>en_US</default-locale> |
||
<resource-extensions> |
<resource-extensions> |
||
| − | <!--The file-name-pattern and/or file-location-pattern indicate the pattern of the--> |
||
| − | <!--localized file names (file-name-pattern) and the localized folder names (file-location-pattern).--> |
||
| − | <!--If the names contain the locale then a pattern of 1,c and v will be used.--> |
||
| − | <!--If the names contain the Locale ID then LCID will be used.--> |
||
| − | <!--Example pattern using locale--> |
||
| − | <!-- If your localized resource files use their locale in their names then the locale pattern will--> |
||
| − | <!-- be used where l stands for language; c for country; v for variant; and the characters between--> |
||
| − | <!-- are used as the separator characters.--> |
||
| − | <!-- <file-name-pattern>*_l_c_v</file-name-pattern>--> |
||
| − | <!--Example pattern using LCID (locale ID)--> |
||
| − | <!-- If your resource files are under a folder named 'resources' with an LCID suffix separated by an--> |
||
| − | <!-- underscore, then the pattern would be:--> |
||
| − | <!-- <file-location-pattern>resources_LCID</file-location-pattern>--> |
||
<resource-extension> |
<resource-extension> |
||
| + | '''<!-- parser-type not needed since .po is a standard LRM extension that maps to the po parser type -->''' |
||
'''<extension>po</extension>''' |
'''<extension>po</extension>''' |
||
'''<file-name-pattern>*-l_c_v</file-name-pattern>''' |
'''<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>0</use-pattern-on-dflt-locale>''' |
'''<use-pattern-on-dflt-locale>0</use-pattern-on-dflt-locale>''' |
||
'''<file-location-pattern/>''' |
'''<file-location-pattern/>''' |
||
| − | <!--If the base resource files use the file-location-pattern in their name --> |
||
| − | <!--then set use-location-pattern-on-dflt-locale to 1, if not then set to 0--> |
||
'''<use-location-pattern-on-dflt-locale>0</use-location-pattern-on-dflt-locale>''' |
'''<use-location-pattern-on-dflt-locale>0</use-location-pattern-on-dflt-locale>''' |
||
'''<base-file-encoding>UTF-8</base-file-encoding>''' |
'''<base-file-encoding>UTF-8</base-file-encoding>''' |
||
'''<localized-file-encoding>UTF-8</localized-file-encoding>''' |
'''<localized-file-encoding>UTF-8</localized-file-encoding>''' |
||
| − | <!--Default pattern for po is '![CDATA[%\d*[ds]|%\d+]'--> |
||
'''<parameter-regex-pattern><![CDATA[%\d*[ds]|%\d+]]></parameter-regex-pattern>''' |
'''<parameter-regex-pattern><![CDATA[%\d*[ds]|%\d+]]></parameter-regex-pattern>''' |
||
</resource-extension> |
</resource-extension> |
||
<resource-extension> |
<resource-extension> |
||
| + | '''<!-- parser-type is required because .myext is not a standard LRM extension -->''' |
||
'''<extension>''myext''</extension>''' |
'''<extension>''myext''</extension>''' |
||
'''''<parser-type>po</parser-type>''''' |
'''''<parser-type>po</parser-type>''''' |
||
'''<file-name-pattern>*-l_c_v</file-name-pattern>''' |
'''<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>0</use-pattern-on-dflt-locale>''' |
'''<use-pattern-on-dflt-locale>0</use-pattern-on-dflt-locale>''' |
||
'''<file-location-pattern/>''' |
'''<file-location-pattern/>''' |
||
| − | <!--If the base resource files use the file-location-pattern in their name --> |
||
| − | <!--then set use-location-pattern-on-dflt-locale to 1, if not then set to 0--> |
||
'''<use-location-pattern-on-dflt-locale>0</use-location-pattern-on-dflt-locale>''' |
'''<use-location-pattern-on-dflt-locale>0</use-location-pattern-on-dflt-locale>''' |
||
'''<base-file-encoding>UTF-8</base-file-encoding>''' |
'''<base-file-encoding>UTF-8</base-file-encoding>''' |
||
'''<localized-file-encoding>UTF-8</localized-file-encoding>''' |
'''<localized-file-encoding>UTF-8</localized-file-encoding>''' |
||
| − | <!--Default pattern for po is '![CDATA[%\d*[ds]|%\d+]'--> |
||
'''<parameter-regex-pattern><![CDATA[%\d*[ds]|%\d+]]></parameter-regex-pattern>''' |
'''<parameter-regex-pattern><![CDATA[%\d*[ds]|%\d+]]></parameter-regex-pattern>''' |
||
</resource-extension> |
</resource-extension> |
||
</resource-extensions> |
</resource-extensions> |
||
| − | <dirset> |
||
| − | <!--Define the search patterns to include and/or exclude. (Uses Apache Ant pattern search).--> |
||
| − | <!--Define the search patterns to include and/or exclude. (Uses Apache Ant pattern search).--> |
||
| − | <!--Examples: --> |
||
| − | <!-- A. '**/*.properties' matches all .properties files/dirs in a directory tree.--> |
||
| − | <!-- B. 'test/a??.resx' matches all files/dirs which start with an 'a', --> |
||
| − | <!-- then two more characters and then '.resx', in a directory called test.--> |
||
| − | <!-- C. '**' matches everything in a directory tree. --> |
||
| − | <!-- D. '**/source/**/XYZ*' matches all files/dirs which start with 'XYZ'--> |
||
| − | <!-- and where there is a parent directory called source (e.g. 'abc/source/def/ghi/XYZ123'). --> |
||
| − | <includes> |
||
| − | <!--Directories to include in the search for base resource files --> |
||
| − | <!--Examples: --> |
||
| − | <!-- <include-dir>**/source/**</include-dir>--> |
||
| − | <include-dir>**/**</include-dir> |
||
| − | </includes> |
||
| − | <excludes> |
||
| − | <!--Directories or files to exclude in the search --> |
||
| − | <!--Examples: --> |
||
| − | <!-- <exclude-dir-file>**/source/bin/**</exclude-dir-file> --> |
||
| − | <!-- <exclude-dir-file>**/fileToIgnore.*</exclude-dir-file> --> |
||
| − | </excludes> |
||
| − | </dirset> |
||
| − | </lrmconf> |
||
Latest revision as of 20:25, 18 September 2017
Contents
Example of .po files as well as file extensions using the po parser type
# SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
# This file is distributed under the same license as the PACKAGE package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2017-02-01 16:55-0700\n"
"PO-Revision-Date: 2017-02-01 16:55-0700\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
# SOURCE_FILE C:/Path/to/my/source/files/Matrix.js
msgid "ascending"
msgstr "ascending"
msgid "descending"
msgstr "descending"
msgid "Viewing rows {0} to {1} of {2}"
msgstr "Viewing rows {0} to {1} of {2}"
# SOURCE_FILE C:/Path/to/my/source/files/cache.js
msgid "You have made unsaved changes to the following cache document(s): <b>"
msgstr "You have made unsaved changes to the following cache document(s): <b>"
msgid "</b>. Procede with delete?"
msgstr "</b>. Procede with delete?"
msgid "//record[record]"
msgstr "//record[record]"
po parser type
valid po syntax
Files that use the po parser are expected to have valid po syntax
.po uses the po parser type
When defining a project containing LRM Standard .po resource files, there is no need to define a <parser-type> as the po parser will always be used.
unique file extension needs to define json parser type
If a unique file extension is a valid po file, then the <parser-type> should be po in the project definition file.
Example of Project Definition for Resources
The following is an example of po resource file definitions. See resource extensions for more information.
<resource-extensions>
<resource-extension>
<!-- parser-type not needed since .po is a standard LRM extension that maps to the po parser type -->
<extension>po</extension>
<file-name-pattern>*-l_c_v</file-name-pattern>
<use-pattern-on-dflt-locale>0</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*[ds]|%\d+]]></parameter-regex-pattern>
</resource-extension>
<resource-extension>
<!-- parser-type is required because .myext is not a standard LRM extension -->
<extension>myext</extension>
<parser-type>po</parser-type>
<file-name-pattern>*-l_c_v</file-name-pattern>
<use-pattern-on-dflt-locale>0</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*[ds]|%\d+]]></parameter-regex-pattern>
</resource-extension>
</resource-extensions>
