checks.rst

Checks and fixups

Custom automatic fixups

You can also implement your own automatic fixup in addition to the standard ones and include them in AUTOFIX_LIST.

The automatic fixes are powerful, but can also cause damage; be careful when writing one.

For example, the following automatic fixup would replace every occurrence of the string foo in a translation with bar:

../../weblate/examples/fix_foo.py

To install custom checks, provide a fully-qualified path to the Python class in the AUTOFIX_LIST, see custom-check-modules.

Customizing behavior using flags

You can fine-tune the behavior of Weblate (mostly checks) for each source string (in source strings review, see additional) or in the component (component-check_flags). Some file formats also allow to specify flags directly in the format (see formats).

The flags are comma-separated, the parameters are separated with colon. You can use quotes to include whitespace or special chars in the string. For example:

placeholders:"special:value":"other value", regex:.*

Here is a list of flags currently accepted:

rst-text

Treat a text as an reStructuredText document, affects check-same.

md-text

Treat text as a Markdown document.

dos-eol

Uses DOS end-of-line markers instead of Unix ones (\r\n instead of \n).

url

The string should consist of only a URL.

safe-html

The string should be HTML safe, see check-safe-html.

read-only

The string is read-only and should not be edited in Weblate, see read-only-strings.

priority:N

Priority of the string. Higher priority strings are presented first for translation. The default priority is 100, the higher priority a string has, the earlier it is offered for translation.

max-length:N

Limit the maximal length for a string to N characters, see check-max-length.

xml-text

Treat text as XML document, affects check-xml-invalid and check-xml-tags.

font-family:NAME

Define font-family for rendering checks, see fonts.

font-weight:WEIGHT

Define font-weight for rendering checks, see fonts.

font-size:SIZE

Define font-size for rendering checks, see fonts.

font-spacing:SPACING

Define letter spacing for rendering checks, see fonts.

placeholders:NAME:NAME2:...

Placeholder strings expected in translation, see check-placeholders.

replacements:FROM:TO:FROM2:TO2...

Replacements to perform when checking resulting text parameters (for example in check-max-size or check-max-length). The typical use case for this is to expand placeables to ensure that the text fits even with long values, for example: replacements:%s:"John Doe".

variants:SOURCE

Mark this string as a variant of string with matching source. See variants.

regex:REGEX

Regular expression to match translation, see check-regex.

forbidden

Indicates forbidden translation in a glossary, see glossary-forbidden.

python-format, c-format, object-pascal-format, php-format, python-brace-format, javascript-format, c-sharp-format, java-format, java-messageformat, lua-format, auto-java-messageformat, qt-format, qt-plural-format, ruby-format, scheme-format, vue-format

Treats all strings like format strings, affects check-python-format, check-c-format, check-object-pascal-format, check-php-format, check-qt-format, check-qt-plural-format, check-ruby-format, check-vue-format, check-python-brace-format, check-javascript-format, check-c-sharp-format, check-java-format, check-java-messageformat, check-lua-format, check-scheme-format, check-same.

strict-same

Make "Unchanged translation" avoid using built-in words blacklist, see check-same.

check-glossary

Enable the "Does not follow glossary" quality check.

ignore-bbcode

Skip the "BBcode markup" quality check.

ignore-duplicate

Skip the "Consecutive duplicated words" quality check.

ignore-check-glossary

Skip the "Does not follow glossary" quality check.

ignore-double-space

Skip the "Double space" quality check.

ignore-angularjs-format

Skip the "AngularJS interpolation string" quality check.

ignore-c-format

Skip the "C format" quality check.

ignore-c-sharp-format

Skip the "C# format" quality check.

ignore-es-format

Skip the "ECMAScript template literals" quality check.

ignore-i18next-interpolation

Skip the "i18next interpolation" quality check.

ignore-java-format

Skip the "Java format" quality check.

ignore-java-messageformat

Skip the "Java MessageFormat" quality check.

ignore-javascript-format

Skip the "JavaScript format" quality check.

ignore-lua-format

Skip the "Lua format" quality check.

ignore-object-pascal-format

Skip the "Object Pascal format" quality check.

ignore-percent-placeholders

Skip the "Percent placeholders" quality check.

ignore-perl-format

Skip the "Perl format" quality check.

ignore-php-format

Skip the "PHP format" quality check.

ignore-python-brace-format

Skip the "Python brace format" quality check.

ignore-python-format

Skip the "Python format" quality check.

ignore-qt-format

Skip the "Qt format" quality check.

ignore-qt-plural-format

Skip the "Qt plural format" quality check.

ignore-ruby-format

Skip the "Ruby format" quality check.

ignore-vue-format

Skip the "Vue I18n formatting" quality check.

ignore-translated

Skip the "Has been translated" quality check.

ignore-inconsistent

Skip the "Inconsistent" quality check.

ignore-kashida

Skip the "Kashida letter used" quality check.

ignore-md-link

Skip the "Markdown links" quality check.

ignore-md-reflink

Skip the "Markdown references" quality check.

ignore-md-syntax

Skip the "Markdown syntax" quality check.

ignore-max-length

Skip the "Maximum length of translation" quality check.

ignore-max-size

Skip the "Maximum size of translation" quality check.

ignore-escaped-newline

Skip the "Mismatched n" quality check.

ignore-end-colon

Skip the "Mismatched colon" quality check.

ignore-end-ellipsis

Skip the "Mismatched ellipsis" quality check.

ignore-end-exclamation

Skip the "Mismatched exclamation mark" quality check.

ignore-end-stop

Skip the "Mismatched full stop" quality check.

ignore-end-question

Skip the "Mismatched question mark" quality check.

ignore-end-semicolon

Skip the "Mismatched semicolon" quality check.

ignore-newline-count

Skip the "Mismatching line breaks" quality check.

ignore-plurals

Skip the "Missing plurals" quality check.

ignore-placeholders

Skip the "Placeholders" quality check.

ignore-punctuation-spacing

Skip the "Punctuation spacing" quality check.

ignore-regex

Skip the "Regular expression" quality check.

ignore-same-plurals

Skip the "Same plurals" quality check.

ignore-begin-newline

Skip the "Starting newline" quality check.

ignore-begin-space

Skip the "Starting spaces" quality check.

ignore-end-newline

Skip the "Trailing newline" quality check.

ignore-end-space

Skip the "Trailing space" quality check.

ignore-same

Skip the "Unchanged translation" quality check.

ignore-safe-html

Skip the "Unsafe HTML" quality check.

ignore-url

Skip the "URL" quality check.

ignore-xml-tags

Skip the "XML markup" quality check.

ignore-xml-invalid

Skip the "XML syntax" quality check.

ignore-zero-width-space

Skip the "Zero-width space" quality check.

ignore-ellipsis

Skip the "Ellipsis" quality check.

ignore-long-untranslated

Skip the "Long untranslated" quality check.

ignore-multiple-failures

Skip the "Multiple failing checks" quality check.

ignore-unnamed-format

Skip the "Multiple unnamed variables" quality check.

ignore-optional-plural

Skip the "Unpluralised" quality check.

Note

Generally the rule is named ignore-* for any check, using its identifier, so you can use this even for your custom checks.

These flags are understood both in component settings, per source string settings and in the translation file itself (for example in GNU gettext).

Enforcing checks

3.11

You can configure a list of checks which can not be ignored by setting component-enforced_checks in component. Each listed check can not be ignored in the user interface and any string failing this check is marked as Needs editing (see states).

Managing fonts

3.7

Hint

Fonts uploaded into Weblate are used purely for purposes of the check-max-size check, they do not have an effect in Weblate user interface.

The check-max-size check used to calculate dimensions of the rendered text needs font to be loaded into Weblate and selected using a translation flag (see custom-checks).

Weblate font management tool in Fonts under the Manage menu of your translation project provides interface to upload and manage fonts. TrueType or OpenType fonts can be uploaded, set up font-groups and use those in the check.

The font-groups allow you to define different fonts for different languages, which is typically needed for non-latin languages:

The font-groups are identified by name, which can not contain whitespace or special characters, so that it can be easily used in the check definition:

Font-family and style is automatically recognized after uploading them:

You can have a number of fonts loaded into Weblate:

To use the fonts for checking the string length, pass it the appropriate flags (see custom-checks). You will probably need the following ones:

max-size:500

Defines maximal width.

font-family:ubuntu

Defines font group to use by specifying its identifier.

font-size:22

Defines font size.

Writing own checks

A wide range of quality checks are built-in, (see checks), though they might not cover everything you want to check. The list of performed checks can be adjusted using CHECK_LIST, and you can also add custom checks.

1. Subclass the weblate.checks.Check
2. Set a few attributes.
3. Implement either the check (if you want to deal with plurals in your code) or the check_single method (which does it for you).

Some examples:

To install custom checks, provide a fully-qualified path to the Python class in the CHECK_LIST, see custom-check-modules.

Checking translation text does not contain "foo"

This is a pretty simple check which just checks whether the translation is missing the string "foo".

../../weblate/examples/check_foo.py

Checking that Czech translation text plurals differ

Check using language info to verify the two plural forms in Czech language are not same.

../../weblate/examples/check_czech.py