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:

# Copyright © Michal Čihař <michal@weblate.org>
#
# SPDX-License-Identifier: GPL-3.0-or-later

from django.utils.translation import gettext_lazy as _

from weblate.trans.autofixes.base import AutoFix


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

    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 and auto-fixes.

Customizing behavior using flags

You can fine-tune the Weblate behavior by using flags. This can be done on the source string level (see Additional info on source strings), or in the Component configuration (Çeviri işaretleri). Some file formats also allow to specify flags directly in the format (see Supported file 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:.*

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

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

Here is a list of flags currently accepted:

rst-text

Treat a text as an reStructuredText document, affects Çeviri değiştirilmemiş.

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 Salt okunur dizgeler.

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 Çevirinin en fazla uzunluğu.

xml-text

Treat text as XML document, affects XML söz dizimi and XML kodlaması.

font-family:NAME

Define font-family for rendering checks, see Managing fonts.

font-weight:WEIGHT

Define font-weight for rendering checks, see Managing fonts.

font-size:SIZE

Define font-size for rendering checks, see Managing fonts.

font-spacing:SPACING

Define letter spacing for rendering checks, see Managing fonts.

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 Yer belirticiler.

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

Replacements to perform when checking resulting text parameters (for example in Çeviri en fazla uzunluğu or Çevirinin en fazla uzunluğu). 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 Kurallı ifade.

forbidden

Indicates forbidden translation in a glossary, see Forbidden translations.

strict-same

Make “Unchanged translation” avoid using built-in words blacklist, see Çeviri değiştirilmemiş.

check-glossary

Enable the Sözlük ile uyumlu değil quality check.

angularjs-format

Enable the AngularJS değer ekleme dizgesi quality check.

c-format

Enable the C biçimi quality check.

c-sharp-format

Enable the C# biçimi quality check.

es-format

Enable the ECMAScript kalıbı sabitleri quality check.

i18next-interpolation

i18next değer eklemesi kalite denetimi kullanılsın.

icu-message-format

Enable the ICU MessageFormat quality check.

java-printf-format

Enable the Java biçimi quality check.

java-format

Enable the Java MessageFormat quality check.

javascript-format

Enable the JavaScript biçimi quality check.

lua-format

Enable the Lua biçimi quality check.

object-pascal-format

Enable the Object Pascal biçimi quality check.

percent-placeholders

Enable the Yüzde yer belirticileri quality check.

perl-format

Enable the Perl biçimi quality check.

php-format

Enable the PHP biçimi quality check.

python-brace-format

Enable the Python parantez biçimi quality check.

python-format

Enable the Python biçimi quality check.

qt-format

Enable the Qt biçimi quality check.

qt-plural-format

Enable the Qt çoğul biçimi quality check.

ruby-format

Enable the Ruby biçimi quality check.

scheme-format

Enable the Şema biçimi quality check.

vue-format

Enable the Vue I18n biçimlendirmesi quality check.

md-text

Treat text as a Markdown document. Enable Markdown bağlantıları, Markdown başvuruları, and Markdown söz dizimi quality checks.

case-insensitive

Adjust checks behavior to be case-insensitive. Currently affects only Yer belirticiler quality check.

safe-html

Enable the Güvenli olmayan HTML quality check.

url

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

ignore-all-checks

Ignore all quality checks.

ignore-bbcode

Skip the BBCode kodlaması quality check.

ignore-duplicate

Skip the Art arda yinelenen sözcükler quality check.

ignore-check-glossary

Skip the Sözlük ile uyumlu değil quality check.

ignore-double-space

Skip the Çift boşluk quality check.

ignore-angularjs-format

Skip the AngularJS değer ekleme dizgesi quality check.

ignore-c-format

Skip the C biçimi quality check.

ignore-c-sharp-format

Skip the C# biçimi quality check.

ignore-es-format

Skip the ECMAScript kalıbı sabitleri quality check.

ignore-i18next-interpolation

check-i18next-format kalite denetimini atlansın.

ignore-icu-message-format

Skip the ICU MessageFormat quality check.

ignore-java-format

Skip the Java MessageFormat quality check.

ignore-java-printf-format

Skip the Java biçimi quality check.

ignore-javascript-format

Skip the JavaScript biçimi quality check.

ignore-lua-format

Skip the Lua biçimi quality check.

ignore-object-pascal-format

Skip the Object Pascal biçimi quality check.

ignore-percent-placeholders

Skip the Yüzde yer belirticileri quality check.

ignore-perl-format

Skip the Perl biçimi quality check.

ignore-php-format

Skip the PHP biçimi quality check.

ignore-python-brace-format

Skip the Python parantez biçimi quality check.

ignore-python-format

Skip the Python biçimi quality check.

ignore-qt-format

Skip the Qt biçimi quality check.

ignore-qt-plural-format

Skip the Qt çoğul biçimi quality check.

ignore-ruby-format

Skip the Ruby biçimi quality check.

ignore-scheme-format

Skip the Şema biçimi quality check.

ignore-vue-format

Skip the Vue I18n biçimlendirmesi quality check.

ignore-translated

Skip the Çevrilmiş quality check.

ignore-inconsistent

Skip the Tutarsız quality check.

ignore-kashida

Skip the Kashida harfi kullanılmış quality check.

ignore-md-link

Skip the Markdown bağlantıları quality check.

ignore-md-reflink

Skip the Markdown başvuruları quality check.

ignore-md-syntax

Skip the Markdown söz dizimi quality check.

ignore-max-length

Skip the Çevirinin en fazla uzunluğu quality check.

ignore-max-size

Skip the Çeviri en fazla uzunluğu quality check.

ignore-escaped-newline

Skip the Mismatched \n quality check.

ignore-end-colon

Skip the İki nokta üst üste farklı quality check.

ignore-end-ellipsis

Skip the Üç nokta farklı quality check.

ignore-end-exclamation

Skip the Ünlem işareti farklı quality check.

ignore-end-stop

Skip the Nokta işareti farklı quality check.

ignore-end-question

Skip the Soru işareti farklı quality check.

ignore-end-semicolon

Skip the Noktalı virgül farklı quality check.

ignore-newline-count

Skip the Satır sonları farklı quality check.

ignore-plurals

Skip the Çoğul biçim eksik quality check.

ignore-placeholders

Skip the Yer belirticiler quality check.

ignore-punctuation-spacing

Skip the Noktalama aralığı quality check.

ignore-regex

Skip the Kurallı ifade quality check.

ignore-same-plurals

Skip the Tekil ile çoğul biçim aynı quality check.

ignore-begin-newline

Skip the Başta yeni satır var quality check.

ignore-begin-space

Skip the Baştaki boşluk quality check.

ignore-end-newline

Skip the Sonda yeni satır var quality check.

ignore-end-space

Skip the Sondaki boşluk quality check.

ignore-same

Skip the Çeviri değiştirilmemiş quality check.

ignore-safe-html

Skip the Güvenli olmayan HTML quality check.

ignore-url

Skip the Adres quality check.

ignore-xml-tags

Skip the XML kodlaması quality check.

ignore-xml-invalid

Skip the XML söz dizimi quality check.

ignore-zero-width-space

Skip the Sıfır genişlikli boşluk quality check.

ignore-ellipsis

Skip the Üç nokta quality check.

ignore-icu-message-format-syntax

Skip the ICU MessageFormat söz dizimi quality check.

ignore-long-untranslated

Skip the Uzun süredir çevrilmemiş quality check.

ignore-multiple-failures

Skip the Birden çok denetim hatası quality check.

ignore-unnamed-format

Skip the Birden çok değişken adlandırılmamış quality check.

ignore-optional-plural

Skip the Çoğul değil quality check.

Not

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

Enforcing checks

3.11 sürümünde geldi.

You can configure a list of checks which can not be ignored by setting Zorunlu denetimler in Component configuration. Each listed check can not be dismissed in the user interface and any string failing this check is marked as Needs editing (see Translation states).

Not

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

Managing fonts

3.7 sürümünde geldi.

İpucu

Fonts uploaded into Weblate are used purely for purposes of the Çeviri en fazla uzunluğu check, they do not have an effect in Weblate user interface.

The Çeviri en fazla uzunluğu 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 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:

../_images/font-group-edit.png

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:

../_images/font-group-list.png

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

../_images/font-edit.png

You can have a number of fonts loaded into Weblate:

../_images/font-list.png

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

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.

Kendi denetimlerinizi oluşturmak

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.

  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).

Bazı örnekler:

To install custom checks, provide a fully-qualified path to the Python class in the CHECK_LIST, see Custom quality checks, add-ons 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”.

# Copyright © Michal Čihař <michal@weblate.org>
#
# SPDX-License-Identifier: GPL-3.0-or-later

"""Simple quality check example."""

from django.utils.translation import gettext_lazy as _

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
    name = _("Foo check")

    # Description for failing check
    description = _("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.

# Copyright © Michal Čihař <michal@weblate.org>
#
# SPDX-License-Identifier: GPL-3.0-or-later

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

from django.utils.translation import gettext_lazy as _

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
    name = _("Foo check")

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

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

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