Difference between revisions of "LRM Import Checks"

From Lingoport Wiki
Jump to: navigation, search
(→‎LRM Translation Source Location Not Found Check)
(→‎LRM Translation Missing Localized File Check)
 
(12 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
These checks occur during the import process. The import file is checked for errors and then compared against its corresponding base resource file.
  
These checks occur during the import process. The import file is checked for errors and then compared against its corresponding base resource file.
   
  +
See [[LRM_Checks|''Localyzer Checks'']] for additional checks.
−
For checks against base resource files, see See [[LRM_Source_Base_Checks|Base Resource File Checks]]
  
−  
−
For checks against the translated files, see [[LRM_Source_Translation_Checks|Translated File Checks]].
  
   
 
===LRM Translation Duplicate Key Check===
  
===LRM Translation Duplicate Key Check===
  +
* The file that is to be imported has duplicate keys. Keys must be unique.
−
* This translated file already contains this key
  
  +
 
===LRM Translation Empty Key Check===
  
===LRM Translation Empty Key Check===
 
* a key/value pair is missing the key portion in the translated file to be imported, making the text irretrievable by the application.
  
* a key/value pair is missing the key portion in the translated file to be imported, making the text irretrievable by the application.
Line 13: Line 12:
 
* This translated file has an incorrect encoding or, if an xml file, the prolog may be missing
  
* This translated file has an incorrect encoding or, if an xml file, the prolog may be missing
 
===LRM Translation File Already Processed Check===
  
===LRM Translation File Already Processed Check===
−
* This file has already been processed for this kit
 +
* This file has already been processed for this kit. Rather then the --import-kit command, the --reimport-kit command needs to be called.
  +
 
===LRM Translation File Too Big Check===
  
===LRM Translation File Too Big Check===
−
* This translated file exceeds the maximum size supported by the Lingoport Resource Manager
 +
* The file that is to be imported exceeds the maximum size supported by the Lingoport Resource Manager
  +
 
===LRM Translation ICU Argument Mismatch Check===
  
===LRM Translation ICU Argument Mismatch Check===
 
* The translation does not contain the same ICU arguments as the base resource. Check the plural and/or select arguments. See http://userguide.icu-project.org/formatparse/messages for formatting examples. In addition, if the ICU MessageFormat contains parameters, then the parameters must match. See [[LRM_Import_Checks#LRM_Translation_Parameter_Mismatch_Check|Parameter Mismatch Check]]
  
* The translation does not contain the same ICU arguments as the base resource. Check the plural and/or select arguments. See http://userguide.icu-project.org/formatparse/messages for formatting examples. In addition, if the ICU MessageFormat contains parameters, then the parameters must match. See [[LRM_Import_Checks#LRM_Translation_Parameter_Mismatch_Check|Parameter Mismatch Check]]
Line 23: Line 24:
   
 
===LRM Translation Missed Translation Check===
  
===LRM Translation Missed Translation Check===
  +
* The text in the file to be imported is the same as the text in its corresponding base resource file. By default, in the project definition, this error check is set to false so that no error will occur if the text matches.
−
* The translation is missing for this text
  
  +
 
===LRM Translation Missing File Check===
  
===LRM Translation Missing File Check===
  +
* The file that is to be imported is missing from the kit to import. This usually occurs when the files that are in the import zip file are renamed. The names of the file in the import zip file must be the base resource file names.
−
* The translated file is missing from the kit to import
  
  +
  +
===LRM Translation Missing Localized File Check===
  +
* The localized file in the repo is missing (MISSING_LOCALIZED_FILE). This occurs during import for a changes-only prep if the localized file has been deleted. The localized file is required to exist in order to import a changes-only prep kit file.
  +
 
===LRM Translation Missing Key Check===
  
===LRM Translation Missing Key Check===
 
* The identifier/key is missing in the translated file.
  
* The identifier/key is missing in the translated file.
Line 31: Line 37:
 
* LRM cannot process a translated file if the LRM Tag is corrupted (see top of file)
  
* LRM cannot process a translated file if the LRM Tag is corrupted (see top of file)
 
===LRM Translation No Text Check===
  
===LRM Translation No Text Check===
−
* This resource key/identifier is missing in the translated text
 +
* The text value is missing in the file that is to be imported.
  +
 
===LRM Translation Parameter Mismatch Check===
  
===LRM Translation Parameter Mismatch Check===
−
* The import kit's file parameters do not match the prep kit's source file parameters. Possible reasons:
 +
* The parameters of file that is to be imported do not match its corresponding base resource file parameters. The parameter regex pattern is defined in the project. Possible reasons:
 
**Translator translated the parameter. For example, if the base resource file has {car} defined as a parameter but the translated French file has {voiture} then a parameter mismatch error will occur. The translator will need to fix this issue by not translating the parameter.
  
**Translator translated the parameter. For example, if the base resource file has {car} defined as a parameter but the translated French file has {voiture} then a parameter mismatch error will occur. The translator will need to fix this issue by not translating the parameter.
 
**Issue with single ticks surrounding a parameter with curly brackets.
  
**Issue with single ticks surrounding a parameter with curly brackets.
−
***''''{0}'''' - if there are single ticks surrounding the curly brackets then this means that the curly brackets do '''not''' represent a parameter. The single tick is used as a special character indicating that the curly bracket is a displayable character. So, if the base resource file has '''{0}''' and the imported file has ''"{0}"'' then a parameter mismatch will occur because '''{0}''' is '''not''' a parameter while ''"{0}"'' is a parameter.
+
***''''{0}'''' - if there are single ticks surrounding the curly brackets then this means that the curly brackets do '''not''' represent a parameter. The single tick is used as a special character indicating that the curly bracket is a displayable character. So, if the base resource file has '''{0}''' and the imported file has ''"{0}"'' then a parameter mismatch will occur because '''{0}''' is '''not''' a parameter while ''"{0}"'' is a parameter. Parameter mismatch will also occur if the opposite occurs (base resource file has ''"{0}"'' and the imported file has '''{0}''')
  +
**Number of parameters must match. For example, if the base resource file has 2 {0} parameters then the file that is to be imported must have 2 {0} parameters.
  +
 
===LRM Translation Source Location Not Found Check===
  
===LRM Translation Source Location Not Found Check===
 
* The source location cannot be found and this file cannot be imported to its source location. This occurs when the repository structure has changed after the kit was prepped and the location for the imported file no longer exists. In addition, if the translated file in the local repository no longer exists and the import file is for changes only, then this error will occur.
  
* The source location cannot be found and this file cannot be imported to its source location. This occurs when the repository structure has changed after the kit was prepped and the location for the imported file no longer exists. In addition, if the translated file in the local repository no longer exists and the import file is for changes only, then this error will occur.

Latest revision as of 22:06, 22 March 2023

LRM Translation Checks

These checks occur during the import process. The import file is checked for errors and then compared against its corresponding base resource file.

See Localyzer Checks for additional checks.

LRM Translation Duplicate Key Check

  • The file that is to be imported has duplicate keys. Keys must be unique.

LRM Translation Empty Key Check

  • a key/value pair is missing the key portion in the translated file to be imported, making the text irretrievable by the application.

LRM Translation Encoding Check

  • This translated file has an incorrect encoding or, if an xml file, the prolog may be missing

LRM Translation File Already Processed Check

  • This file has already been processed for this kit. Rather then the --import-kit command, the --reimport-kit command needs to be called.

LRM Translation File Too Big Check

  • The file that is to be imported exceeds the maximum size supported by the Lingoport Resource Manager

LRM Translation ICU Argument Mismatch Check

LRM Translation ICU MessageFormat Check

LRM Translation Missed Translation Check

  • The text in the file to be imported is the same as the text in its corresponding base resource file. By default, in the project definition, this error check is set to false so that no error will occur if the text matches.

LRM Translation Missing File Check

  • The file that is to be imported is missing from the kit to import. This usually occurs when the files that are in the import zip file are renamed. The names of the file in the import zip file must be the base resource file names.

LRM Translation Missing Localized File Check

  • The localized file in the repo is missing (MISSING_LOCALIZED_FILE). This occurs during import for a changes-only prep if the localized file has been deleted. The localized file is required to exist in order to import a changes-only prep kit file.

LRM Translation Missing Key Check

  • The identifier/key is missing in the translated file.

LRM Translation Missing or Invalid Tag Check

  • LRM cannot process a translated file if the LRM Tag is corrupted (see top of file)

LRM Translation No Text Check

  • The text value is missing in the file that is to be imported.

LRM Translation Parameter Mismatch Check

  • The parameters of file that is to be imported do not match its corresponding base resource file parameters. The parameter regex pattern is defined in the project. Possible reasons:
    • Translator translated the parameter. For example, if the base resource file has {car} defined as a parameter but the translated French file has {voiture} then a parameter mismatch error will occur. The translator will need to fix this issue by not translating the parameter.
    • Issue with single ticks surrounding a parameter with curly brackets.
      • '{0}' - if there are single ticks surrounding the curly brackets then this means that the curly brackets do not represent a parameter. The single tick is used as a special character indicating that the curly bracket is a displayable character. So, if the base resource file has '{0}' and the imported file has "{0}" then a parameter mismatch will occur because '{0}' is not a parameter while "{0}" is a parameter. Parameter mismatch will also occur if the opposite occurs (base resource file has "{0}" and the imported file has '{0}')
    • Number of parameters must match. For example, if the base resource file has 2 {0} parameters then the file that is to be imported must have 2 {0} parameters.

LRM Translation Source Location Not Found Check

  • The source location cannot be found and this file cannot be imported to its source location. This occurs when the repository structure has changed after the kit was prepped and the location for the imported file no longer exists. In addition, if the translated file in the local repository no longer exists and the import file is for changes only, then this error will occur.

LRM Translation Unknown Error Check

  • There is an error in the import kit file and LRM cannot identify its source

LRM Translation Unknown File/Line Format Check

  • Unknown format for file/line or empty file (no key/values found) - The translated file/line could not be parsed

LRM Translation Non-Writable File Check

  • LRM cannot import the file to the source directory
Retrieved from "http://wiki.lingoport.com/index.php?title=LRM_Import_Checks&oldid=97270"