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 © 2012 - 2020 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <https://weblate.org/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
#
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, addons and auto-fixes.
Customizing behavior¶
You can fine-tune the behavior of Weblate (mostly checks) for each source string (in source strings review, see Additional info on source strings) or in the Component configuration (Translation flags). Some file formats also allow to specify flags directly in the format.
Here is a list of flags currently accepted:
rst-text
- Treat a text as an RST document, affects Unchanged translation.
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 Unsafe 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 Maximum length
xml-text
- Treat text as XML document, affects XML syntax and XML markup.
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 font-spacing for rendering checks, see Managing fonts.
placeholders:NAME
- Placeholder strings expected in translation, see Placeholders.
regex:REGEX
- Regular expresion to match translation, see Regular expression.
python-format
,c-format
,php-format
,python-brace-format
,javascript-format
,c-sharp-format
,java-format
,java-messageformat
,auto-java-messageformat
,qt-format
,qt-plural-format
,ruby-format
- Treats all strings like format strings, affects Formatted strings, Formatted strings, Formatted strings, Formatted strings, Formatted strings, Formatted strings, Formatted strings, Formatted strings, Formatted strings, Formatted strings, Formatted strings, Unchanged translation.
ignore-end-space
- Skip the «Trailing space» quality check.
ignore-inconsistent
- Skip the «Inconsistent» quality check.
ignore-translated
- Skip the «Has been translated» quality check.
ignore-begin-newline
- Skip the «Starting newline» quality check.
ignore-zero-width-space
- Skip the «Zero-width space» quality check.
ignore-escaped-newline
- Skip the «Mismatched n» quality check.
ignore-same
- Skip the «Unchanged translation» quality check.
strict-same
- Make «Unchanged translation» avoid using built in words blacklist, see Unchanged translation.
ignore-end-question
- Skip the «Trailing question» quality check.
ignore-end-ellipsis
- Skip the «Trailing ellipsis» quality check.
ignore-ellipsis
- Skip the «Ellipsis» quality check.
ignore-python-brace-format
- Skip the «Python brace format» quality check.
ignore-end-newline
- Skip the «Trailing newline» quality check.
ignore-c-format
- Skip the «C format» quality check.
ignore-javascript-format
- Skip the «JavaScript format» quality check.
ignore-optional-plural
- Skip the «Unpluralized» quality check.
ignore-end-exclamation
- Skip the «Trailing exclamation» quality check.
ignore-end-colon
- Skip the «Trailing colon» quality check.
ignore-xml-invalid
- Skip the «XML syntax» quality check.
ignore-xml-tags
- Skip the «XML markup» quality check.
ignore-python-format
- Skip the «Python format» quality check.
ignore-plurals
- Skip the «Missing plurals» quality check.
ignore-begin-space
- Skip the «Starting spaces» quality check.
ignore-bbcode
- Skip the «BBcode markup» quality check.
ignore-multiple-failures
- Skip the «Multiple failing checks» quality check.
ignore-php-format
- Skip the «PHP format» quality check.
ignore-end-stop
- Skip the «Trailing stop» quality check.
ignore-angularjs-format
- Skip the «AngularJS interpolation string» quality check.
ignore-c-sharp-format
- Skip the «C# format» quality check.
ignore-java-format
- Skip the «Java 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-punctuation-spacing
- Skip the «Punctuation spacing» quality check.
Nota
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¶
Nuevo en la versión 3.11.
You can configure a list of checks which can not be ignored by setting Enforced checks in Component configuration. Each listed check can not be ignored in the user interface and any string failing this check is marked as Needs editing (see Translation states).
Managing fonts¶
Nuevo en la versión 3.7.
The Maximum size of translation check used to calculate dimensions of the rendered text needs font info to be selected, which can be done in the Weblate font management tool in Fonts under the Manage menu of your translation project.
TrueType or OpenType fonts can be uploaded, set up font-groups and use those in the 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 Customizing behavior). 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 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 thecheck_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 quality checks, addons 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 © 2012 - 2020 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <https://weblate.org/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
#
"""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 © 2012 - 2020 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <https://weblate.org/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
#
"""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