LingoHub Help Center

Our experience, knowledge and lessons learned - all here just for you.

LingoChecks

LingoChecks represent one of the core tools of LingoHub. They are quality checks that keep your projects' translations within predetermined criteria and notify you in a simple and efficient way whenever there are any deviations from the defined rules.

Defining LingoChecks

There are two ways you can define LingoChecks :

1 - From the project's preferences

You can add your LingoChecks rules in the project's preferences accessible from the project's dashboard.

Simply click on the LingoChecks tab.

Img

you can apply rules on :

  • Text Segments: You can decide whether you allow the reviewers to approve a translation with failing LingoChecks. Keep in mind that once a text segment is approved, the failing LingoChecks won't show up anymore.

  • Term bases: The term bases have pre-defined translations, enabling this makes sure that the term bases are correctly translated.

  • Placeholders: Verify that all the placeholders in the source text are correctly rendered in the translated ones

  • HTML tags: Make sure that the HTML tags in the translated text conform with those of the source text.

You can also choose which of the HTML attributes you allow to be changed. It basically means that if your text segment contains an HTML tag, you will be allowed to translate the values of its attributes if you have defined them in the LingoChecks settings.

By default, the following are set as the translatable attributes :

src, alt, label, title, content, formaction, download, codebase, action, placeholder, href, abbr, lang, value

You can check if an HTML tag has translatable attributes by simply clicking on it in the editor.

Img

  • Line breaks: Check that the source text and the translated text have the same number of linebreaks.

All the LingoChecks, except the last one (line breaks) are enabled by default.

2 - From the editor's side panel

You can define length constraints for a text segment from the Settings option in the editor's side panel. These constraints are going to be taken into account by the LingoChecks when validating the text segment.

Img

When setting the length constraints, you can define :

  • a fixed limit : i.e - min. 45, max. 128, which allows a minimum of 45 characters and a maximum of 128 characters.

  • an offset limit : i.e - min. -15 max. +20, which allows up to 15 characters less and 20 characters more than the original text.

3 - In the Resource File

In addition to setting LingoChecks in the Lingohub application, you can also set them directly in your resource files in the form of comments.

To distinguish them from the basic comments (that are used as the text segment description), the LingoCheck comment lines start with an lh-check keyword, followed by a curly braces block containing the checks separated by a comma.

The following example defines LingoChecks for a text segment in a grails resource file:

# lh-check { min: -4, max: 35 }
welcome = Hooray, you're here! The day just got better - enjoy the following tips!

LingoChecks in action

Once your LingoChecks are set, they alert you whenever one of the rules you have defined is not respected. The failed LingoChecks are displayed in two locations :

  • In the Dashboard: LingoChecks alert symbols show up in the project progress bar found on the Project Dashboard's overview.

Clicking on them will redirect you to the editor and filter all the text segments presenting failing checks.

Img

  • In the Editor: Failing LingoChecks are also displayed in the editor with a description of the cause of the failure.

Img

You've made it through the LingoChecks guide. If you have any questions, please get in touch at [email protected].

Ready to optimize your translation workflow?

Try LingoHub PRO for free