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:

from weblate.trans.autofixes.base import AutoFix


class ReplaceFooWithBar(AutoFix):
    """Replace foo with bar."""

    # Might be localized using gettext_lazy
    name = "Foobar"

    def fix_single_target(self, target, source, unit):
        if "foo" in target:
            return target.replace("foo", "bar"), True
        return target, False

To install custom checks, provide a fully-qualified path to the Python class in the AUTOFIX_LIST, see Custom quality checks, add-ons, automatic suggestions and auto-fixes.

Customizing behavior using flags¶

You can fine-tune Weblate’s behavior by using flags. The flags provide visual feedback to the translators and help them to improve their translation. The flags are merged from following sources:

Source string additional flags:
- Additional info on source strings describes manual editing.
- Masseredigering can be used to apply flags in batch.
- Masseredigering add-on can apply flags automatically.
Per-string flags extracted from the file format, see Localization file formats.
Translation flags (currently only read-only flag for bilingual source string or when monolingual template editing is turned off).
File-format specific flags.
Komponentoppsett (Oversettelsflagg).
Project configuration (Oversettelsflagg).

The flags are comma-separated; if they have parameters, they are separated with colon. You can use quotes to include whitespaces or special characters in the string. For example:

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

Both single and double quotes are accepted, special characters are being escaped using backslash:

placeholders:"quoted \"string\"":'single \'quoted\''

placeholders:r"^#*"

To verify that translators do not change the heading of a Markdown document. A failing check will be triggered if the string ### Index is translated as # Indice.

placeholders:r"\]\([^h].*?\)"

To ensure that internal links are not being translated (i.e. [test](../checks) does not become [test](../chequeos).

The flags defined on a higher level can be discarded using the discard:NAME syntax. For example, if a component is configured to safe-html, you can add discard:safe-html to the string flags to skip it for this particular string.

Here is a list of flags currently accepted:

read-only: The string is read-only and should not be edited in Weblate, see Skrivebeskyttede strenger.
terminology: Used in Ordliste. Copies the string into all glossary languages so it can be used consistently in all translations. Also useful in combination with read-only, for example in product names.
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 Maksimal lengde på oversettelse.
xml-text: Treat text as XML document, affects XML-syntaks and XML-oppmerking.
font-family:NAME: Define font-family for rendering checks, see Håndtering av skrifter.
font-weight:WEIGHT: Define font-weight for rendering checks, see Håndtering av skrifter.
font-size:SIZE: Define font-size for rendering checks, see Håndtering av skrifter.
font-spacing:SPACING: Define letter spacing for rendering checks, see Håndtering av skrifter.
icu-flags:FLAGS: Define flags for customizing the behavior of the ICU MessageFormat quality check.
icu-tag-prefix:PREFIX: Set a required prefix for XML tags for the ICU MessageFormat quality check.
placeholders:NAME:NAME2:...: Placeholder strings expected in translation, see Plassholdere.
replacements:FROM:TO:FROM2:TO2...: Replacements to perform when checking resulting text parameters (for example in Maksimal størrelse på oversettelse or Maksimal lengde på oversettelse). 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 String variants.
regex:REGEX: Regular expression to match translation, see Regulært uttrykk.
discard:NAME: Discards flag defined on a higher level.
forbidden: Indicates forbidden translation in a glossary, see Forbidden translations.
strict-same: Make the Uendret oversettelse avoid using the built-in words exceptions.
strict-format: Make format checks enforce using format even for plural forms with a single value, see Formatted strings.
case-insensitive: Adjust checks behavior to be case-insensitive. Currently affects only Plassholdere quality check.

bbcode-text: Treat a text as an Bulletin Board Code (BBCode) document, affects Uendret oversettelse. Enables the BB-kode-oppmerking quality check.
check-glossary: Enables the Følger ikke ordlisten quality check.
fluent-parts: Enables the Fluent parts quality check.
fluent-references: Enables the Fluent references quality check.
fluent-target-inner-html: Enables the Fluent translation inner HTML quality check.
fluent-target-syntax: Enables the Fluent translation syntax quality check.
angularjs-format: Enables the AngularJS interpoleringsstreng quality check.
automattic-components-format: Enables the Automattic components formatting quality check.
c-format: Enables the C-format quality check.
c-sharp-format: Enables the C#-format quality check.
csharp-format: Enables the C#-format quality check.
es-format: Enables the ECMASkript-mal litteraler quality check.
i18next-interpolation: Enables the i18neste-interpolasjon quality check.
icu-message-format: Enables the ICU MessageFormat and ICU MessageFormat syntax quality checks.
java-printf-format: Enables the Java-format quality check.
java-format: Enables the Java-meldingsformat quality check.
auto-java-messageformat: Treat a text as conditional Java MessageFormat, enabling Java-meldingsformat only when the source contains Java MessageFormat placeholders. Enables the Java-meldingsformat quality check.
javascript-format: Enables the JavaScript-format quality check.
laravel-format: Enables the Laravel format quality check.
lua-format: Enables the Lua-format quality check.
object-pascal-format: Enables the Object Pascal format quality check.
objc-format: Enables the Objective-C format quality check.
percent-placeholders: Enables the Prosentplassholdere quality check.
perl-brace-format: Enables the Perl brace format quality check.
perl-format: Enables the Perl-format quality check.
php-format: Enables the PHP-format quality check.
python-brace-format: Enables the Python-klammeformat quality check.
python-format: Enables the Python-format quality check.
qt-format: Enables the Qt-format quality check.
qt-plural-format: Enables the Qt-flertallsform quality check.
ruby-format: Enables the Ruby-format quality check.
scheme-format: Enables the Scheme-filformat quality check.
vue-format: Enables the Vue I18n-formatering quality check.
rst-text: Treat a text as an reStructuredText document, affects Uendret oversettelse. Enables the Inconsistent reStructuredText and reStructuredText syntax error quality checks.
md-text: Treat a text as a Markdown document, and provide Markdown syntax highlighting on the translation text area. Enables the Markdown-lenker, Markdown-referanser and Markdown-syntaks quality checks.
max-length: Enables the Maksimal lengde på oversettelse quality check.
max-size: Enables the Maksimal størrelse på oversettelse quality check.
placeholders: Enables the Plassholdere quality check.
regex: Enables the Regulært uttrykk quality check.
safe-html: Enables the Utrygg HTML quality check.
auto-safe-html: Treat a text as conditional HTML, enabling Utrygg HTML only for plain text or source strings that contain standard HTML markup or valid custom elements. This is useful for extended Markdown variants such as MDX, where angle-bracket syntax may not be HTML. Enables the Utrygg HTML quality check.
url: The string should consist of only a URL. Enables the Nettadresse quality check.
fluent-source-inner-html: Enables the Fluent source inner HTML quality check.
fluent-source-syntax: Enables the Fluent source syntax quality check.

ignore-all-checks: Ignore all quality checks.

ignore-bbcode: Skip the BB-kode-oppmerking quality check.
ignore-xml-chars-around-tags: Skip the Chars around XML tags quality check.
ignore-duplicate: Skip the Påfølgende gjentatte ord quality check.
ignore-check-glossary: Skip the Følger ikke ordlisten quality check.
ignore-double-space: Skip the Dobbelt mellomrom quality check.
ignore-fluent-parts: Skip the Fluent parts quality check.
ignore-fluent-references: Skip the Fluent references quality check.
ignore-fluent-target-inner-html: Skip the Fluent translation inner HTML quality check.
ignore-fluent-target-syntax: Skip the Fluent translation syntax quality check.
ignore-angularjs-format: Skip the AngularJS interpoleringsstreng quality check.
ignore-automattic-components-format: Skip the Automattic components formatting 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 ECMASkript-mal litteraler quality check.
ignore-i18next-interpolation: Skip the i18neste-interpolasjon quality check.
ignore-icu-message-format: Skip the ICU MessageFormat quality check.
ignore-java-printf-format: Skip the Java-format quality check.
ignore-java-format: Skip the Java-meldingsformat quality check.
ignore-javascript-format: Skip the JavaScript-format quality check.
ignore-laravel-format: Skip the Laravel format quality check.
ignore-lua-format: Skip the Lua-format quality check.
ignore-object-pascal-format: Skip the Object Pascal format quality check.
ignore-objc-format: Skip the Objective-C format quality check.
ignore-percent-placeholders: Skip the Prosentplassholdere quality check.
ignore-perl-brace-format: Skip the Perl brace format 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-klammeformat 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-flertallsform quality check.
ignore-ruby-format: Skip the Ruby-format quality check.
ignore-scheme-format: Skip the Scheme-filformat quality check.
ignore-vue-format: Skip the Vue I18n-formatering quality check.
ignore-translated: Skip the Har blitt oversatt quality check.
ignore-inconsistent: Skip the Inkonsekvent quality check.
ignore-rst-references: Skip the Inconsistent reStructuredText quality check.
ignore-kashida: Skip the Kashida-bokstav i bruk quality check.
ignore-md-link: Skip the Markdown-lenker quality check.
ignore-md-reflink: Skip the Markdown-referanser quality check.
ignore-md-syntax: Skip the Markdown-syntaks quality check.
ignore-max-length: Skip the Maksimal lengde på oversettelse quality check.
ignore-max-size: Skip the Maksimal størrelse på oversettelse quality check.
ignore-escaped-newline: Skip the Mismatched \n quality check.
ignore-end-colon: Skip the Manglende samsvar kolon quality check.
ignore-end-ellipsis: Skip the Manglende samsvar utelatelsestegn quality check.
ignore-end-exclamation: Skip the Mangler samsvarende utropstegn quality check.
ignore-end-stop: Skip the Manglende samsvar avsluttende punktum quality check.
ignore-end-interrobang: Skip the Mismatched interrobang quality check.
ignore-end-question: Skip the Manglende spørsmålstegn quality check.
ignore-end-semicolon: Skip the Manglende samsvar semikolon quality check.
ignore-newline-count: Skip the Ikke samsvarende linjeskift quality check.
ignore-plurals: Skip the Manglende flertall quality check.
ignore-multiple-capital: Skip the Multiple capitals quality check.
ignore-kabyle-characters: Skip the Non‑standard characters in Kabyle quality check.
ignore-placeholders: Skip the Plassholdere quality check.
ignore-prohibited-initial-character: Skip the Prohibited initial character quality check.
ignore-punctuation-spacing: Skip the Tegnsettingsavstand quality check.
ignore-regex: Skip the Regulært uttrykk quality check.
ignore-rst-syntax: Skip the reStructuredText syntax error quality check.
ignore-reused: Skip the Reused translation quality check.
ignore-same-plurals: Skip the Samme flertallsform quality check.
ignore-begin-newline: Skip the Starter linjeskift quality check.
ignore-begin-space: Skip the Starter mellomrom quality check.
ignore-end-newline: Skip the Etterfølgende linjeskift quality check.
ignore-end-space: Skip the Etterfølgende mellomrom quality check.
ignore-same: Skip the Uendret oversettelse quality check.
ignore-safe-html: Skip the Utrygg HTML quality check.
ignore-url: Skip the Nettadresse quality check.
ignore-xml-tags: Skip the XML-oppmerking quality check.
ignore-xml-invalid: Skip the XML-syntaks quality check.
ignore-zero-width-space: Skip the Rom for Zero-bredde quality check.
ignore-ellipsis: Skip the Utelatelsestegn quality check.
ignore-fluent-source-inner-html: Skip the Fluent source inner HTML quality check.
ignore-fluent-source-syntax: Skip the Fluent source syntax quality check.
ignore-icu-message-format: Skip the ICU MessageFormat syntax quality check.
ignore-long-untranslated: Skip the Lenge uten oversettelse quality check.
ignore-multiple-failures: Skip the Flere kontroller som feiler quality check.
ignore-unnamed-format: Skip the Flere navnløse variabler quality check.
ignore-optional-plural: Skip the Flertall mangler quality check.

Merknad

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 Komponentoppsett settings, per source string settings and in the translation file itself (for example in GNU gettext).

Location-based flags¶

Some flags are added to strings by default, based on their locations. This means that certain checks will be automatically enabled depending on where the string is used.

rst-text: This flag is automatically added to strings in reStructuredText files, if location extension is .rst.
md-text: This flag is automatically added to strings in Markdown and MDX files, if location extension is .md, .markdown, or .mdx.

Enforcing checks¶

The enforced checks cannot be dismissed and mark string as Needs editing (see Translation states). This prevents translators from hiding such checks.

Hint

Turning on check enforcing doesn’t enable it automatically. Some checks have to be turned on by adding the corresponding flag to the string or component flags.

This is best used with checks that can cause serious issues when used like checks for Formatted strings. Using for style checks like Uendret oversettelse is not recommended because dismissal is sometimes a reasonable approach in these.

The Translation quality filter can then be used to exclude strings needing editing from being committed to the version control.

Se også

Håndtering av skrifter¶

Hint

Fonts uploaded into Weblate are used purely for purposes of the Maksimal størrelse på oversettelse check, they do not have an effect in Weblate user interface.

The Maksimal størrelse på oversettelse check used to calculate dimensions of the rendered text needs font to be loaded into Weblate and selected using a translation flag (see Customizing behavior using flags).

Weblate font management tool in Fonts under the Operations 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 are automatically recognized after uploading them:

Du kan ha et antall skrifter innlastet i Weblate:

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

max-size:500 / max-size:300:5: Defines maximal width in pixels and, optionally, the maximum number of lines (word wrapping is applied).
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 Quality 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.

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

Noen eksempler:

To install custom checks, provide a fully-qualified path to the Python class in the CHECK_LIST, see Custom quality checks, add-ons, automatic suggestions and auto-fixes.

Checking translation text does not contain «foo»¶

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

"""Simple quality check example."""

from django.utils.translation import gettext_lazy

from weblate.checks.base import TargetCheck


class FooCheck(TargetCheck):
    # Used as identifier for check, should be unique
    # Has to be shorter than 50 characters
    check_id = "foo"

    # Short name used to display failing check
    # Might be localized using gettext_lazy
    name = "Foo check"

    # Description for failing check
    description = gettext_lazy("Your translation is foo")

    # Real check code
    def check_single(self, source, target, unit):
        return "foo" in target

Checking that Czech translation text plurals differ¶

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

"""Quality check example for Czech plurals."""

from django.utils.translation import gettext_lazy

from weblate.checks.base import TargetCheck


class PluralCzechCheck(TargetCheck):
    # Used as identifier for check, should be unique
    # Has to be shorter than 50 characters
    check_id = "foo"

    # Short name used to display failing check
    # Might be localized using gettext_lazy
    name = "Foo check"

    # Description for failing check
    description = gettext_lazy("Your translation is foo")

    # Real check code
    def check_target_unit(self, sources, targets, unit):
        if unit.translation.language.is_base({"cs"}):
            return targets[1] == targets[2]
        return False

    def check_single(self, source, target, unit) -> bool:
        """We don't check target strings here."""
        return False