Transform Framework - Revision history

Rwilliams: /* Use the transform framework */

2026-04-03T19:12:47Z

Use the transform framework

← Older revision		Revision as of 19:12, 3 April 2026
Line 13:		Line 13:
	* '''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 LRM supported file naming into the repository file naming

	Each script can in turn call other scripts as ~~necessary~~.		Each of these script can in turn call other scripts as required.
			Be sure that when calling other bash shell scripts to use "source" or "." to do so. Command Center will automatically set the above three mentioned scripts to executable when used but does not do so for other scripts that may be added as part of the transform.

			if source "${TRANSFORM_DIR}/additional_code.sh" "${arg1}" ; then
			echo "Successfully executed ${TRANSFORM_DIR}/additional_code.sh"
			else
			echo "Failed to execute ${TRANSFORM_DIR}/additional_code.sh"
			fi

	For example, under		For example, under

Olibouban: /* Transform to repository variables */

2026-03-20T20:09:44Z

Transform to repository variables

← Older revision		Revision as of 20:09, 20 March 2026
Line 38:		Line 38:
	'''TRANSFORM_DIR''' : The transform scripts directory where the scripts are executed from.		'''TRANSFORM_DIR''' : The transform scripts directory where the scripts are executed from.
	'''PROJECT_TMP_DIR''' : Where temporary files can be stashed for this project during the script execution		'''PROJECT_TMP_DIR''' : Where temporary files can be stashed for this project during the script execution
	'''~~FULL_LIST_PATH~~''' : The list of all the files to be transformed from the translated files back to the repository		'''$1''' : The first parameter is the list of all the files to be transformed from the translated files back to the repository

	== Example: txt2propfiles ==		== Example: txt2propfiles ==

Olibouban: /* Transform to repository variables */

2026-03-20T19:38:45Z

Transform to repository variables

← Older revision		Revision as of 19:38, 20 March 2026
Line 35:		Line 35:
	=== Transform to repository variables ===		=== Transform to repository variables ===

	* '''CLIENT_SOURCE_DIR''' : The top level directory of the workspace for this project		'''CLIENT_SOURCE_DIR''' : The top level directory of the workspace for this project
	* '''TRANSFORM_DIR''' : The transform scripts directory where the scripts are executed from.		'''TRANSFORM_DIR''' : The transform scripts directory where the scripts are executed from.
	* '''PROJECT_TMP_DIR''' : Where temporary files can be stashed for this project during the script execution		'''PROJECT_TMP_DIR''' : Where temporary files can be stashed for this project during the script execution
	* '''FULL_LIST_PATH''' : The list of all the files to be transformed from the translated files back to the repository		'''FULL_LIST_PATH''' : The list of all the files to be transformed from the translated files back to the repository

	== Example: txt2propfiles ==		== Example: txt2propfiles ==

Olibouban: /* Transform to repository variables */

2026-03-20T19:32:03Z

Transform to repository variables

← Older revision		Revision as of 19:32, 20 March 2026
Line 35:		Line 35:
	=== Transform to repository variables ===		=== Transform to repository variables ===

			* '''CLIENT_SOURCE_DIR''' : The top level directory of the workspace for this project
	* '''TRANSFORM_DIR''' : The transform scripts directory where the scripts are executed from.		* '''TRANSFORM_DIR''' : The transform scripts directory where the scripts are executed from.
	* '''PROJECT_TMP_DIR''' : Where temporary files can be stashed for this project during the script execution		* '''PROJECT_TMP_DIR''' : Where temporary files can be stashed for this project during the script execution
	* '''PROJECT_TMP_DIR''' : A tmp directory
	* '''FULL_LIST_PATH''' : The list of all the files to be transformed from the translated files back to the repository		* '''FULL_LIST_PATH''' : The list of all the files to be transformed from the translated files back to the repository

Olibouban: /* Transform to repository variables */

2026-03-20T19:31:23Z

Transform to repository variables

← Older revision		Revision as of 19:31, 20 March 2026
Line 37:		Line 37:
	* '''TRANSFORM_DIR''' : The transform scripts directory where the scripts are executed from.		* '''TRANSFORM_DIR''' : The transform scripts directory where the scripts are executed from.
	* '''PROJECT_TMP_DIR''' : Where temporary files can be stashed for this project during the script execution		* '''PROJECT_TMP_DIR''' : Where temporary files can be stashed for this project during the script execution
			* '''PROJECT_TMP_DIR''' : A tmp directory
	* '''FULL_LIST_PATH''' : The list of all the files to be transformed from the translated files back to the repository		* '''FULL_LIST_PATH''' : The list of all the files to be transformed from the translated files back to the repository

Olibouban: /* Bash Variables */

2026-03-20T15:41:33Z

Bash Variables

← Older revision		Revision as of 15:41, 20 March 2026
Line 26:		Line 26:
	A few Bash variables are available when called from the Lingoport Jenkins jobs that use the transform framework.		A few Bash variables are available when called from the Lingoport Jenkins jobs that use the transform framework.
	They are set before calling the transform framework.		They are set before calling the transform framework.


			=== Transform from repository variables ===
			'''CLIENT_SOURCE_DIR''' : The top level directory of the workspace for this project
			'''TRANSFORM_DIR''' : The directory of the transform, the .sh are underneath this directory
			'''PROJECT_TMP_DIR''' : A tmp directory

			=== Transform to repository variables ===

	* '''TRANSFORM_DIR''' : The transform scripts directory where the scripts are executed from.		* '''TRANSFORM_DIR''' : The transform scripts directory where the scripts are executed from.

Olibouban: /* Transform System Files */

2025-03-27T14:52:02Z

Transform System Files

← Older revision		Revision as of 14:52, 27 March 2025
Line 174:		Line 174:

	=== Transform System Files ===		=== Transform System Files ===
	The transform is ~~retrieve~~ like any system file from the repository and set as a system file.		The transform is retrieved like any system file from the repository and set as a system file.

	* Put Command Center in Maintenance Mode		* Put Command Center in Maintenance Mode
Line 185:		Line 185:
	[[File:Transform System File.jpg\|center\|600px]]		[[File:Transform System File.jpg\|center\|600px]]

	When the repository is updated and the transform scripts are modified, update from the Edit button above to get the latest. The commit hash indicates which commit was last.		When the repository is updated and the transform scripts are modified, update from the Edit button above to get the latest. The commit hash indicates which commit was last.

	=== Set the Transform for a Project ===		=== Set the Transform for a Project ===

Olibouban at 20:56, 27 June 2024

2024-06-27T20:56:58Z

← Older revision		Revision as of 20:56, 27 June 2024
Line 1:		Line 1:
	~~LRM~~ supports a number of file types out of the box (See [[Supported Resource Bundles]]). 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 [[Supported Resource Bundles]]). 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.

Olibouban: /* Example: txt2propfiles */

2024-06-27T17:41:35Z

Example: txt2propfiles

← Older revision		Revision as of 17:41, 27 June 2024
Line 34:		Line 34:


	~~Say~~ the repository contains resource files like the following <code>strings.txt</code> file:		For a simple example, say the repository contains resource files like the following <code>strings.txt</code> file:
	<pre>		<pre>
	# Strings for use in GUI		# Strings for use in GUI

Olibouban: /* Analyze the file types */

2024-06-27T17:40:54Z

Analyze the file types

← Older revision		Revision as of 17:40, 27 June 2024
Line 3:		Line 3:

	= 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 and TMSs/LSPs/MTs.

	= Use the transform framework =		= Use the transform framework =