Resource Files - Revision history

Olibouban: /* How to work with unsupported File Types */

2021-09-22T19:29:09Z

How to work with unsupported File Types

← Older revision		Revision as of 19:29, 22 September 2021
Line 43:		Line 43:

	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.		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 '''[[~~Other_File_Types~~\|Transform Framework]]''' facilitates the customization.		The '''[[Transform_Framework\|Transform Framework]]''' facilitates the customization.

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

Olibouban: /* How to work with unsupported File Types */

2021-09-22T19:28:05Z

How to work with unsupported File Types

← Older revision		Revision as of 19:28, 22 September 2021
Line 43:		Line 43:

	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.		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 '''~~bash script transform framework''' facilitates the customization.~~		The '''[[Other_File_Types\|Transform Framework]]''' facilitates the customization.

	~~=== Analyze the file types ===~~
	~~If the file types fall into a category not supported by Localyzer out of the box, the first thing to do is to see what is the closest file types supported by Localyzer.~~

	[[Other_File_Types\|Transform Framework]]

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

Olibouban: /* Analyze the file types */

2021-09-22T19:26:43Z

Analyze the file types

← Older revision		Revision as of 19:26, 22 September 2021
Line 48:		Line 48:
	If the file types fall into a category not supported by Localyzer out of the box, the first thing to do is to see what is the closest file types supported by Localyzer.		If the file types fall into a category not supported by Localyzer out of the box, the first thing to do is to see what is the closest file types supported by Localyzer.

	[~~Other File Types~~\|~~Other File Types~~]		[[Other_File_Types\|Transform Framework]]

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

Olibouban: /* How to work with unsupported File Types */

2021-09-22T19:25:57Z

How to work with unsupported File Types

@@ Line 48: / Line 48: @@
 If the file types fall into a category not supported by Localyzer out of the box, the first thing to do is to see what is the closest file types supported by Localyzer.
-=== Use the transform framework ===
+[Other File Types|Other File Types]
 == Why are there files in my repository that end in ''_LRMLQA''? ==

Rdaly: /* Why are there files in my repository that end in _LRMLQA? */

2021-07-09T21:29:21Z

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

← Older revision		Revision as of 21:29, 9 July 2021
Line 174:		Line 174:
	== Why are there files in my repository that end in ''_LRMLQA''? ==		== 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.		These are the Localyzer instrumented files that were created during the ''instrument resource files'' command.
	See [[LRM_Instrumentation#LRM_Instrumentation\|~~LRM Instrumented Files~~]] for more information.		See [[LRM_Instrumentation#LRM_Instrumentation\|Localyzer Instrumentation]] for more information.

	== What is Send Unique Filenames? ==		== What is Send Unique Filenames? ==

Rdaly: /* What resource file types are supported by Localyzer? */

2021-07-09T21:28:11Z

What resource file types are supported by Localyzer?

← Older revision		Revision as of 21:28, 9 July 2021
Line 1:		Line 1:
	== What resource file types are supported by Localyzer?==		== 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>

Rdaly at 21:27, 9 July 2021

2021-07-09T21:27:53Z

Rdaly: /* What is Send Unique Filenames? */

2019-12-18T22:46:13Z

What is Send Unique Filenames?

← Older revision		Revision as of 22:46, 18 December 2019
Line 189:		Line 189:
	LRM 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.		LRM 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.		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.

Rdaly: /* Unique Extensions */

2019-12-13T21:39:40Z

Unique Extensions

← Older revision		Revision as of 21:39, 13 December 2019
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_yaml_Support~~\|''binary'']]</b> parser</li>		<li><b>[[LRM_Binary_Support\|''binary'']]</b> parser</li>
	</ul>		</ul>

Rdaly: /* Unique Extensions */

2019-12-13T21:37:43Z

Unique Extensions

← Older revision		Revision as of 21:37, 13 December 2019
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_yaml_Support\|''binary'']]</b> parser</li>
	</ul>		</ul>


	==How to work with unsupported File Types==		==How to work with unsupported File Types==

← Older revision		Revision as of 21:27, 9 July 2021
Line 1:		Line 1:
	== What resource file types are supported by ~~LRM~~?==		== What resource file types are supported by Localyzer?==
	=== Standard LRM extensions ===		=== Standard LRM extensions ===
	<ul>		<ul>
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 42:		Line 42:
	==How to work with unsupported File Types==		==How to work with unsupported File Types==

	~~LRM~~ 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.		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 '''bash script transform framework''' facilitates the customization.		The '''bash script transform framework''' facilitates the customization.

	=== Analyze the file types ===		=== Analyze the file types ===
	If the file types fall into a category not supported by ~~LRM~~ out of the box, the first thing to do is to see what is the closest file types supported by ~~LRM~~.		If the file types fall into a category not supported by Localyzer out of the box, the first thing to do is to see what is the closest file types supported by Localyzer.

	=== Use the transform framework ===		=== Use the transform framework ===
	The transform framework needs '''three scripts''' in order to fit in with ~~LRM~~. The three scripts need to be under the <code>$JENKINS_HOME/lingoport/transform/<nameoftransform>/</code> directory.		The transform framework needs '''three scripts''' in order to fit in with Localyzer. The three scripts need to be under the <code>$JENKINS_HOME/lingoport/transform/<nameoftransform>/</code> directory.


Line 56:		Line 56:

	The three scripts to write are:		The three scripts to write are:
	* '''transform_from_repo.sh''': How to transform the files from the repository so they fit into an ~~LRM~~ supported file type		* '''transform_from_repo.sh''': How to transform the files from the repository so they fit into an Localyzer supported file type
	* '''transform_to_repo.sh''': How to transform translated/pseudo-localized files in an ~~LRM~~ supported file type into the repository file type		* '''transform_to_repo.sh''': How to transform translated/pseudo-localized files in an Localyzer supported file type into the repository file type
	* '''transform_files_list.sh''': How to transform the file names from the ~~LRM~~ supported file naming into the repository file naming		* '''transform_files_list.sh''': How to transform the file names from the Localyzer supported file naming into the repository file naming


Line 73:		Line 73:
	They are set before calling the transform framework.		They are set before calling the transform framework.

	* '''CLIENT_SOURCE_DIR''' : For an ~~LRM~~ project such as CET.json, the CLIENT_SOURCE_DIR would typically be ~jenkins/jobs/CET.json/workspace. Note: This is not necessarily the WORKSPACE of the running Jenkins job from which the transform is called (Dashboard Update for instance).		* '''CLIENT_SOURCE_DIR''' : For an Localyzer project such as CET.json, the CLIENT_SOURCE_DIR would typically be ~jenkins/jobs/CET.json/workspace. Note: This is not necessarily the WORKSPACE of the running Jenkins job from which the transform is called (Dashboard Update for instance).
	* '''LRM_GROUP_NAME''' : The name of the ~~LRM~~ Group Name (e.g. 'CET' )		* '''LRM_GROUP_NAME''' : The name of the Localyzer Group Name (e.g. 'CET' )
	* '''LRM_PROJECT_NAME''' : The name of the ~~LRM~~ Project Name (e.g. 'json' )		* '''LRM_PROJECT_NAME''' : The name of the Localyzer Project Name (e.g. 'json' )
	* '''TRANSFORM_DIR''' : The transform scripts directory (e.g. 'loc' )		* '''TRANSFORM_DIR''' : The transform scripts directory (e.g. 'loc' )

Line 173:		Line 173:

	== Why are there files in my repository that end in ''_LRMLQA''? ==		== Why are there files in my repository that end in ''_LRMLQA''? ==
	These are the ~~LRM~~ instrumented files that were created during the ''instrument resource files'' command.		These are the Localyzer instrumented files that were created during the ''instrument resource files'' command.
	See [[LRM_Instrumentation#LRM_Instrumentation\|LRM Instrumented Files]] for more information.		See [[LRM_Instrumentation#LRM_Instrumentation\|LRM Instrumented Files]] for more information.

	== What is Send Unique Filenames? ==		== What is Send Unique Filenames? ==

	When configuring an ~~LRM~~ project in Jenkins, under the General Settings, there is a checkbox for '''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 ]]		[[File:SendUniqueFilenames.jpg \| 600px ]]
Line 187:		Line 187:
	../second_en_US/values.json		../second_en_US/values.json

	~~LRM~~ 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.		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.		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.