Prep Kits - Revision history

Llawson: /* Is there a way to create a prep kit zip file that contains files for all the locales rather than just 1 zip file per locale? */

2022-05-11T16:20:48Z

Is there a way to create a prep kit zip file that contains files for all the locales rather than just 1 zip file per locale?

← Older revision		Revision as of 16:20, 11 May 2022
Line 299:		Line 299:

	= Is there a way to create a prep kit zip file that contains files for all the locales rather than just 1 zip file per locale? =		= Is there a way to create a prep kit zip file that contains files for all the locales rather than just 1 zip file per locale? =
	If there is a need to send files for '''all''' the locales in 1 zip file, then the <code>prep.kit.locales.in.one.project</code> flag needs to be changed in configuration file '''<code>config_lrm_info.properties</code>''' which resides in the '''<code>/var/lib/jenkins/Lingoport_Data/L10nStreamlining/<group-name>/config</code>''' folder. The L10n Vendors supporting one prep kit for all locales are '''FTP''', '''Local''' and '''Lingotek'''.		If there is a need to send files for '''all''' the locales in 1 zip file, then the <code>prep.kit.locales.in.one.project</code> flag needs to be changed in configuration file '''<code>config_lrm_info.properties</code>''' which resides in the '''<code>/var/lib/jenkins/Lingoport_Data/L10nStreamlining/<group-name>/config</code>''' folder. The L10n Vendors supporting one prep kit for all locales are '''FTP''', '''Local''' and '''Lingotek'''. See [[Zip_Files_For_Prep_and_Import \| Prep/Import Zip Files]] for more information.

Llawson: /* What is done when a prep kit is generated? */

2022-05-11T16:20:31Z

What is done when a prep kit is generated?

← Older revision		Revision as of 16:20, 11 May 2022
Line 101:		Line 101:
	For missing keys (or modified text) only the changed keys will be sent.		For missing keys (or modified text) only the changed keys will be sent.

	By default, when prep kits are sent, a zip file is created for each locale with the name: '''<code><GroupName>.<ProjectName>.<prep kit number>.<locale>.zip</code>'''. For example, for Acme project Weather, prep kit 5 and locale 'FR_fr': '''<code>Acme.Weather.5.fr_fr.zip</code>'''. If there is a need to send files for '''all''' the locales in 1 zip file, then the <code>prep.kit.locales.in.one.project</code> flag needs to be changed in configuration file '''<code>config_lrm_info.properties</code>''' which resides in the '''<code>/var/lib/jenkins/Lingoport_Data/L10nStreamlining/<group-name>/config</code>''' folder. See [[Zip_Files_For_Prep_and_Import Prep/Import Zip Files]] for more information.		By default, when prep kits are sent, a zip file is created for each locale with the name: '''<code><GroupName>.<ProjectName>.<prep kit number>.<locale>.zip</code>'''. For example, for Acme project Weather, prep kit 5 and locale 'FR_fr': '''<code>Acme.Weather.5.fr_fr.zip</code>'''. If there is a need to send files for '''all''' the locales in 1 zip file, then the <code>prep.kit.locales.in.one.project</code> flag needs to be changed in configuration file '''<code>config_lrm_info.properties</code>''' which resides in the '''<code>/var/lib/jenkins/Lingoport_Data/L10nStreamlining/<group-name>/config</code>''' folder. See [[Zip_Files_For_Prep_and_Import \| Prep/Import Zip Files]] for more information.

	=How can I prevent a file or folder from being included in the prep kit?=		=How can I prevent a file or folder from being included in the prep kit?=

Llawson: /* What is done when a prep kit is generated? */

2022-05-11T16:19:22Z

What is done when a prep kit is generated?

← Older revision		Revision as of 16:19, 11 May 2022
Line 101:		Line 101:
	For missing keys (or modified text) only the changed keys will be sent.		For missing keys (or modified text) only the changed keys will be sent.

	By default, when prep kits are sent, a zip file is created for each locale with the name: '''<code><GroupName>.<ProjectName>.<prep kit number>.<locale>.zip</code>'''. For example, for Acme project Weather, prep kit 5 and locale 'FR_fr': '''<code>Acme.Weather.5.fr_fr.zip</code>'''. If there is a need to send files for '''all''' the locales in 1 zip file, then the <code>prep.kit.locales.in.one.project</code> flag needs to be changed in configuration file '''<code>config_lrm_info.properties</code>''' which resides in the '''<code>/var/lib/jenkins/Lingoport_Data/L10nStreamlining/<group-name>/config</code>''' folder.		By default, when prep kits are sent, a zip file is created for each locale with the name: '''<code><GroupName>.<ProjectName>.<prep kit number>.<locale>.zip</code>'''. For example, for Acme project Weather, prep kit 5 and locale 'FR_fr': '''<code>Acme.Weather.5.fr_fr.zip</code>'''. If there is a need to send files for '''all''' the locales in 1 zip file, then the <code>prep.kit.locales.in.one.project</code> flag needs to be changed in configuration file '''<code>config_lrm_info.properties</code>''' which resides in the '''<code>/var/lib/jenkins/Lingoport_Data/L10nStreamlining/<group-name>/config</code>''' folder. See [[Zip_Files_For_Prep_and_Import Prep/Import Zip Files]] for more information.

	=How can I prevent a file or folder from being included in the prep kit?=		=How can I prevent a file or folder from being included in the prep kit?=

Llawson: /* Is there a way to create a prep kit zip file that contains files for all the locales rather than just 1 zip file per locale? */

2022-05-11T15:51:39Z

Is there a way to create a prep kit zip file that contains files for all the locales rather than just 1 zip file per locale?

← Older revision		Revision as of 15:51, 11 May 2022
Line 299:		Line 299:

	= Is there a way to create a prep kit zip file that contains files for all the locales rather than just 1 zip file per locale? =		= Is there a way to create a prep kit zip file that contains files for all the locales rather than just 1 zip file per locale? =
	If there is a need to send files for '''all''' the locales in 1 zip file, then the <code>prep.kit.locales.in.one.project</code> flag needs to be changed in configuration file '''<code>config_lrm_info.properties</code>''' which resides in the '''<code>/var/lib/jenkins/Lingoport_Data/L10nStreamlining/<group-name>/config</code>''' folder.		If there is a need to send files for '''all''' the locales in 1 zip file, then the <code>prep.kit.locales.in.one.project</code> flag needs to be changed in configuration file '''<code>config_lrm_info.properties</code>''' which resides in the '''<code>/var/lib/jenkins/Lingoport_Data/L10nStreamlining/<group-name>/config</code>''' folder. The L10n Vendors supporting one prep kit for all locales are '''FTP''', '''Local''' and '''Lingotek'''.

Llawson: /* Is there a way to create a prep kit zip file that contains files for all the locales rather than just 1 zip file per locale? */

2022-05-11T15:49:19Z

Is there a way to create a prep kit zip file that contains files for all the locales rather than just 1 zip file per locale?

← Older revision		Revision as of 15:49, 11 May 2022
Line 299:		Line 299:

	= Is there a way to create a prep kit zip file that contains files for all the locales rather than just 1 zip file per locale? =		= Is there a way to create a prep kit zip file that contains files for all the locales rather than just 1 zip file per locale? =
			If there is a need to send files for '''all''' the locales in 1 zip file, then the <code>prep.kit.locales.in.one.project</code> flag needs to be changed in configuration file '''<code>config_lrm_info.properties</code>''' which resides in the '''<code>/var/lib/jenkins/Lingoport_Data/L10nStreamlining/<group-name>/config</code>''' folder.

Llawson: /* What is done when a prep kit is generated? */

2022-05-11T15:48:29Z

What is done when a prep kit is generated?

← Older revision		Revision as of 15:48, 11 May 2022
Line 101:		Line 101:
	For missing keys (or modified text) only the changed keys will be sent.		For missing keys (or modified text) only the changed keys will be sent.

	By default, when prep kits are sent, a zip file is created for each locale with the name: '''<code><GroupName>.<ProjectName>.<prep kit number>.<locale>.zip</code>'''. For example, for Acme project Weather, prep kit 5 and locale 'FR_fr': '''<code>Acme.Weather.5.fr_fr.zip</code>'''. If there is need to send files for all the locales, then the ~~'''~~prep.kit.locales.in.one.project~~'''~~ flag needs to be changed in the ~~config_lrm_info file~~.		By default, when prep kits are sent, a zip file is created for each locale with the name: '''<code><GroupName>.<ProjectName>.<prep kit number>.<locale>.zip</code>'''. For example, for Acme project Weather, prep kit 5 and locale 'FR_fr': '''<code>Acme.Weather.5.fr_fr.zip</code>'''. If there is a need to send files for '''all''' the locales in 1 zip file, then the <code>prep.kit.locales.in.one.project</code> flag needs to be changed in configuration file '''<code>config_lrm_info.properties</code>''' which resides in the '''<code>/var/lib/jenkins/Lingoport_Data/L10nStreamlining/<group-name>/config</code>''' folder.

	=How can I prevent a file or folder from being included in the prep kit?=		=How can I prevent a file or folder from being included in the prep kit?=

Llawson: /* What is done when a prep kit is generated? */

2022-05-11T15:43:25Z

What is done when a prep kit is generated?

← Older revision		Revision as of 15:43, 11 May 2022
Line 101:		Line 101:
	For missing keys (or modified text) only the changed keys will be sent.		For missing keys (or modified text) only the changed keys will be sent.

	By default, when prep kits are sent, a zip file is created for each locale with the name: '''<code><GroupName>.<ProjectName>.<prep kit number>.<locale>.zip</code>'''. For example, for Acme project Weather, prep kit 5 and locale 'FR_fr': '''<code>Acme.Weather.5.fr_fr.zip</code>'''. If there is need to send files for all the locales, then the flag needs to be changed in the config_lrm_info file.		By default, when prep kits are sent, a zip file is created for each locale with the name: '''<code><GroupName>.<ProjectName>.<prep kit number>.<locale>.zip</code>'''. For example, for Acme project Weather, prep kit 5 and locale 'FR_fr': '''<code>Acme.Weather.5.fr_fr.zip</code>'''. If there is need to send files for all the locales, then the '''prep.kit.locales.in.one.project''' flag needs to be changed in the config_lrm_info file.

	=How can I prevent a file or folder from being included in the prep kit?=		=How can I prevent a file or folder from being included in the prep kit?=

Llawson: /* What is done when a prep kit is generated? */

2022-05-11T15:41:13Z

What is done when a prep kit is generated?

← Older revision		Revision as of 15:41, 11 May 2022
Line 101:		Line 101:
	For missing keys (or modified text) only the changed keys will be sent.		For missing keys (or modified text) only the changed keys will be sent.

	~~When~~ prep kits are sent, a zip file is created for each locale with the name: '''<code><GroupName>.<ProjectName>.<prep kit number>.<locale>.zip</code>'''. For example, for Acme project Weather, prep kit 5 and locale 'FR_fr': '''<code>Acme.Weather.5.fr_fr.zip</code>'''		By default, when prep kits are sent, a zip file is created for each locale with the name: '''<code><GroupName>.<ProjectName>.<prep kit number>.<locale>.zip</code>'''. For example, for Acme project Weather, prep kit 5 and locale 'FR_fr': '''<code>Acme.Weather.5.fr_fr.zip</code>'''. If there is need to send files for all the locales, then the flag needs to be changed in the config_lrm_info file.

	=How can I prevent a file or folder from being included in the prep kit?=		=How can I prevent a file or folder from being included in the prep kit?=

Llawson at 15:36, 11 May 2022

2022-05-11T15:36:47Z

← Older revision		Revision as of 15:36, 11 May 2022
Line 297:		Line 297:

	* In your configuration, check the '''Send Unique File Names''' if you want the prep kit files to have unique file names. The default is not to send unique file names. If you have multiple file names that have the same name you may want to check the box. For more information see [[LRM_Unique_File_Names\|Localyzer Unique File Names]].		* In your configuration, check the '''Send Unique File Names''' if you want the prep kit files to have unique file names. The default is not to send unique file names. If you have multiple file names that have the same name you may want to check the box. For more information see [[LRM_Unique_File_Names\|Localyzer Unique File Names]].

			= Is there a way to create a prep kit zip file that contains files for all the locales rather than just 1 zip file per locale? =

Rdaly at 22:27, 9 July 2021

2021-07-09T22:27:50Z

← Older revision		Revision as of 22:27, 9 July 2021
Line 1:		Line 1:
	=What is a Baseline?=		=What is a Baseline?=

	A baseline is done when ~~an LRM~~ project is created to track the information in the base files and the translated files. If any of those keys and values are modified before a Prep Kit is created, the changes will be caught. For more information see [[Baseline \|Baseline]].		A baseline is done when a Localyzer project is created to track the information in the base files and the translated files. If any of those keys and values are modified before a Prep Kit is created, the changes will be caught. For more information see [[Baseline \|Baseline]].

	=What is a Prep Kit? =		=What is a Prep Kit? =

	A Prep Kit is what we call the set of resource files that are gathered by ~~LRM~~, sent out for translation, and then integrated back into the source code tree once translated. ~~LRM~~ sets and tracks versions of a Kit so that, as your developers add strings to the base resource files, you can prepare and send out the kit multiple times. There are a variety of checks that ~~LRM~~ makes on the base resource files to ensure that they are correct, as well as tracking the progress and correctness of the translated resource files.		A Prep Kit is what we call the set of resource files that are gathered by Localyzer, sent out for translation, and then integrated back into the source code tree once translated. Localyzer sets and tracks versions of a Kit so that, as your developers add strings to the base resource files, you can prepare and send out the kit multiple times. There are a variety of checks that Localyzer makes on the base resource files to ensure that they are correct, as well as tracking the progress and correctness of the translated resource files.

	Note: If your project contains translated files, then when prepping your first kit, ~~LRM~~ will not be able to detect if a text change has occurred within a resource string. It will, however, be able to detect added keys or missed translations.		Note: If your project contains translated files, then when prepping your first kit, Localyzer will not be able to detect if a text change has occurred within a resource string. It will, however, be able to detect added keys or missed translations.

	= How do I prep a kit and receive it back from translation?=		= How do I prep a kit and receive it back from translation?=
Line 53:		Line 53:
	=What is done when a prep kit is generated? =		=What is done when a prep kit is generated? =

	After a ~~LRM~~ project is created and correctly identifies the base and target resource files, the project needs to be baselined. When the project is baselined, the base resource files are in the system. If any changes happen to them afterward, this will be picked up in the prep kit. This is done in the Jenkins Nightly job or it can be done on the command line.		After a Localyzer project is created and correctly identifies the base and target resource files, the project needs to be baselined. When the project is baselined, the base resource files are in the system. If any changes happen to them afterward, this will be picked up in the prep kit. This is done in the Jenkins Nightly job or it can be done on the command line.

	> java -jar /var/lib/jenkins/lingoport/lrm-server-<version>/lrm-cli.jar --create-baseline --project-name <project-name> -- group-name <group-name>		> java -jar /var/lib/jenkins/lingoport/lrm-server-<version>/lrm-cli.jar --create-baseline --project-name <project-name> -- group-name <group-name>

	~~LRM~~ is able to detect modified text as well as missing keys and missing files.		Localyzer is able to detect modified text as well as missing keys and missing files.

	For example let's say you have a project with:		For example let's say you have a project with:
Line 70:		Line 70:


	'''Create a prep kit''' for the new ~~LRM~~ project by selecting the '''Prep Kit''' button on the Lingoport Dashboard or by running the Jenkins '''<project-name>-PrepKit''' job.		'''Create a prep kit''' for the new Localyzer project by selecting the '''Prep Kit''' button on the Lingoport Dashboard or by running the Jenkins '''<project-name>-PrepKit''' job.

	<pre>		<pre>
Line 129:		Line 129:
	= Modified text does not seem to be recognized as a change in my base resource file. What is wrong? =		= Modified text does not seem to be recognized as a change in my base resource file. What is wrong? =

	Modified text can only be detected if there has been a baseline created for the project. In this way, ~~LRM~~ can detect any modifications to file text. The Jenkins nightly Notification job for a project automatically calls the create baseline command. This command can also be called on the command line. See [[LRM_Commands_Reference#Create_a_project_baseline\| Create Project Baseline]] for more information.		Modified text can only be detected if there has been a baseline created for the project. In this way, Localyzer can detect any modifications to file text. The Jenkins nightly Notification job for a project automatically calls the create baseline command. This command can also be called on the command line. See [[LRM_Commands_Reference#Create_a_project_baseline\| Create Project Baseline]] for more information.

	=When I prep a kit, what files are created?=		=When I prep a kit, what files are created?=
Line 278:		Line 278:

	= I always want to send full files rather than deltas to my vendor. How do I set this up? =		= I always want to send full files rather than deltas to my vendor. How do I set this up? =
	By default, ~~LRM~~ sends out deltas in a prep kit (CHANGES-ONLY) unless there is a missing file.		By default, Localyzer sends out deltas in a prep kit (CHANGES-ONLY) unless there is a missing file.
	This setting, <code>prep.kit.changes.only</code>, is located in configuration file '''<code>config_lrm_info.properties</code>''' which resides in the '''<code>/var/lib/jenkins/Lingoport_Data/L10nStreamlining/<group-name>/config</code>''' folder.		This setting, <code>prep.kit.changes.only</code>, is located in configuration file '''<code>config_lrm_info.properties</code>''' which resides in the '''<code>/var/lib/jenkins/Lingoport_Data/L10nStreamlining/<group-name>/config</code>''' folder.

Line 296:		Line 296:
	[[File:Build1.png\|700px]]		[[File:Build1.png\|700px]]

	* In your configuration, check the '''Send Unique File Names''' if you want the prep kit files to have unique file names. The default is not to send unique file names. If you have multiple file names that have the same name you may want to check the box. For more information see [[LRM_Unique_File_Names\|~~LRM~~ Unique File Names]].		* In your configuration, check the '''Send Unique File Names''' if you want the prep kit files to have unique file names. The default is not to send unique file names. If you have multiple file names that have the same name you may want to check the box. For more information see [[LRM_Unique_File_Names\|Localyzer Unique File Names]].