mirror of
https://gh.wpcy.net/https://github.com/WeblateOrg/weblate.git
synced 2026-04-25 06:03:22 +08:00
This uses the source string to detect whether HTML sanitization should happen to gracefully handle formats like MDX which mix up HTML markup with MDX specific markup.
316 lines
13 KiB
ReStructuredText
316 lines
13 KiB
ReStructuredText
``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 :ref:`read-only-strings`.
|
|
``terminology``
|
|
Used in :ref:`glossary`. 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 :ref:`check-max-length`.
|
|
``xml-text``
|
|
Treat text as XML document, affects :ref:`check-xml-invalid` and :ref:`check-xml-tags`.
|
|
``font-family:NAME``
|
|
Define font-family for rendering checks, see :ref:`fonts`.
|
|
``font-weight:WEIGHT``
|
|
Define font-weight for rendering checks, see :ref:`fonts`.
|
|
``font-size:SIZE``
|
|
Define font-size for rendering checks, see :ref:`fonts`.
|
|
``font-spacing:SPACING``
|
|
Define letter spacing for rendering checks, see :ref:`fonts`.
|
|
``icu-flags:FLAGS``
|
|
Define flags for customizing the behavior of the :ref:`check-icu-message-format` quality check.
|
|
``icu-tag-prefix:PREFIX``
|
|
Set a required prefix for XML tags for the :ref:`check-icu-message-format` quality check.
|
|
``placeholders:NAME:NAME2:...``
|
|
Placeholder strings expected in translation, see :ref:`check-placeholders`.
|
|
``replacements:FROM:TO:FROM2:TO2...``
|
|
Replacements to perform when checking resulting text parameters (for
|
|
example in :ref:`check-max-size` or :ref:`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 :ref:`variants`.
|
|
``regex:REGEX``
|
|
Regular expression to match translation, see :ref:`check-regex`.
|
|
``discard:NAME``
|
|
Discards flag defined on a higher level.
|
|
``forbidden``
|
|
Indicates forbidden translation in a glossary, see :ref:`glossary-forbidden`.
|
|
``strict-same``
|
|
Make the :ref:`check-same` avoid using the built-in words exceptions.
|
|
``strict-format``
|
|
Make format checks enforce using format even for plural forms with a single value, see :ref:`check-formats`.
|
|
``case-insensitive``
|
|
Adjust checks behavior to be case-insensitive. Currently affects only :ref:`check-placeholders` quality check.
|
|
|
|
.. AUTOGENERATED START: check-flags-enables
|
|
.. This section is automatically generated by `./manage.py list_checks`. Do not edit manually.
|
|
|
|
``bbcode-text``
|
|
Treat a text as an Bulletin Board Code (BBCode) document, affects :ref:`check-same`.
|
|
Enables the :ref:`check-bbcode` quality check.
|
|
``check-glossary``
|
|
Enables the :ref:`check-check-glossary` quality check.
|
|
``fluent-parts``
|
|
Enables the :ref:`check-fluent-parts` quality check.
|
|
``fluent-references``
|
|
Enables the :ref:`check-fluent-references` quality check.
|
|
``fluent-target-inner-html``
|
|
Enables the :ref:`check-fluent-target-inner-html` quality check.
|
|
``fluent-target-syntax``
|
|
Enables the :ref:`check-fluent-target-syntax` quality check.
|
|
``angularjs-format``
|
|
Enables the :ref:`check-angularjs-format` quality check.
|
|
``automattic-components-format``
|
|
Enables the :ref:`check-automattic-components-format` quality check.
|
|
``c-format``
|
|
Enables the :ref:`check-c-format` quality check.
|
|
``c-sharp-format``
|
|
Enables the :ref:`check-c-sharp-format` quality check.
|
|
``csharp-format``
|
|
Enables the :ref:`check-c-sharp-format` quality check.
|
|
``es-format``
|
|
Enables the :ref:`check-es-format` quality check.
|
|
``i18next-interpolation``
|
|
Enables the :ref:`check-i18next-interpolation` quality check.
|
|
``icu-message-format``
|
|
Enables the :ref:`check-icu-message-format` and :ref:`check-icu-message-format-syntax` quality checks.
|
|
``java-printf-format``
|
|
Enables the :ref:`check-java-printf-format` quality check.
|
|
``java-format``
|
|
Enables the :ref:`check-java-format` quality check.
|
|
``auto-java-messageformat``
|
|
Treat a text as conditional Java MessageFormat, enabling :ref:`check-java-format` only when the source contains Java MessageFormat placeholders.
|
|
Enables the :ref:`check-java-format` quality check.
|
|
``javascript-format``
|
|
Enables the :ref:`check-javascript-format` quality check.
|
|
``laravel-format``
|
|
Enables the :ref:`check-laravel-format` quality check.
|
|
``lua-format``
|
|
Enables the :ref:`check-lua-format` quality check.
|
|
``object-pascal-format``
|
|
Enables the :ref:`check-object-pascal-format` quality check.
|
|
``objc-format``
|
|
Enables the :ref:`check-objc-format` quality check.
|
|
``percent-placeholders``
|
|
Enables the :ref:`check-percent-placeholders` quality check.
|
|
``perl-brace-format``
|
|
Enables the :ref:`check-perl-brace-format` quality check.
|
|
``perl-format``
|
|
Enables the :ref:`check-perl-format` quality check.
|
|
``php-format``
|
|
Enables the :ref:`check-php-format` quality check.
|
|
``python-brace-format``
|
|
Enables the :ref:`check-python-brace-format` quality check.
|
|
``python-format``
|
|
Enables the :ref:`check-python-format` quality check.
|
|
``qt-format``
|
|
Enables the :ref:`check-qt-format` quality check.
|
|
``qt-plural-format``
|
|
Enables the :ref:`check-qt-plural-format` quality check.
|
|
``ruby-format``
|
|
Enables the :ref:`check-ruby-format` quality check.
|
|
``scheme-format``
|
|
Enables the :ref:`check-scheme-format` quality check.
|
|
``vue-format``
|
|
Enables the :ref:`check-vue-format` quality check.
|
|
``rst-text``
|
|
Treat a text as an reStructuredText document, affects :ref:`check-same`.
|
|
Enables the :ref:`check-rst-references` and :ref:`check-rst-syntax` quality checks.
|
|
``md-text``
|
|
Treat a text as a Markdown document, and provide Markdown syntax highlighting on the translation text area.
|
|
Enables the :ref:`check-md-link`, :ref:`check-md-reflink` and :ref:`check-md-syntax` quality checks.
|
|
``max-length``
|
|
Enables the :ref:`check-max-length` quality check.
|
|
``max-size``
|
|
Enables the :ref:`check-max-size` quality check.
|
|
``placeholders``
|
|
Enables the :ref:`check-placeholders` quality check.
|
|
``regex``
|
|
Enables the :ref:`check-regex` quality check.
|
|
``safe-html``
|
|
Enables the :ref:`check-safe-html` quality check.
|
|
``auto-safe-html``
|
|
Treat a text as conditional HTML, enabling :ref:`check-safe-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 :ref:`check-safe-html` quality check.
|
|
``url``
|
|
The string should consist of only a URL.
|
|
Enables the :ref:`check-url` quality check.
|
|
``fluent-source-inner-html``
|
|
Enables the :ref:`check-fluent-source-inner-html` quality check.
|
|
``fluent-source-syntax``
|
|
Enables the :ref:`check-fluent-source-syntax` quality check.
|
|
|
|
.. AUTOGENERATED END: check-flags-enables
|
|
|
|
``ignore-all-checks``
|
|
Ignore all quality checks.
|
|
|
|
.. AUTOGENERATED START: check-flags-ignores
|
|
.. This section is automatically generated by `./manage.py list_checks`. Do not edit manually.
|
|
|
|
``ignore-bbcode``
|
|
Skip the :ref:`check-bbcode` quality check.
|
|
``ignore-xml-chars-around-tags``
|
|
Skip the :ref:`check-xml-chars-around-tags` quality check.
|
|
``ignore-duplicate``
|
|
Skip the :ref:`check-duplicate` quality check.
|
|
``ignore-check-glossary``
|
|
Skip the :ref:`check-check-glossary` quality check.
|
|
``ignore-double-space``
|
|
Skip the :ref:`check-double-space` quality check.
|
|
``ignore-fluent-parts``
|
|
Skip the :ref:`check-fluent-parts` quality check.
|
|
``ignore-fluent-references``
|
|
Skip the :ref:`check-fluent-references` quality check.
|
|
``ignore-fluent-target-inner-html``
|
|
Skip the :ref:`check-fluent-target-inner-html` quality check.
|
|
``ignore-fluent-target-syntax``
|
|
Skip the :ref:`check-fluent-target-syntax` quality check.
|
|
``ignore-angularjs-format``
|
|
Skip the :ref:`check-angularjs-format` quality check.
|
|
``ignore-automattic-components-format``
|
|
Skip the :ref:`check-automattic-components-format` quality check.
|
|
``ignore-c-format``
|
|
Skip the :ref:`check-c-format` quality check.
|
|
``ignore-c-sharp-format``
|
|
Skip the :ref:`check-c-sharp-format` quality check.
|
|
``ignore-es-format``
|
|
Skip the :ref:`check-es-format` quality check.
|
|
``ignore-i18next-interpolation``
|
|
Skip the :ref:`check-i18next-interpolation` quality check.
|
|
``ignore-icu-message-format``
|
|
Skip the :ref:`check-icu-message-format` quality check.
|
|
``ignore-java-printf-format``
|
|
Skip the :ref:`check-java-printf-format` quality check.
|
|
``ignore-java-format``
|
|
Skip the :ref:`check-java-format` quality check.
|
|
``ignore-javascript-format``
|
|
Skip the :ref:`check-javascript-format` quality check.
|
|
``ignore-laravel-format``
|
|
Skip the :ref:`check-laravel-format` quality check.
|
|
``ignore-lua-format``
|
|
Skip the :ref:`check-lua-format` quality check.
|
|
``ignore-object-pascal-format``
|
|
Skip the :ref:`check-object-pascal-format` quality check.
|
|
``ignore-objc-format``
|
|
Skip the :ref:`check-objc-format` quality check.
|
|
``ignore-percent-placeholders``
|
|
Skip the :ref:`check-percent-placeholders` quality check.
|
|
``ignore-perl-brace-format``
|
|
Skip the :ref:`check-perl-brace-format` quality check.
|
|
``ignore-perl-format``
|
|
Skip the :ref:`check-perl-format` quality check.
|
|
``ignore-php-format``
|
|
Skip the :ref:`check-php-format` quality check.
|
|
``ignore-python-brace-format``
|
|
Skip the :ref:`check-python-brace-format` quality check.
|
|
``ignore-python-format``
|
|
Skip the :ref:`check-python-format` quality check.
|
|
``ignore-qt-format``
|
|
Skip the :ref:`check-qt-format` quality check.
|
|
``ignore-qt-plural-format``
|
|
Skip the :ref:`check-qt-plural-format` quality check.
|
|
``ignore-ruby-format``
|
|
Skip the :ref:`check-ruby-format` quality check.
|
|
``ignore-scheme-format``
|
|
Skip the :ref:`check-scheme-format` quality check.
|
|
``ignore-vue-format``
|
|
Skip the :ref:`check-vue-format` quality check.
|
|
``ignore-translated``
|
|
Skip the :ref:`check-translated` quality check.
|
|
``ignore-inconsistent``
|
|
Skip the :ref:`check-inconsistent` quality check.
|
|
``ignore-rst-references``
|
|
Skip the :ref:`check-rst-references` quality check.
|
|
``ignore-kashida``
|
|
Skip the :ref:`check-kashida` quality check.
|
|
``ignore-md-link``
|
|
Skip the :ref:`check-md-link` quality check.
|
|
``ignore-md-reflink``
|
|
Skip the :ref:`check-md-reflink` quality check.
|
|
``ignore-md-syntax``
|
|
Skip the :ref:`check-md-syntax` quality check.
|
|
``ignore-max-length``
|
|
Skip the :ref:`check-max-length` quality check.
|
|
``ignore-max-size``
|
|
Skip the :ref:`check-max-size` quality check.
|
|
``ignore-escaped-newline``
|
|
Skip the :ref:`check-escaped-newline` quality check.
|
|
``ignore-end-colon``
|
|
Skip the :ref:`check-end-colon` quality check.
|
|
``ignore-end-ellipsis``
|
|
Skip the :ref:`check-end-ellipsis` quality check.
|
|
``ignore-end-exclamation``
|
|
Skip the :ref:`check-end-exclamation` quality check.
|
|
``ignore-end-stop``
|
|
Skip the :ref:`check-end-stop` quality check.
|
|
``ignore-end-interrobang``
|
|
Skip the :ref:`check-end-interrobang` quality check.
|
|
``ignore-end-question``
|
|
Skip the :ref:`check-end-question` quality check.
|
|
``ignore-end-semicolon``
|
|
Skip the :ref:`check-end-semicolon` quality check.
|
|
``ignore-newline-count``
|
|
Skip the :ref:`check-newline-count` quality check.
|
|
``ignore-plurals``
|
|
Skip the :ref:`check-plurals` quality check.
|
|
``ignore-multiple-capital``
|
|
Skip the :ref:`check-multiple-capital` quality check.
|
|
``ignore-kabyle-characters``
|
|
Skip the :ref:`check-kabyle-characters` quality check.
|
|
``ignore-placeholders``
|
|
Skip the :ref:`check-placeholders` quality check.
|
|
``ignore-prohibited-initial-character``
|
|
Skip the :ref:`check-prohibited-initial-character` quality check.
|
|
``ignore-punctuation-spacing``
|
|
Skip the :ref:`check-punctuation-spacing` quality check.
|
|
``ignore-regex``
|
|
Skip the :ref:`check-regex` quality check.
|
|
``ignore-rst-syntax``
|
|
Skip the :ref:`check-rst-syntax` quality check.
|
|
``ignore-reused``
|
|
Skip the :ref:`check-reused` quality check.
|
|
``ignore-same-plurals``
|
|
Skip the :ref:`check-same-plurals` quality check.
|
|
``ignore-begin-newline``
|
|
Skip the :ref:`check-begin-newline` quality check.
|
|
``ignore-begin-space``
|
|
Skip the :ref:`check-begin-space` quality check.
|
|
``ignore-end-newline``
|
|
Skip the :ref:`check-end-newline` quality check.
|
|
``ignore-end-space``
|
|
Skip the :ref:`check-end-space` quality check.
|
|
``ignore-same``
|
|
Skip the :ref:`check-same` quality check.
|
|
``ignore-safe-html``
|
|
Skip the :ref:`check-safe-html` quality check.
|
|
``ignore-url``
|
|
Skip the :ref:`check-url` quality check.
|
|
``ignore-xml-tags``
|
|
Skip the :ref:`check-xml-tags` quality check.
|
|
``ignore-xml-invalid``
|
|
Skip the :ref:`check-xml-invalid` quality check.
|
|
``ignore-zero-width-space``
|
|
Skip the :ref:`check-zero-width-space` quality check.
|
|
``ignore-ellipsis``
|
|
Skip the :ref:`check-ellipsis` quality check.
|
|
``ignore-fluent-source-inner-html``
|
|
Skip the :ref:`check-fluent-source-inner-html` quality check.
|
|
``ignore-fluent-source-syntax``
|
|
Skip the :ref:`check-fluent-source-syntax` quality check.
|
|
``ignore-icu-message-format``
|
|
Skip the :ref:`check-icu-message-format-syntax` quality check.
|
|
``ignore-long-untranslated``
|
|
Skip the :ref:`check-long-untranslated` quality check.
|
|
``ignore-multiple-failures``
|
|
Skip the :ref:`check-multiple-failures` quality check.
|
|
``ignore-unnamed-format``
|
|
Skip the :ref:`check-unnamed-format` quality check.
|
|
``ignore-optional-plural``
|
|
Skip the :ref:`check-optional-plural` quality check.
|
|
|
|
.. AUTOGENERATED END: check-flags-ignores
|