Page History

...

Usage overview

In short words

1. Define relevant system configuration settings (if not already done)
2. Define
   
   1. task-template.xml
   2. pixel-mapping.xlsx (only if pixel-length check)
   3. Optionally define define relevant parameters directly in xliff 1.2
3. Use ZIP import package and include task-template.xml and if needed pixel-mapping.xlsx

...

For length restrictions to be used in any case a task-template has to be provided for a task and length restrictions have to be activated in it for the task.

For pixel-based length restrictions to work some default settings also have to be provided in the Zf_configuration database table (system configuration; see below). Also the pixel-width definitions have to be provided as an Excel file (pixel-mapping.xml ) that is fed alongside the task-template to the import zip for the task.

...

• size-unit
  • If character-length or pixel-length based length check
  • Possible values:
    • pixel
    • char
• minLength
  • Minimum length in number of pixel / characters
  • Refers to the length of a complete trans-unit of an xliff file, even if it spans multiple segments.
  • This means for min-length set in a task template for let's say a word document, that the length restriction refers to a whole paragraph.
  • If maxNumberOfLines is set, minLength is not supported so far (ask translate5's development team, if you need it)
• maxLength
  • Maximum length in number of pixel / characters
  • Refers to the length of a complete trans-unit of an xliff file, even if it spans multiple segments.
  • This means for maxLength set in a task template for let's say a word document, that the length restriction refers to a whole paragraph.
  • If maxNumberOfLines is set, maxLength refers to the length of each line, otherwise maxLength refers to the trans-unit.
    
    • With maxNumberOfLines set, trans-units must not span multiple segments!
• translate5:maxNumberOfLines
  • How many lines a segment (not a trans-unit) should maximally have
  • If maxNumberOfLines is set,
    • maxLength refers to the length of each line, otherwise maxLength refers to the trans-unit
    • minLength is not supported so far (ask translate5's development team, if you need it)

    • Trans-units must not span multiple segments!
      If you need maxNumberOfLines to span multiple segments, contact translate5s development team

• For pixel-based length check:
  • For each character for a certain font and a certain font-size the pixel-width
    
    • Definitions in pixel-mapping.xlsx
  • Font-size and used font of current task
    • Definitions in task-template.xml
    • Would be possible to overwrite them in xliff 1.2, yet this is not yet implemented (ask translate5s development team, if you need it)

...

The <lengthRestriction></lengthRestriction> tag has to be present in the task template and the task template has to be provided to the imported zip package.

Please see Task Templates for how to use that and ZIP import package format for how to include the task-template.xml into the import zip package.

...

(overwrite corresponding definitions in task template)

Please see "Definable parameters" for explanation.

Example:

...