weblate/docs/user/files.rst
Michal Čihař adbde7dc27 Docs: Mention enriched file exports
Fixes #1194

Signed-off-by: Michal Čihař <michal@cihar.com>
2019-08-15 19:54:55 +02:00

62 lines
2.1 KiB
ReStructuredText
Vendored

Downloading and uploading translations
======================================
You can export files from a translation, make changes, and import them again. This allows
working offline, and then merging changes back into the existing translation.
This works even if it has been changed in the meantime.
.. note::
The available options might be limited by :ref:`privileges`.
Downloading translations
------------------------
Translatable files can be downloaded using the :guilabel:`Download source file`
in the :guilabel:`Files` menu, producing a copy of the file as it is stored
in upstream version control system.
You can either download the original file as is or converted into one of widely
used localization formats. The converted files will be enriched with data
provided in Weblate such as additional context, comments or flags.
Several file formats are available, including a compiled file
to use in your choice of application (for example ``.mo`` files for GNU Gettext) using
the :guilabel:`Files`.
Uploading translations
----------------------
When you have made your changes, use :guilabel:`Upload translation`
in the :guilabel:`Files` menu.
Any of supported file formats can be uploaded, but it is still
recommended to use the same file format as is used for translation, otherwise some
features might not be translated properly.
.. seealso::
:ref:`formats`
The uploaded file is merged to update the translation, overwriting existing
entries by default (this can be turned off or on in the upload dialog).
Import methods
++++++++++++++
These are the choices presented when uploading translation files:
Add as translation
Imported translations are added as translations. This is the most common usecase, and
the default behavior.
Add as suggestion
Imported translations are added as suggestions, do this when you want your
uploaded strings reviewed.
Add as needing review
Imported translations are added as translations needing review. This can be useful
when you want translations to be used, but also reviewed.
There is also an option for how to handle strings needing review in the imported
file.
.. image:: /images/export-import.png