Difference between revisions of "Lingoport Wiki:Zip Files For Prep and Import"
(→One Zip File for all Locales, per Prep Kit Number) |
m (Llawson moved page Prep/Import Zip Files to Lingoport Wiki:Zip Files For Prep and Import) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
Localyzer sends files to and from translation via zip files. For some L10n Vendors, such as '''FTP''' and '''local''', the zip files are used directly by translation. For other vendors, such as '''Lingotek''' and '''Worldserver''', Localyzer will use the zip files to upload files into the L10n Vendors system. |
Localyzer sends files to and from translation via zip files. For some L10n Vendors, such as '''FTP''' and '''local''', the zip files are used directly by translation. For other vendors, such as '''Lingotek''' and '''Worldserver''', Localyzer will use the zip files to upload files into the L10n Vendors system. |
||
| + | |||
| − | By default, when a Localyzer project is prepped, there will be one zip file per locale. |
||
== One Zip File per Locale and per Prep Kit Number == |
== One Zip File per Locale and per Prep Kit Number == |
||
| − | The files sent back and forth |
+ | The zip files sent back and forth have the following characteristics: |
* The data files to be translated or returned from translation are sent in a '''zip file'''. |
* The data files to be translated or returned from translation are sent in a '''zip file'''. |
||
| Line 14: | Line 14: | ||
== One Zip File for all Locales, per Prep Kit Number == |
== One Zip File for all Locales, per Prep Kit Number == |
||
| + | By default, when a Localyzer project is prepped, there will be one 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''' the <code>$JENKINS_HOME/Lingoport_Data/L10nStreamlining/<GROUP>/projects/<PROJECT_NAME>/config_lrm_info.properties</code> is configured with the following property: |
||
| + | Once set, '''if''' all the files to be translated are the same (same deltas or same full-files), '''then''' the files sent back and forth will have the following characteristics: |
||
| − | prep.kit.locales.in.one.project=1 |
||
| − | |||
| − | And '''if''' all the files to be translated are the same (same deltas or same full-files), |
||
| − | |||
| − | '''then''' the files sent back and forth over FTP have the following characteristics: |
||
* The data files to be translated are sent in one '''zip file''' for all locales. |
* The data files to be translated are sent in one '''zip file''' for all locales. |
||
* The '''zip file''' is named according to this convention: '''<code><group-name>.<project-name>.<kit-version>.zip</code>'''. For example, a zip file could be named '''<code>Queens.Champions.1.zip</code>''': The group-name is Queens, the project-name is Champions, and the kit version is 1. |
* The '''zip file''' is named according to this convention: '''<code><group-name>.<project-name>.<kit-version>.zip</code>'''. For example, a zip file could be named '''<code>Queens.Champions.1.zip</code>''': The group-name is Queens, the project-name is Champions, and the kit version is 1. |
||
| − | * The zip file consists of '''one top level directory''', <code><group-name>.<project-name>.<kit-version>, with all the files to be translated under it. |
+ | * The zip file consists of '''one top level directory''', <code><group-name>.<project-name>.<kit-version></code>, with all the files to be translated under it. |
* The zip file contains two files indicating the source locale and the target locales |
* The zip file contains two files indicating the source locale and the target locales |
||
| + | * There is '''one zip file for all target locales'''. You may target 10 locales for translation for project "Champions" under group "Queens". You then would have 1 zip files to send over, again, if all the files are the same. |
||
| − | ** |
||
| − | * There is '''one zip file for all target locales'''. You may target 10 locales for translation for project "Champions" under group "Queens". You then would have 1 zip files to send over FTP, again, if all the files are the same. |
||
* A zip file may contain '''more than one file and more than one file type'''. |
* A zip file may contain '''more than one file and more than one file type'''. |
||
* Each file to be translated has a comment at the top of the file which needs to be kept when returning the file from translation vendor. |
* Each file to be translated has a comment at the top of the file which needs to be kept when returning the file from translation vendor. |
||
* The '''translated files''' will be named the same as the original files (so they could be _en.properties even if the content is for French) |
* The '''translated files''' will be named the same as the original files (so they could be _en.properties even if the content is for French) |
||
* The '''translated files''' will be returned in one zip file per locale, in the form: '''<code><group-name>.<project-name>.<kit-version><locale>.zip</code>'''. For example, a translation for French may be named: '''<code>Queens.Champions.1.fr.zip</code>'''. |
* The '''translated files''' will be returned in one zip file per locale, in the form: '''<code><group-name>.<project-name>.<kit-version><locale>.zip</code>'''. For example, a translation for French may be named: '''<code>Queens.Champions.1.fr.zip</code>'''. |
||
| − | |||
| − | Two FTP endpoints are necessary: a ''''to translation'''' end point and a ''''from translation'''' endpoint. |
||
Latest revision as of 16:17, 11 May 2022
Localyzer sends files to and from translation via zip files. For some L10n Vendors, such as FTP and local, the zip files are used directly by translation. For other vendors, such as Lingotek and Worldserver, Localyzer will use the zip files to upload files into the L10n Vendors system.
One Zip File per Locale and per Prep Kit Number
The zip files sent back and forth have the following characteristics:
- The data files to be translated or returned from translation are sent in a zip file.
- The zip file is named according to this convention:
<group-name>.<project-name>.<kit-version>.<locale>.zip. For example, a zip file could be namedQueens.Champions.1.fr_fr.zip: The group-name is Queens, the project-name is Champions, the kit version is 1, and the target locale is fr_FR or fr-fr (the locale separator is always an underscore in the zip file name). - The zip file consists of one top level directory,
<group-name>.<project-name>.<kit-version>.<locale>, with all the files to be translated under it. - There is one zip file per target locale. You may target 10 locales for translation for project "Champions" under group "Queens". You then would have 10 zip files to send to translation.
- A zip file may contain more than one file and more than one file type.
- Each file to be translated has a comment at the top of the file which needs to be kept when returning the file from translation vendor.
- The translated files will be named the same as the original files (so they could be _en.properties even if the content is for French)
One Zip File for all Locales, per Prep Kit Number
By default, when a Localyzer project is prepped, there will be one zip file per locale. If there is a need to send files for all the locales in 1 zip file, then the prep.kit.locales.in.one.project flag needs to be changed in configuration file config_lrm_info.properties which resides in the /var/lib/jenkins/Lingoport_Data/L10nStreamlining/<group-name>/config folder. The L10n Vendors supporting one prep kit for all locales are FTP, Local and Lingotek.
Once set, if all the files to be translated are the same (same deltas or same full-files), then the files sent back and forth will have the following characteristics:
- The data files to be translated are sent in one zip file for all locales.
- The zip file is named according to this convention:
<group-name>.<project-name>.<kit-version>.zip. For example, a zip file could be namedQueens.Champions.1.zip: The group-name is Queens, the project-name is Champions, and the kit version is 1. - The zip file consists of one top level directory,
<group-name>.<project-name>.<kit-version>, with all the files to be translated under it. - The zip file contains two files indicating the source locale and the target locales
- There is one zip file for all target locales. You may target 10 locales for translation for project "Champions" under group "Queens". You then would have 1 zip files to send over, again, if all the files are the same.
- A zip file may contain more than one file and more than one file type.
- Each file to be translated has a comment at the top of the file which needs to be kept when returning the file from translation vendor.
- The translated files will be named the same as the original files (so they could be _en.properties even if the content is for French)
- The translated files will be returned in one zip file per locale, in the form:
<group-name>.<project-name>.<kit-version><locale>.zip. For example, a translation for French may be named:Queens.Champions.1.fr.zip.
