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.

dos-eol

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

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.

icu-flags:FLAGS

Define flags for customizing the behavior of the check-icu-message-format quality check.

icu-tag-prefix:PREFIX

Set a required prefix for XML tags for the check-icu-message-format quality check.

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.

strict-same

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

check-glossary

Enable the check-check-glossary quality check.

angularjs-format

Enable the check-angularjs-format quality check.

c-format

Enable the check-c-format quality check.

c-sharp-format

Enable the check-c-sharp-format quality check.

es-format

Enable the check-es-format quality check.

i18next-interpolation

Enable the check-i18next-interpolation quality check.

icu-message-format

Enable the check-icu-message-format quality check.

java-format

Enable the check-java-format quality check.

java-messageformat

Enable the check-java-messageformat quality check.

javascript-format

Enable the check-javascript-format quality check.

lua-format

Enable the check-lua-format quality check.

object-pascal-format

Enable the check-object-pascal-format quality check.

percent-placeholders

Enable the check-percent-placeholders quality check.

perl-format

Enable the check-perl-format quality check.

php-format

Enable the check-php-format quality check.

python-brace-format

Enable the check-python-brace-format quality check.

python-format

Enable the check-python-format quality check.

qt-format

Enable the check-qt-format quality check.

qt-plural-format

Enable the check-qt-plural-format quality check.

ruby-format

Enable the check-ruby-format quality check.

scheme-format

Enable the check-scheme-format quality check.

vue-format

Enable the check-vue-format quality check.

md-text

Treat text as a Markdown document. Enable check-md-link, check-md-reflink, and check-md-syntax quality checks.

safe-html

Enable the check-safe-html quality check.

url

The string should consist of only a URL. Enable the check-url quality check.

ignore-bbcode

Skip the check-bbcode quality check.

ignore-duplicate

Skip the check-duplicate quality check.

ignore-check-glossary

Skip the check-check-glossary quality check.

ignore-double-space

Skip the check-double-space quality check.

ignore-angularjs-format

Skip the check-angularjs-format quality check.

ignore-c-format

Skip the check-c-format quality check.

ignore-c-sharp-format

Skip the check-c-sharp-format quality check.

ignore-es-format

Skip the check-es-format quality check.

ignore-i18next-interpolation

Skip the check-i18next-interpolation quality check.

ignore-icu-message-format

Skip the check-icu-message-format quality check.

ignore-java-format

Skip the check-java-format quality check.

ignore-java-messageformat

Skip the check-java-messageformat quality check.

ignore-javascript-format

Skip the check-javascript-format quality check.

ignore-lua-format

Skip the check-lua-format quality check.

ignore-object-pascal-format

Skip the check-object-pascal-format quality check.

ignore-percent-placeholders

Skip the check-percent-placeholders quality check.

ignore-perl-format

Skip the check-perl-format quality check.

ignore-php-format

Skip the check-php-format quality check.

ignore-python-brace-format

Skip the check-python-brace-format quality check.

ignore-python-format

Skip the check-python-format quality check.

ignore-qt-format

Skip the check-qt-format quality check.

ignore-qt-plural-format

Skip the check-qt-plural-format quality check.

ignore-ruby-format

Skip the check-ruby-format quality check.

ignore-scheme-format

Skip the check-scheme-format quality check.

ignore-vue-format

Skip the check-vue-format quality check.

ignore-translated

Skip the check-translated quality check.

ignore-inconsistent

Skip the check-inconsistent quality check.

ignore-kashida

Skip the check-kashida quality check.

ignore-md-link

Skip the check-md-link quality check.

ignore-md-reflink

Skip the check-md-reflink quality check.

ignore-md-syntax

Skip the check-md-syntax quality check.

ignore-max-length

Skip the check-max-length quality check.

ignore-max-size

Skip the check-max-size quality check.

ignore-escaped-newline

Skip the check-escaped-newline quality check.

ignore-end-colon

Skip the check-end-colon quality check.

ignore-end-ellipsis

Skip the check-end-ellipsis quality check.

ignore-end-exclamation

Skip the check-end-exclamation quality check.

ignore-end-stop

Skip the check-end-stop quality check.

ignore-end-question

Skip the check-end-question quality check.

ignore-end-semicolon

Skip the check-end-semicolon quality check.

ignore-newline-count

Skip the check-newline-count quality check.

ignore-plurals

Skip the check-plurals quality check.

ignore-placeholders

Skip the check-placeholders quality check.

ignore-punctuation-spacing

Skip the check-punctuation-spacing quality check.

ignore-regex

Skip the check-regex quality check.

ignore-same-plurals

Skip the check-same-plurals quality check.

ignore-begin-newline

Skip the check-begin-newline quality check.

ignore-begin-space

Skip the check-begin-space quality check.

ignore-end-newline

Skip the check-end-newline quality check.

ignore-end-space

Skip the check-end-space quality check.

ignore-same

Skip the check-same quality check.

ignore-safe-html

Skip the check-safe-html quality check.

ignore-url

Skip the check-url quality check.

ignore-xml-tags

Skip the check-xml-tags quality check.

ignore-xml-invalid

Skip the check-xml-invalid quality check.

ignore-zero-width-space

Skip the check-zero-width-space quality check.

ignore-ellipsis

Skip the check-ellipsis quality check.

ignore-icu-message-format-syntax

Skip the check-icu-message-format-syntax quality check.

ignore-long-untranslated

Skip the check-long-untranslated quality check.

ignore-multiple-failures

Skip the check-multiple-failures quality check.

ignore-unnamed-format

Skip the check-unnamed-format quality check.

ignore-optional-plural

Skip the check-optional-plural 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 in pixels.

font-family:ubuntu

Defines font group to use by specifying its identifier.

font-size:22

Defines font size in pixels.

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