Lingohints

Lingohints are comment-based annotations for adding translation metadata like status, labels, and quality checks to localization files.

Overview

LingoHub enables the seamless import and export of segment keys, translations, and metadata such as comments, depending on the markup of the resource type.

While some resource types support advanced functionality—like indicating status, flags, or translation intent—many formats lack these extended data attributes. To resolve this limitation, Lingohints provide a unified and structured way to include metadata directly within a segment description. This metadata remains available across all resource types during import and export.

Supported Hints

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


Example: JSON Resource File

The following example shows a Lingohint embedded in a comment within 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>"
  }
}

When extracted, the metadata corresponds to the following structure:

{
    "status": "NEW",
    "qc": {
        "min": "0",
        "max": "20"
    },
    "labels": [
        "q3-2024"
    ],
    "not_translatable": false
}

Metadata settings

Status

The status property sets the status of a source or target segment. You can find all available status options in our Help Center.

Valid values include:

  • NEW.
  • PRE_TRANSLATED.
  • DRAFT.
  • TRANSLATED.
  • APPROVED.
{"status": "DRAFT"}

Labels

The labels property assigns one or more labels to a segment. Labels are applied at the segment level across all languages. LingoHub automatically creates any labels that do not already exist.

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

(Not) translatable

The not_translatable property marks a segment as non-translatable. LingoHub will not require or export translations for these segments.

{"not_translatable": true}

Lingochecks - quality check settings

The qc property defines min and max length constraints for the quality check process. These values affect how translations are validated.

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

Troubleshooting

Errors

The import process does not fail if a Lingohint contains syntax errors. However, LingoHub will not apply the associated metadata. You can review malformed or unprocessed hints in the import "Event Log".