mirror of
https://gh.wpcy.net/https://github.com/WeblateOrg/weblate.git
synced 2026-05-02 11:38:31 +08:00
b234f7dce2
* Integration reworked * Spelling: Not in a upstream repository * Removed remaining part of old sentence * Spelling: bimono ref for API, version control system * Spelling: Code-hosting website, version-control system * Spelling: letting it guide you through * Spelling: the process of importing * Spelling: guiding * Spelling: Importing refined * review and 2nd rewrite to respect actual behaviour * Fix documentation syntax Co-authored-by: Michal Čihař <michal@cihar.com> Co-authored-by: Benjamin Alan Jamie <benjamin@weblate.org>
73 lines
2.9 KiB
ReStructuredText
73 lines
2.9 KiB
ReStructuredText
Integrating with Weblate
|
||
========================
|
||
|
||
.. include:: /snippets/basics.rst
|
||
|
||
Importing localization project into Weblate
|
||
+++++++++++++++++++++++++++++++++++++++++++
|
||
|
||
Weblate has been developed with VCS integration in mind as it’s core feature, so the easiest way is
|
||
to grant Weblate the access to your repository.
|
||
The import process will guide you through configuring your translations into components.
|
||
|
||
Alternatively, you can use Weblate to set up a local repository containing
|
||
all the translations without integration.
|
||
|
||
.. seealso::
|
||
|
||
:ref:`adding-projects`,
|
||
:ref:`faq-submodule`
|
||
|
||
Fetching updated translations from Weblate
|
||
++++++++++++++++++++++++++++++++++++++++++
|
||
|
||
To fetch updated strings from Weblate, you can simply fetch the underlying Git
|
||
repository (either from filesystem, or it can be made available through
|
||
:ref:`git-exporter`). Prior to this, you might want to commit any pending
|
||
changes (see :ref:`lazy-commit`). You can do so in the user interface
|
||
(in the :guilabel:`Repository maintenance`) or from the command line using :ref:`wlc`.
|
||
|
||
This can be automated if you grant Weblate push access to your repository and
|
||
configure :ref:`component-push` in the :ref:`component`.
|
||
|
||
Alternateively, you can use :doc:`/api` to update translations
|
||
to match their latest version.
|
||
|
||
.. seealso::
|
||
|
||
:ref:`continuous-translation`
|
||
|
||
Fetching remote changes into Weblate
|
||
++++++++++++++++++++++++++++++++++++
|
||
|
||
To fetch the strings newly updated in your repository into Weblate, just let it pull from the upstream
|
||
repository. This can be achieved in the user interface (in the :guilabel:`Repository
|
||
maintenance`), or from the command line using :ref:`wlc`.
|
||
|
||
This can be automated by setting a webhook in your repository to trigger
|
||
Weblate whenever there is a new commit, see :ref:`update-vcs` for more details.
|
||
|
||
If you’re not using a VCS integration, you can use UI or :doc:`/api` to update
|
||
translations to match your code base.
|
||
|
||
.. seealso::
|
||
|
||
:ref:`continuous-translation`
|
||
|
||
Adding new strings
|
||
++++++++++++++++++
|
||
|
||
In case your translation files are stored in a VCS together with the code,
|
||
you most likely have an existing workflow for developers to introduce new strings.
|
||
Any way of adding strings will be picked up, but consider using
|
||
:ref:`source-quality-gateway` to avoid introducing errors.
|
||
|
||
When the translation files are separate from the code, there are following ways to introduce
|
||
new strings into Weblate. For now, Weblate can intorduce new strings only to monolingual translations (check :ref:`bimono`).
|
||
|
||
* Manually, using :guilabel:`Add new translation string` from :guilabel:`Tools`
|
||
menu in the language used as the source for translations.
|
||
* Programatically, using API :http:post:`/api/translations/(string:project)/(string:component)/(string:language)/units/`.
|
||
* By uploading source file as :guilabel:`Replace existing translation file`
|
||
(this overwrites existing strings, so please make sure the file includes both
|
||
old and new strings, see :ref:`upload-method`).
|
