Lingohints

Overview

Lingohub enables seamless import and export of segment keys, translations, and additional details like comments, supported by the resource type’s markup.

For some resource types, markup allows more advanced functionality, such as indicating status, flags, or whether a segment is intended for translation. However, only a limited number of formats support these extended data attributes.

To overcome this limitation, Lingohint provides a unified and structured way to include such metadata directly within a segment’s description, making it available across all resource types during import and export.

What Hints are supported

You can use Lingohint to define the following metadata for a segment:

• Status
• Labels
• Quality check settings
• Whether the segment is translatable

Example: JSON Resource File

Here’s how a Lingohint might be embedded into a comment in a JSON resource file:

{
  "user": {
    "salutation": "Hallo {{name}}",
    "_salutation.comment": "Is used to say Hello <lh>{\"status\": \"NEW\",\"qc\": {\"min\": \"0\",\"max\": \"20\"},\"labels\": [\"q3-2024\"],\"not_translatable\": false}</lh>"
  }
}

... or extracted:

Different Comment Markup settings

status

Sets the status of a segment. The status applies to the source or target segment.
All available status options can be found here.

As of 2025-03-10, valid values include:
• NEW • PRE_TRANSLATED • DRAFT • TRANSLATED • APPROVED

The status is set on the source or target segment to which the segment text belongs.

  {"status": "DRAFT"}

labels

Assigns one or more labels to a segment. Labels are set at the segment level and apply to all languages. If a label doesn’t exist yet, it will be created automatically.

{"labels": ["invalid", "duplicate"]}

(not) translatable

Marks a segment as not translatable. This means no translations should be provided in other languages.

{"not_translatable": true}

Lingochecks - quality check settings

Allows the provision of the min and/or max settings for the length quality check

Sets min and/or max length constraints for the length quality check. These values are applied to the segment and affect how translations are validated.

"qc": {
  "min": "0",
  "max": "3"
}

Troubleshooting

Errors

The import process will not fail if a Lingohint is syntactically invalid. However, the associated metadata will not be applied. You can review any unprocessed or malformed Lingohints in the import's "Event Log.".