Difference between revisions of "Resource Files"

From Lingoport Wiki
Jump to: navigation, search
(Unique Extensions)
(How to work with unsupported File Types)
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== What resource file types are supported by LRM?==
+
== What resource file types are supported by Localyzer?==
=== Standard LRM extensions ===
+
=== Standard Localyzer extensions ===
 
<ul>
 
<ul>
 
<li><b>[[LRM html Support | .htm and .html]]</b> files using the [[LRM_html_Support#html_parser_type | ''html'']] parser</li>
 
<li><b>[[LRM html Support | .htm and .html]]</b> files using the [[LRM_html_Support#html_parser_type | ''html'']] parser</li>
Line 18: Line 18:
   
 
=== Unique Extensions ===
 
=== 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.
+
Any file extension can be handled by Localyzer 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.
   
 
[[File: ExtensionParserType.jpg |600px]]
 
[[File: ExtensionParserType.jpg |600px]]
   
Above is an example configuring a Jenkins LRM project. The '''Extension''' is 'properties' and the '''Parser Type''' is 'properties' so LRM will recognize the file '''myfile_en_US.properties''' as a resource file. If the filename is '''myfile_en_US.prop''', that would <u>not</u> be recognized as a properties resource file. Changing the '''Extension''' to 'prop' would allow '''myfile_en_US.prop''' to be recognized as a properties parser type file.
+
Above is an example configuring a Jenkins Localyzer project. The '''Extension''' is 'properties' and the '''Parser Type''' is 'properties' so Localyzer will recognize the file '''myfile_en_US.properties''' as a resource file. If the filename is '''myfile_en_US.prop''', that would <u>not</u> be recognized as a properties resource file. Changing the '''Extension''' to 'prop' would allow '''myfile_en_US.prop''' to be recognized as a properties parser type file.
   
 
The parser types are:
 
The parser types are:
Line 37: Line 37:
 
<li><b>[[LRM_XML_Support|''xml'']]</b> parser</li>
 
<li><b>[[LRM_XML_Support|''xml'']]</b> parser</li>
 
<li><b>[[LRM_yaml_Support|''yaml'']]</b> parser</li>
 
<li><b>[[LRM_yaml_Support|''yaml'']]</b> parser</li>
  +
<li><b>[[LRM_Binary_Support|''binary'']]</b> parser</li>
 
</ul>
 
</ul>
  +
  +
==How to work with unsupported File Types==
  +
  +
Localyzer supports a number of file types out of the box (See above). However, other file types may represent user facing strings to be translated. In that case, some customization is required to on-board those projects.
  +
The '''[[Transform_Framework|Transform Framework]]''' facilitates the customization.
  +
  +
== Why are there files in my repository that end in ''_LRMLQA''? ==
  +
These are the Localyzer instrumented files that were created during the ''instrument resource files'' command.
  +
See [[LRM_Instrumentation#LRM_Instrumentation|Localyzer Instrumentation]] for more information.
  +
  +
== What is Send Unique Filenames? ==
  +
  +
When configuring an Localyzer project in Jenkins, under the General Settings, there is a checkbox for '''Send Unique Filenames'''.
  +
  +
[[File:SendUniqueFilenames.jpg | 600px ]]
  +
  +
This is defaulted to be unchecked. Check this box if the files to be translated have the same names, but are in different folders. For example if you have resource files in two directories, but the files themselves are the same names.
  +
  +
../first_en_US/values.json
  +
../second_en_US/values.json
  +
  +
Localyzer sends only the files to be translated. Checking the '''Send Unique Filename''' box ensures that the files get unique names that are tracked and then returned to the correct location upon import.
  +
  +
For this example, if the default is left and it is unchecked, then ''a prep kit will be created for each file''. For this example, two prep kits would be created and sent to be translated. If there are many folders that contain the same name, many prep kits will be created.

Latest revision as of 19:29, 22 September 2021

What resource file types are supported by Localyzer?

Standard Localyzer extensions

Unique Extensions

Any file extension can be handled by Localyzer 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.

ExtensionParserType.jpg

Above is an example configuring a Jenkins Localyzer project. The Extension is 'properties' and the Parser Type is 'properties' so Localyzer will recognize the file myfile_en_US.properties as a resource file. If the filename is myfile_en_US.prop, that would not be recognized as a properties resource file. Changing the Extension to 'prop' would allow myfile_en_US.prop to be recognized as a properties parser type file.

The parser types are:

How to work with unsupported File Types

Localyzer supports a number of file types out of the box (See above). However, other file types may represent user facing strings to be translated. In that case, some customization is required to on-board those projects. The Transform Framework facilitates the customization.

Why are there files in my repository that end in _LRMLQA?

These are the Localyzer instrumented files that were created during the instrument resource files command. See Localyzer Instrumentation for more information.

What is Send Unique Filenames?

When configuring an Localyzer project in Jenkins, under the General Settings, there is a checkbox for Send Unique Filenames.

SendUniqueFilenames.jpg

This is defaulted to be unchecked. Check this box if the files to be translated have the same names, but are in different folders. For example if you have resource files in two directories, but the files themselves are the same names.

../first_en_US/values.json
../second_en_US/values.json

Localyzer sends only the files to be translated. Checking the Send Unique Filename box ensures that the files get unique names that are tracked and then returned to the correct location upon import.

For this example, if the default is left and it is unchecked, then a prep kit will be created for each file. For this example, two prep kits would be created and sent to be translated. If there are many folders that contain the same name, many prep kits will be created.