weblate/docs/user/files.rst
Golubev Alexander bfca083907
Docs: massive rework of Access control chapter (#5566)
* Docs: massive rework of Access control chapter
* Apply suggestions from code review
accepted many corrections by @comradekingu, thanks
* partially including suggestions
* Update docs/admin/access.rst
* Update docs/admin/access.rst
* rephrasing
* another wave of corrections
- adding back some things left out during the big changes
- proofreading that it corresponds to the app behavior
- getting rid of typos, complicated and wrongly composed sentences
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* structure change
* Docs/Access control: Reverting restore of "Locking down" section
The intformation from it was already moved to the bottom.
* Docs/Access Control: Fix a mistake
* Docs: fix references to access control
* Docs: apply suggestions for Workflows
* Docs/Access Control: some spelling
* Update docs/admin/access.rst
* structure change
* final pre-merge changes
- structure changed slightly
- corrected grammar and spelling
- adding links
- improved formatting
* added article
* dropping `the`
* article correction
* article added
* Apply suggestions for articles and commas
* formatting and apostrophes
* phrasing simplification
* small corrections and suggestions applied
* adding search hit for `lock`

Co-authored-by: Golubev Alexander <fatzer2@gmail.com>
Co-authored-by: Benjamin Alan Jamie <benjamin@weblate.org>
Co-authored-by: Allan Nordhøy <epost@anotheragency.no>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2021-03-21 13:37:46 +01:00

134 lines
4.2 KiB
ReStructuredText

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::
Available options might be limited by
:ref:`access control <access-control>` settings.
.. _download:
Downloading translations
------------------------
From the project or component dashboard, translatable files can be downloaded
in the :guilabel:`Files` menu.
The first option is to download the file in the original format as it is stored in the
repository. In this case, any pending changes in the translation are getting committed
and the up-to-date file is yield without any conversions.
You can also download the translation converted into one of the 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 via the :guilabel:`Files`:guilabel:`Customize download` menu:
* gettext PO
* XLIFF with gettext extensions
* XLIFF 1.1
* TermBase eXchange
* Translation Memory eXchange
* gettext MO
* CSV
* Excel Open XML
* JSON
* Android String Resource
* iOS strings
.. image:: /images/file-download.png
.. seealso::
:http:get:`/api/translations/(string:project)/(string:component)/(string:language)/file/`
.. _upload:
Uploading translations
----------------------
When you have made your changes, use :guilabel:`Upload translation`
in the :guilabel:`Files` menu.
.. image:: /images/file-upload.png
.. _upload-file:
Supported file formats
++++++++++++++++++++++
Any file in a supported file format can be uploaded, but it is still
recommended to use the same file format as the one 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).
.. _upload-method:
Import methods
++++++++++++++
These are the choices presented when uploading translation files:
Add as translation (``translate``)
Imported translations are added as translations. This is the most common usecase, and
the default behavior.
Add as suggestion (``suggest``)
Imported translations are added as suggestions, do this when you want to have your
uploaded strings reviewed.
Add as translation needing edit (``fuzzy``)
Imported translations are added as translations needing edit. This can be useful
when you want translations to be used, but also reviewed.
Replace existing translation file (``replace``)
Existing file is replaced with new content. This can lead to loss of existing
translations, use with caution.
Update source strings (``source``)
Updates source strings in bilingual translation file. This is similar to
what :ref:`addon-weblate.gettext.msgmerge` does.
This option is supported only for some file formats.
Add new strings (``add``)
Adds new strings to the translation. It skips the one which already exist.
In case you want to both add new strings and update existing translations,
upload the file second time with :guilabel:`Add as translation`.
This option is available only with :ref:`component-manage_units` turned on.
.. seealso::
:http:post:`/api/translations/(string:project)/(string:component)/(string:language)/file/`
.. _upload-conflicts:
Conflicts handling
++++++++++++++++++
Defines how to deal with uploaded strings which are already translated.
.. _upload-fuzzy:
Strings needing edit
++++++++++++++++++++
There is also an option for how to handle strings needing edit in the imported
file. Such strings can be handle in one of the three following ways: "Do not
import", "Import as string needing edit", or "Import as translated".
.. _upload-author-name:
.. _upload-author-email:
Overriding authorship
+++++++++++++++++++++
With admin permissions, you can also specify authorship of uploaded file. This
can be useful in case you've received the file in another way and want to merge
it into existing translations while properly crediting the actual author.