weblate/docs/devel/translations.rst
2022-02-18 14:27:37 +01:00

141 lines
4.9 KiB
ReStructuredText
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Managing translations
=====================
.. _adding-translation:
Adding new translations
-----------------------
New strings can be made available for translation when they appear in the base file,
called :guilabel:`Template for new translations` (see :ref:`component`).
If your file format doesn't require such a file, as is the case with most monolingual
translation flows, you can start with empty files).
New languages can be added right away when requested by a user in Weblate, or a
notification will be sent to project admins for approval and manual addition.
This can be done using :ref:`component-new_lang` in :ref:`component`.
.. note::
If you add a language file in connected remote repository, respective
translation will be added to the component when Weblate updates local repository.
More info on the repository update settings can be found on the :ref:`update-vcs`.
.. seealso::
:ref:`component-new_lang`,
:ref:`new-translations`
.. _removing-translation:
Removing existing translations
------------------------------
Languages, components, or the projects they are in, can be removed (deleted from Weblate
and remote repository if used) from the menu :guilabel:`Manage`:guilabel:`Removal`
of each project, component, or language.
Initiating the :guilabel:`Removal` action shows the list of components to be removed.
You have to enter the object's `slug` to confirm the removal. The `slug` is the
project's, language's, or component's pathname as it can be seen in the URL.
If you want to remove just some specific strings, there are following ways:
- Manually in the source file. They will be removed from the
translation project as well upon Weblate's repository update.
.. versionadded:: 4.5
- In Weblates UI via button :guilabel:`Tools`:guilabel:`Remove` while editing the string.
This has differences between file formats, see: :ref:`component-manage_units`
.. note::
If you delete a language file in connected remote repository, respective
translation will be removed from the component when Weblate updates local repository.
More info on the repository update settings can be found on the :ref:`update-vcs`.
.. _variants:
String variants
---------------
Variants are useful to group several strings together so that translators can
see all variants of the string at one place.
.. hint::
Abbreviations (shortened forms, contractions) are a good example of variants.
Automated key based variants
++++++++++++++++++++++++++++
.. versionadded:: 3.11
You can define regular expression to group the strings based on the key of
monolingual translations in the :ref:`component`:
.. image:: /screenshots/variants-settings.png
In case the :guilabel:`Key` matches the expression, the matching part is
removed to generate root key of the variant. Then all the strings with the same
root key become part of a single variant group, also including the string with
the key exactly matching the root key.
The following table lists some usage examples:
+---------------------------+-------------------------------+-----------------------------------------------+
| Use case | Regular expression variant | Matched translation keys |
+===========================+===============================+===============================================+
| Suffix identification | ``(Short|Min)$`` | ``monthShort``, ``monthMin``, ``month`` |
+---------------------------+-------------------------------+-----------------------------------------------+
| Inline identification | ``#[SML]`` | ``dial#S.key``, ``dial#M.key``, ``dial.key`` |
+---------------------------+-------------------------------+-----------------------------------------------+
Manual variants
+++++++++++++++
.. versionadded:: 4.5
You can manually link specific strings using ``variant:SOURCE`` flag. This can
be useful for bilingual translations which do not have keys to group strings
automatically, or to group strings which keys are not matching, but
should be considered together when translating.
The additional variant for a string can also be added using the :guilabel:`Tools` while translating
(when :ref:`component-manage_units` is turned on):
.. image:: /screenshots/glossary-tools.png
.. note::
There the variant source string has to at most 768 characters long. This is
technical limitation due to compatibility with MySQL database.
.. seealso::
:ref:`custom-checks`,
:ref:`glossary-variants`
Variants while translating
++++++++++++++++++++++++++
The variant is later grouped when translating:
.. image:: /screenshots/variants-translate.png
.. _labels:
String labels
-------------
Split component translation strings into categories by text and colour in the project configuration.
.. image:: /screenshots/labels.png
.. hint::
Labels can be assigned to units in :ref:`additional` by bulk editing, or using the :ref:`addon-weblate.flags.bulk` add-on.