...

Yet if used in such a generalist way, the defined length for each segment has to be the same for the complete task and has to be defined in the task templateconfiguration.

If you need different counts per segment within the same task, you need to define them directly in the xliff file before importing it into translate5. Ask translate5s development team, if you need conversion of other file formats to xliff that support segment-based length restriction definitions.

...

In some cases instead of counting pixel-length it is important to count the number of used characters in a segment or a line. translate5 supports this also.

Support of

...

minWidth and maxWidth

With translate5 you can set a min-width minWidth and/or a max-width maxWidth for a segment.

Support for line-count and line-length

A display text can have multiple lines. translate5 supports to check, that a max number of lines is not exceeded and a max number of pixel or characters per line is not exceeded. Minimum count of characters or pixel is only supported so far, if no max line count is defined.

To support users editing segments for which a max. line count is defined, linebreaks will be inserted automatically at sensful positions when a user opens a segment being to long for editing. These "linebreak suggestions" must be accepted by the user by simply saving the segment.

Usage and configuration

Usage overview

In short words

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

Example import package

More in detail

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

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.

All length restrictions can also be provided directly in xliff 1.2 format on trans-unit level. If they are present, they overwrite definitions made in the task templateconfiguration.

To use other custom formats that already contain all length restriction definitions on segment level please ask the translate5 development team to develop a custom import file filter.

...

Length check parameters definable in the task-template configuration(see the table bellow) and overwriteable in xliff 1.2

• size-unit
  • If character-length or pixel-length based length check
  • Possible values:
    • pixel
    • char
• minWidthminLength
  • 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 minWidth set in a task template system configuration 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)set, minWidth refers to the length of each line, otherwise minWidth refers to the trans-unit.
    
    • With maxNumberOfLines set, trans-units must not span multiple segments!
• maxWidthmaxLength
  • 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 maxWidth set in a task template system configuration for let's say a word document, that the length restriction refers to a whole paragraph.
  • If maxNumberOfLines is set, maxLength maxWidth refers to the length of each line, otherwise maxLength maxWidth 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 maxWidth refers to the length of each line, otherwise maxLength maxWidth refers to the trans-unit
    • minLength is not supported so far (ask translate5's development team, if you need it)minWidth refers to the length of each line, otherwise maxWidth refers to the trans-unit

    • 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)

Task template definitions

For length restrictions to be activated, a task template has to be used.

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.

...

Special settings for pixel length restriction

...

• in translate5s system configuration 
• in the pixel-mapping.xlsx

System configuration in Zf_configuration for pixel length restriction

...

• font: Contains the font-name as used in the task-templatedefine in runtimeOptions.lengthRestriction.pixelmapping.font
• fontSize: Contains the font-size as used in the task-templatedefined in runtimeOptions.lengthRestriction.pixelmapping.fontSize
• unicodeChar: Contains the value unicode code point value for the character, for which you want to define a pixel width. An easy way to find the code point is to use the site https://onlineutf8tools.com/convert-utf8-to-code-points and to enter the char you want to know the code point for in the left field.
• pixelWidth: The pixel width you want to define for the listed character, with the listed font in the listed font-size
• Character: This is just a reference column to be easily able to know, what the current row defines. It is not used during the length check.

Example pixel-mapping.xlsx file

View file
name pixel-mapping.xlsx height 250

Definitions in xliff 1.2

(overwrite corresponding definitions in

...

the configuration)

Please see "Definable parameters" for explanation.

Example:

...