Integrating with Weblate

Bases de Weblate

Structure du projet et des composants

Dans Weblate, les traductions sont organisées en projets et composants. Chaque projet peut contenir un certain nombre de composants et ceux-ci contiennent des traductions dans des langues individuelles. Le composant correspond à un fichier traduisible (par exemple GNU gettext PO (Portable Object) ou Ressources de chaînes Android). Les projets sont là pour vous aider à organiser les composants en ensembles logiques (par exemple pour regrouper toutes les traductions utilisées dans une application).

Additionally, components within projects can be structured using categories. Components can belong to a category, and categories can be nested.

En interne, chaque projet dispose par défaut de traductions de chaînes communes qui se propagent à travers les autres composants du projet. Cela allège le fardeau de la traduction répétitive et multiversion. La propagation de la traduction peut être désactivée par Configuration des composants en utilisant Permettre la propagation de la traduction au cas où les traductions devraient diverger.

Repository integration

Weblate is built to integrate with upstream version control repository, Traduction en continu describes building blocks and how the changes flow between them.

Voir aussi

Architecture overview describes how Weblate works internally.

User attribution

Weblate keeps the translations properly authored by translators in the version control repository by using name and e-mail. Having a real e-mail attached to the commit follows the distributed version control spirits and allows services like GitHub to associate your contributions done in Weblate with your GitHub profile.

This feature also brings in risk of misusing e-mail published in the version control commits. Moreover, once such a commit is published on public hosting (such as GitHub), there is effectively no way to redact it. Weblate allows choosing a private commit e-mail in Compte to avoid this.

Therefore, admins should consider this while configuring Weblate:

Importation d’un projet de localisation dans 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.

Récupérer les traductions mises à jour depuis Weblate

Weblate stores updated strings in a database and commits them to a local version control repository. You can add Weblate repository (when Exportateur Git is turned on) as additional remote and fetch translations update from it.

Prior to this, you might want to commit any pending changes (see Archivages lazy). You can do so in the user interface (in the Repository maintenance) or from the command-line using Client Weblate.

Pushing changes can be automated if you grant Weblate push access to your repository and configure URL pour l’envoi du dépôt in the Configuration des composants, see Pushing changes from Weblate.

Alternatively, you can use API REST de Weblate to update translations to match their latest version.

Récupérer les modifications distantes dans 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 Repository maintenance), or from the command-line using Client Weblate.

This can be automated by setting a webhook in your repository to trigger Weblate whenever there is a new commit, see Mise à jour des dépôts for more details.

If you’re not using a VCS integration, you can use UI or API REST de Weblate to update translations to match your code base.

Ajout de nouvelles chaînes

If your translation files are stored in a remote 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 Quality gateway for the source strings to avoid introducing errors.

When translation files are separated from the code, the following ways can introduce new strings into Weblate.

Note

The ability to add strings in Weblate requires Gérer les chaînes.

Mise à jour des fichiers de langue cible

For monolingual files (see Formats de fichiers pris en charge) Weblate might add new translation strings not present in the Fichier de langue de base mono-langue, and not in actual translations. It does not however perform any automatic cleanup of stale strings as that might have unexpected outcomes. If you want to do this, please install Nettoyer les fichiers de traduction add-on which will handle the cleanup according to your requirements.

Weblate also will not try to update bilingual files in any way, so if you need po files being updated from pot, you need to do it yourself using Update source strings Import methods or using Mettre à jour les fichiers PO afin qu’ils correspondent au POT (msgmerge) add-on.

Introducing new strings

You can add new strings in Weblate with Gérer les chaînes turned on, but it is usually better to introduce new strings together with the code changes that introduced them.

Monolingual formats need addition of the new string to Fichier de langue de base mono-langue. This is typically done by the developers during developing the code. You might want to introduce review of those strings using Quality gateway for the source strings.

Bilingual formats typically extract strings from the source code using some tooling (like xgettext or intltool-update). Follow your localization framework documentation for instructions how to do that. Once the strings are extracted, there might be an additional step needed to update existing translations, see Mise à jour des fichiers de langue cible.

Indication

Automating string extraction is presently out of scope for Weblate. It typically involves executing untrusted code what makes it more suitable for a generic continuous integration than localization-specific platform.

You might want to integrate this into your continuous integration pipelines to make new strings automatically appear for translation. Such pipeline should also cover Avoiding merge conflicts.

Managing version control repository

Weblate stores all translation the version control repository. It can be either connected to upstream one, or it can be only internal. The Repository maintenance lets you manipulate with the repository.

Indication

With Traduction en continu the repository is automatically pushed whenever there are changes and there is usually no need to manually manipulate with it.

../_images/component-repository.webp