アドオン

アドオンを使用すると、翻訳ワークフローの変更および自動化ができます。管理者は、各翻訳プロジェクトまたはコンポーネントの 管理 ↓ アドオン メニューからアドオンの追加と管理ができます。アドオンは、管理画面 からサイト全体にもインストールできます。

ヒント

また、API、DEFAULT_ADDONS または install_addon を使用してアドオンを設定できます。

../_images/addons.webp

アドオンをトリガーするイベント

アドオンのインストール

アドオンのインストール時にトリガーされます。

コンポーネントの更新

次のようなコンポーネントに変更が発生するたびにトリガーされます:

  • リポジトリ内の文字列が変更されます。

  • 文字列が追加されます。

  • 新しい翻訳が追加されています。

毎日

毎日トリガーされますが、アドオンは通常 BACKGROUND_TASKS に応じて毎日の負荷をコンポーネント間で分割します。

Event change

Triggered after a Change event is created.

リポジトリ追加後

新しい翻訳が追加され、コミットされた直後にトリガーされます。

リポジトリのコミット後

変更がコミットされた直後にトリガーされます。

リポジトリのプッシュ後

リポジトリが上流にプッシュされた直後にトリガーされます。

リポジトリの更新後

上流リポジトリから新しい変更がプルされるたびにトリガーされます。

リポジトリのコミット前

変更がコミットされる直前にトリガーされます。

リポジトリの事前プッシュ

リポジトリが上流にプッシュされる直前にトリガーされます。

リポジトリ更新前

リポジトリの更新が試行される直前にトリガーされます。

ストレージから読み込み後

Weblate によってファイルが解析されたときにトリガーされます。

ユニット保存後

文字列が保存された直後にトリガーされます。

ユニットの事前作成

新しく作成された文字列が保存された直後にトリガーされます。

付属のアドオン

自動翻訳

アドオン ID:

weblate.autotranslate.autotranslate

設定:

mode

自動翻訳モード

設定できる値:

suggest -- 提案として追加

translate -- 翻訳として追加

fuzzy -- 「要編集」として追加

filter_type

検索フィルター

すべての文字列を翻訳すると、既存の翻訳はすべて破棄されますのでご注意ください。

設定できる値:

all -- すべての文字列

nottranslated -- 未翻訳の文字列

todo -- 翻訳未完了の文字列

fuzzy -- 要編集マーク付きの文字列

check:inconsistent -- 不合格項目: 一貫性の欠如

check:translated -- 不合格の検査：過去に翻訳済み

auto_source

自動翻訳の参照先

設定できる値:

others -- 他の翻訳コンポーネント

mt -- 機械翻訳

component

コンポーネント

参照先として使用するコンポーネントのスラッグを入力します。現在のプロジェクト内のすべてのコンポーネントを使用する場合は、空白のままにします。

engines

機械翻訳エンジン

threshold

スコアしきい値
トリガー:

アドオンのインストール、コンポーネントの更新、毎日

機械翻訳または他のコンポーネントを使用して文字列を自動的に翻訳します。

参考

自動翻訳, コンポーネント間で翻訳を同じ状態に維持, Priority of machine translation and translation memory services

JavaScript 現地語化 CDN

Added in version 4.2.

アドオン ID:

weblate.cdn.cdnjs

設定:

threshold

翻訳率のしきい値

The percentage of translated strings that must be present for translation to be included.

css_selector

CSS セレクタ

翻訳可能な要素を検出する CSS セレクタ。

cookie_name

言語 Cookie 名

言語設定を保存する Cookie の名前。

files

HTMLファイルから文字列を抽出

現在のリポジトリ内のファイル名のリスト、または翻訳可能な文字列を解析するリモート URL。
トリガー:

アドオンのインストール、毎日、リポジトリのコミット後、リポジトリの更新後

JavaScript または HTML の現地語化用に、翻訳をコンテンツ配信ネットワークに公開します。

静的な HTML ページを現地語化したり、JavaScript コードで翻訳を読み込むために使用できます。

HTML のページに挿入して、翻訳を可能にするコンポーネント専用の URL を生成します。詳細については、Weblate CDN を使用した HTML と JavaScript の翻訳 を確認してください。

注釈

このアドオンには、Weblate サーバー上で追加の設定が必要です。 LOCALIZE_CDN_PATH は生成されたファイルが書き込まれる場所（ファイルシステム上）を設定し、 LOCALIZE_CDN_URL はファイルが提供される場所（URL）を定義します。ファイルの提供は Weblate によって行われないため、外部で設定することが必要です（通常は CDN サービスを使用します）。

このアドオンは Hosted Weblate で設定され、https://weblate-cdn.com/ 経由でファイルを提供します。

参考

Weblate CDN アドオンの設定、Weblate CDN を使用した HTML と JavaScript の翻訳、Weblate CDN の文字列抽出、Weblate CDN を使用した HTML の現地語化

空白文字列の削除

Added in version 4.4.

アドオン ID:

weblate.cleanup.blank

設定:

このアドオンには設定はありません。

トリガー:

アドオンのインストール、リポジトリのコミット後、リポジトリの更新後

翻訳ファイルから翻訳されていない文字列を削除します。

翻訳ファイルに空の文字列を含ませたくない場合使用します（例: 翻訳ライブラリにおいて原文に戻すのではなく、空の文字列が不足していると表示させる場合）。

参考

Weblate は翻訳以外の翻訳ファイルを更新しますか？

翻訳ファイルのクリーンアップ

アドオン ID:

weblate.cleanup.generic

設定:

このアドオンには設定はありません。

トリガー:

アドオンのインストール、リポジトリの更新後、リポジトリのコミット前

すべての翻訳ファイルを、モノリンガル用の基礎となる翻訳ファイルと一致するように更新します。ほとんどのファイル形式で、基礎となる翻訳ファイルに存在しない、無効な翻訳キーは削除されます。

また、翻訳文字列以外の追加コンテンツを含む形式（HTML ファイル、Windows RC ファイル、OpenDocument 形式 など）の場合、クリーンアップにより翻訳ファイルが元のファイルに同期します。

参考

Weblate は翻訳以外の翻訳ファイルを更新しますか？

不足している言語を追加

アドオン ID:

weblate.consistency.languages

設定:

このアドオンには設定はありません。

トリガー:

アドオンのインストール、毎日、リポジトリ追加後

プロジェクト内のすべてのコンポーネントで一貫した言語のセットが使用されるようにします。

足りない言語は、24 時間ごとに 1 回、さらに新しい言語を Weblate に追加したときに確認します。

他のほとんどのアドオンとは異なり、このアドオンはプロジェクト全体に影響します。

ヒント

新しく追加した文字列を 自動翻訳 アドオンで翻訳します。

コンポーネントの検出

アドオン ID:

weblate.discovery.discovery

設定:

match

翻訳ファイルを照合する正規表現

file_format

ファイル形式

name_template

コンポーネント名のカスタマイズ

base_file_template

モノリンガル用の、基礎となる翻訳ファイル名の設定

バイリンガル翻訳の場合は、何も設定しないでください。

new_base_template

新しい翻訳用の、基礎となる翻訳ファイルの設定

新しい翻訳の作成に使用するファイルのファイル名。gettext では .pot ファイルを選択します。

intermediate_template

中間言語ファイル

中間翻訳ファイルのファイル名。多くの場合、これは開発者により提供される翻訳ファイルで、実際の原文を作成する際に使用されます。

language_regex

言語フィルター

ファイル マスクのスキャン時に、翻訳ファイルをフィルター処理する正規表現。

copy_addons

アドオンを、メイン コンポーネントから新しく作成したコンポーネントにクローンする

remove

存在しないファイルのコンポーネントの削除

confirm

上記の一致が正しいかを確認する
トリガー:

アドオンのインストール、リポジトリの更新後

バージョン管理システムのファイル変更に基づいて、プロジェクトコンポーネントを自動的に追加または削除します。

照合は、複雑な設定ができる正規表現を使用して行われますが、そのためにはある程度の知識が必要です。一般的な使用例については、アドオンのヘルプ セクションを確認してください。

翻訳ファイルと照合する正規表現には、コンポーネントと言語に一致する 2 つの名前付きグループが含まれていることが必要です。正規表現のすべての名前付きグループは、テンプレート フィールドで変数として使用できます。

すべてのファイル名フィールドで Django テンプレートのマークアップを使用できます。例:

{{ component }}

コンポーネントのファイル名が一致

{{ component|title }}

先頭を大文字にしたコンポーネントファイル名

{{ path }}: {{ component }}

正規表現からのカスタム一致グループ

保存 をクリックすると、一致するコンポーネントの確認画面を表示し、設定が実際のニーズに合っているか確認する方法:

../_images/addon-discovery.webp

コンポーネント検出の例

言語ごとに 1 つのフォルダー

言語ごとに 1 つのフォルダがあり、その中に各コンポーネントの翻訳ファイルが含まれている場合。

正規表現:

(?P<language>[^/.]*)/(?P<component>[^/]*)\.po

一致するファイル:

  • cs/application.po

  • cs/website.po

  • de/application.po

  • de/website.po

Gettext 形式のロケールのレイアウト

gettext PO ファイルを保存する一般的な構造の場合。

正規表現:

locale/(?P<language>[^/.]*)/LC_MESSAGES/(?P<component>[^/]*)\.po

一致するファイル:

  • locale/cs/LC_MESSAGES/application.po

  • locale/cs/LC_MESSAGES/website.po

  • locale/de/LC_MESSAGES/application.po

  • locale/de/LC_MESSAGES/website.po

複雑なファイル名

コンポーネントと言語の両方がファイル名に入っている場合。

正規表現:

src/locale/(?P<component>[^/]*)\.(?P<language>[^/.]*)\.po

一致するファイル:

  • src/locale/application.cs.po

  • src/locale/website.cs.po

  • src/locale/application.de.po

  • src/locale/website.de.po

言語コードの反復

言語がパスにもファイル名にも入っている場合。

正規表現:

locale/(?P<language>[^/.]*)/(?P<component>[^/]*)/(?P=language)\.po

一致するファイル:

  • locale/cs/application/cs.po

  • locale/cs/website/cs.po

  • locale/de/application/de.po

  • locale/de/website/de.po

Android 文字列の

複数のファイルに分割された Android リソース文字列。

正規表現:

res/values-(?P<language>[^/.]*)/strings-(?P<component>[^/]*)\.xml

一致するファイル:

  • res/values-cs/strings-about.xml

  • res/values-cs/strings-help.xml

  • res/values-de/strings-about.xml

  • res/values-de/strings-help.xml

複数のパスの一致

Java プロパティの翻訳を備えたマルチモジュールの Maven プロジェクト。

正規表現:

(?P<originalHierarchy>.+/)(?P<component>[^/]*)/src/main/resources/ApplicationResources_(?P<language>[^/.]*)\.properties

コンポーネント名:

{{ originalHierarchy }}: {{ component }}

一致するファイル:

  • parent/module1/submodule/src/main/resources/ApplicationResources_fr.properties

  • parent/module1/submodule/src/main/resources/ApplicationResource_es.properties

  • parent/module2/src/main/resources/ApplicationResource_de.properties

  • parent/module2/src/main/resources/ApplicationResource_ro.properties

ヒント

コンポーネントを検出するアドオンは、Weblate の内部 URL を使用します。これは、複数のコンポーネント間で VCS 設定を共有するのに便利です。リンクされたコンポーネントは、各コンポーネントの ソースコードのリポジトリ フィールド（管理 ↓ 設定 ↓ バージョン管理システム の中）に weblate://project/main-component を入力して、設定したメイン コンポーネントのローカル リポジトリを使用します。これにより、設定およびシステム リソースの時間をも節約できます。

参考

テンプレート用のマークアップ、import_project

一括編集

アドオン ID:

weblate.flags.bulk

設定:

q

検索文字列

state

翻訳状態の設定

設定できる値:

-1 -- 翻訳禁止

10 -- 要編集

20 -- 翻訳済

30 -- 承認済

add_flags

追加する翻訳フラグ

remove_flags

削除する翻訳フラグ

add_labels

追加するラベル

remove_labels

削除するラベル
トリガー:

アドオンのインストール、コンポーネントの更新

文字列のフラグ、ラベル、状態を一括編集します。

例:

新しい文字列に自動的にラベルを生成

検索クエリ

NOT has:label

追加するラベル

recent
アプリ ストアのメタデータ ファイル の変更履歴 エントリを、すべて翻訳禁止にする

検索クエリ

language:en AND key:changelogs/

追加する翻訳フラグ

read-only
特定の文字列を翻訳禁止にする

検索クエリ

source:r"^\`\`[.a-zA-Z0-9_-]*\`\`$" AND language:en

追加する翻訳フラグ

read-only

参考

一括編集、フラグを使用した動作の設定、文字列ラベル

未翻訳の翻訳文に "要編集" フラグを付ける

アドオン ID:

weblate.flags.same_edit

設定:

このアドオンには設定はありません。

トリガー:

ユニットの事前作成

VCS からインポートされた新しい翻訳可能な文字列が原文と同一のとき、Weblate は "要編集" フラグを付けます。特に、未翻訳の文字列は原文で埋めるファイル形式では有用です。

ヒント

また、翻訳フラグ に strict-same フラグを追加して、未翻訳の翻訳文 検査を強化できます。

参考

翻訳文の状態

新しい原文に "要編集" フラグを付ける

アドオン ID:

weblate.flags.source_edit

設定:

このアドオンには設定はありません。

トリガー:

ユニットの事前作成

新しい原文を VCS からインポートするときに、Weblate で "要編集" フラグを付けます。これにより、開発者が作成した原文を簡単に絞り込んで編集できます。

参考

翻訳文の状態

新しい翻訳に "要編集" フラグを付ける

アドオン ID:

weblate.flags.target_edit

設定:

このアドオンには設定はありません。

トリガー:

ユニットの事前作成

新しい翻訳可能な文章を VCS からインポートするときに、Weblate で "要編集" フラグを付けます。これにより、開発者が作成した翻訳文を簡単に絞り込んで編集できます。

参考

翻訳文の状態

読み取り専用の文字列を原文で埋める

Added in version 4.18.

アドオン ID:

weblate.generate.fill_read_only

設定:

このアドオンには設定はありません。

トリガー:

アドオンのインストール、コンポーネントの更新、毎日

文字列が編集禁止の場合は、原文を翻訳に代入します。

統計データの生成

アドオン ID:

weblate.generate.generate

設定:

filename

生成ファイルの名前

template

生成ファイルの内容
トリガー:

リポジトリのコミット前

翻訳状況の詳細情報ファイルを生成します。

Django テンプレートは、ファイル名とコンテンツの両方で使用できます。マークアップの詳細については、テンプレート用のマークアップ を確認してください。

例えば、各翻訳の概要ファイルの生成:

生成ファイルの名前

locale/{{ language_code }}.json

内容
{
   "language": "{{ language_code }}",
   "strings": "{{ stats.all }}",
   "translated": "{{ stats.translated }}",
   "last_changed": "{{ stats.last_changed }}",
   "last_author": "{{ stats.last_author }}",
}

参考

テンプレート用のマークアップ

事前に原文を翻訳に代入

Added in version 4.11.

アドオン ID:

weblate.generate.prefill

設定:

このアドオンには設定はありません。

トリガー:

アドオンのインストール、コンポーネントの更新、毎日

初期値として原文を翻訳に代入する。

コンポーネント内の全ての未翻訳の文字列には原文が入り、要編集になります。これは、翻訳ファイルに空の文字列を含めることができない場合に使用します。

疑似ロケールの生成

Added in version 4.5.

アドオン ID:

weblate.generate.pseudolocale

設定:

source

原文

target

翻訳先

この言語の翻訳は全て上書きされます

prefix

Prepended static text

var_prefix

Prepended variable text

suffix

Appended static text

var_suffix

Appended variable text

var_multiplier

Variable text multiplier

How many times to repeat the variable text depending on the length of the source string.

include_readonly

翻訳禁止の文字列を含める
トリガー:

アドオンのインストール、コンポーネントの更新、毎日

原文に接頭辞と接尾辞を自動的に追加して、翻訳を生成します。

疑似ロケールは、翻訳対象になっていない文字列を探すのに便利です。すべての翻訳可能な原文を変更したあと、アプリケーションを疑似ロケールで実行して、置き換えられていない文字列を簡単に見つけることができます。

また、現地語化したときにレイアウトが崩れるかもしれない文字列も発見できます。

Using the variable parts makes it possible to look for strings which might not fit into the user interface after the localization - it extends the text based on the source string length. The variable texts are repeated by length of the text multiplied by the multiplier. For example Hello world with variable text _ and variable multiplier of 1 becomes Hello world___________ - the text is repeated once for each character in the source string.

文字列の生成に使用されるパターン:

Prepended static text Prepended variable text Source string Appended variable text Appended static text

ヒント

テストには実際の言語を使用できますが、 Weblate には専用の疑似ロケール（ en_XA と ar_XB ）が用意されています。

ヒント

このアドオンを使用して、既存の言語または類似の言語の新しい言語への翻訳を開始できます。コンポーネントに翻訳を追加したら、アドオンに従います。例: fr があり、fr_CA の翻訳を開始する場合、ソースに fr、ターゲットには fr_CA を設定し、接頭辞と接尾辞を空白にするだけです。

コピー後に作成した翻訳を Weblate に変更されないように、新しい翻訳が入力されたらアドオンをアンインストールしてください。

コメント内の貢献者情報

アドオン ID:

weblate.gettext.authors

設定:

このアドオンには設定はありません。

トリガー:

リポジトリのコミット前

PO ファイルヘッダーのコメントを更新し、貢献者名と貢献した西暦を追加します。

PO ファイルヘッダーは次のようになる:

# Michal Čihař <michal@weblate.org>, 2012, 2018, 2019, 2020.
# Pavel Borecki <pavel@example.com>, 2018, 2019.
# Filip Hron <filip@example.com>, 2018, 2019.
# anonymous <noreply@weblate.org>, 2019.

configure ファイルの ALL_LINGUAS 変数の更新

アドオン ID:

weblate.gettext.configure

設定:

このアドオンには設定はありません。

トリガー:

アドオンのインストール、毎日、リポジトリ追加後

新しい翻訳を追加すると、configure、configure.in、または任意の configure.ac ファイルの ALL_LINGUAS 変数を更新します。

gettext 出力のカスタマイズ

アドオン ID:

weblate.gettext.customize

設定:

width

長い行を折り返す

デフォルトでは、gettext は 77 文字または改行で行を折り返します。--no-wrap パラメータを指定すると、改行でのみ折り返されます。

設定できる値:

77 -- 行を 77 文字と改行で折り返す（xgettext のデフォルト）

65535 -- 改行でのみ行を折り返す（'xgettext --no-wrap' のように）

-1 -- 行を折り返さない
トリガー:

ストレージから読み込み後

改行処理など、 gettext の出力動作をカスタマイズできます。

使用できるオプション:

  • 77 文字または改行で行を折り返す

  • 改行でのみ行を折り返す

  • 行を折り返さない

注釈

デフォルトでは、gettext は 77 文字または改行で行を折り返します。--no-wrap パラメータを指定すると、改行でのみ折り返されます。

LINGUAS ファイルの更新

アドオン ID:

weblate.gettext.linguas

設定:

このアドオンには設定はありません。

トリガー:

アドオンのインストール、毎日、リポジトリ追加後

新しい翻訳が追加されたときに LINGUAS ファイルを更新します。

MO ファイルの生成

アドオン ID:

weblate.gettext.mo

設定:

path

生成された MO ファイルのパス

指定しない場合は、PO ファイルの場所を使用します。

fuzzy

要編集な文字列を含める

要編集な文字列（あいまい）は、通常、翻訳として使用できる状態ではありません。
トリガー:

リポジトリのコミット前

変更された PO ファイルごとに自動的に MO ファイルを生成します。

MO ファイルが生成される場所はカスタマイズでき、フィールドは テンプレート用のマークアップ を使用します。

注釈

翻訳が削除されると、その PO ファイルはリポジトリから削除されますが、このアドオンによって生成された MO ファイルは削除されません。 MO ファイルは、上流リポジトリから手動で削除してください。

POT に合わせて PO ファイルを更新 (msgmerge)

アドオン ID:

weblate.gettext.msgmerge

設定:

previous

翻訳済み文字列の以前の msgid を保持する

no_location

翻訳済みの文字列の場所を削除する

fuzzy

あいまい検索を使用する
トリガー:

アドオンのインストール、リポジトリの更新後

msgmerge を使用して POT ファイル（ 新しい翻訳のテンプレート で設定）に整合するように、すべての PO ファイル（ ファイル マスク で設定）を更新します。

ほとんどの msgmerge のコマンドライン オプションは、アドオンの設定から設定できます。

参考

Weblate は翻訳以外の翻訳ファイルを更新しますか？

Git コミットのスカッシュ

アドオン ID:

weblate.git.squash

設定:

squash

コミットのスカッシュ

設定できる値:

all -- すべてのコミットを 1 つに統合

language -- 言語別

file -- ファイル別

author -- 著者別

append_trailers

スカッシュしたコミット メッセージに翻訳者情報を追加する

トレーラ行とは、RFC 822 のメール ヘッダーに似た "Co-authored-by: …" のような行のことで、コミットメッセージの自由形式部分の末尾につきます。

commit_message

コミットメッセージ

このコミットメッセージは、スカッシュしたコミットのコミットメッセージを結合する代わりに使用されます。
トリガー:

アドオンのインストール、リポジトリのコミット後

変更をプッシュする前に、Git コミットをスカッシュします。

変更をプッシュする前に Git コミットの内容を簡略化するモードの種類:

  • すべてのコミットを 1 つに統合

  • 言語別

  • ファイル別

  • 翻訳者別

元々のコミット メッセージは保持されますが、翻訳者別 を選択するか、コミット メッセージに含めるようカスタマイズしない限り、翻訳者の情報は失われます。

元々のコミット メッセージは、オプションを使用すると独自のコミット メッセージに書き換えられます。

オプションを使用して、元のコミット メッセージからトレーラー（Co-authored-by: … のような行）を切り取り、スカッシュコミットのコミットメッセージの末尾に追加できます。これにより、共同翻訳者全員が、Co-authored-by: として、適切にクレジットされます。

JSON 出力形式のカスタマイズ

バージョン 5.12 で変更: Avoid spaces after separators option added.

アドオン ID:

weblate.json.customize

設定:

sort_keys

JSON キーの並べ替え

use_compact_separators

Avoid spaces after separators

indent

JSON 形式のインデント

style

JSON のインデントスタイル

設定できる値:

spaces -- スペース

tabs -- タブ
トリガー:

ストレージから読み込み後

Allows adjusting JSON output behavior, for example indentation, sorting or compact formatting using minimal whitespace.

Java プロパティ ファイルの整形

アドオン ID:

weblate.properties.sort

設定:

case_sensitive

大文字と小文字を区別したキーの並べ替えを有効にする
トリガー:

リポジトリのコミット前

Java プロパティ ファイルを整形およびソートします。

  • 改行を Unix の改行コードに統一する。

  • Unicode エスケープ シーケンスを大文字に整形する（存在する場合）。

  • 空白行とコメントを削除する。

  • 文字列をキーでソートする。

  • 重複する文字列を削除する。

古いコメントの削除

アドオン ID:

weblate.removal.comments

設定:

age

保存日数
トリガー:

アドオンのインストール、毎日

コメントを削除するまでの期間を設定します。

これは、古くなった可能性のある古いコメントを削除する場合に便利です。コメントが古いからといって、その重要性が失われたわけではないので、注意して使用してください。

古い提案の削除

アドオン ID:

weblate.removal.suggestions

設定:

age

保存日数

votes

投票数のしきい値

削除のしきい値を指定します。このフィールドは、投票ができない設定の場合は無効です。
トリガー:

アドオンのインストール、毎日

提案を削除するまでの期間を設定します。

与えられた時間枠内に必要な賛成票を獲得できなかった提案への投票（参照: 相互評価）を削除するのに大変便利です。

RESX ファイルの更新

アドオン ID:

weblate.resx.update

設定:

このアドオンには設定はありません。

トリガー:

アドオンのインストール、リポジトリの更新後

すべての翻訳ファイルを、上流にあるモノリンガル用の基礎となる翻訳ファイルと整合するように更新します。使われない文字列は削除され、新しい文字列は原文をコピーして追加されます。

ヒント

古い翻訳キーのみを削除する場合は、翻訳ファイルのクリーンアップ を使用します。

参考

Weblate は翻訳以外の翻訳ファイルを更新しますか？

Slack Webhooks

Added in version 5.12.

アドオン ID:

weblate.webhook.slack

設定:

webhook_url

ウェブフック URL

events

変更イベント

設定できる値:

0 -- Resource updated

1 -- Translation completed

2 -- Translation changed

3 -- Comment added

4 -- Suggestion added

5 -- Translation added

6 -- Automatically translated

7 -- Suggestion accepted

8 -- Translation reverted

9 -- Translation uploaded

13 -- Source string added

14 -- Component locked

15 -- Component unlocked

17 -- Changes committed

18 -- Changes pushed

19 -- Repository reset

20 -- Repository merged

21 -- Repository rebased

22 -- Repository merge failed

23 -- Repository rebase failed

24 -- Parsing failed

25 -- Translation removed

26 -- Suggestion removed

27 -- Translation replaced

28 -- Repository push failed

29 -- Suggestion removed during cleanup

30 -- Source string changed

31 -- String added

32 -- Bulk status changed

33 -- Visibility changed

34 -- User added

35 -- User removed

36 -- Translation approved

37 -- Marked for edit

38 -- Component removed

39 -- Project removed

41 -- Project renamed

42 -- Component renamed

43 -- Moved component

45 -- Contributor joined

46 -- Announcement posted

47 -- Alert triggered

48 -- Language added

49 -- Language requested

50 -- Project created

51 -- Component created

52 -- User invited

53 -- Repository notification received

54 -- Translation replaced file by upload

55 -- License changed

56 -- Contributor license agreement changed

57 -- Screenshot added

58 -- Screenshot uploaded

59 -- String updated in the repository

60 -- Add-on installed

61 -- Add-on configuration changed

62 -- Add-on uninstalled

63 -- String removed

64 -- Comment removed

65 -- Comment resolved

66 -- Explanation updated

67 -- Category removed

68 -- Category renamed

69 -- Category moved

70 -- Saving string failed

71 -- String added in the repository

72 -- String updated in the upload

73 -- String added in the upload

74 -- Translation updated by source upload

75 -- Component translation completed

76 -- Applied enforced check

77 -- Propagated change

78 -- File uploaded

79 -- Extra flags updated
トリガー:

Event change

Sends notification to a Slack channel based on selected events.

警告

The notification content might show HTML tags. This is a known issue that will be soon addressed; see https://github.com/WeblateOrg/weblate/issues/15056.

ヒント

To obtain a webhook URL, follow the steps outlined in the Slack Incoming Webhooks documentation

ウェブフック

Added in version 5.11.

アドオン ID:

weblate.webhook.webhook

設定:

webhook_url

ウェブフック URL

secret

秘密鍵

A Base64 encoded string

events

変更イベント

設定できる値:

0 -- Resource updated

1 -- Translation completed

2 -- Translation changed

3 -- Comment added

4 -- Suggestion added

5 -- Translation added

6 -- Automatically translated

7 -- Suggestion accepted

8 -- Translation reverted

9 -- Translation uploaded

13 -- Source string added

14 -- Component locked

15 -- Component unlocked

17 -- Changes committed

18 -- Changes pushed

19 -- Repository reset

20 -- Repository merged

21 -- Repository rebased

22 -- Repository merge failed

23 -- Repository rebase failed

24 -- Parsing failed

25 -- Translation removed

26 -- Suggestion removed

27 -- Translation replaced

28 -- Repository push failed

29 -- Suggestion removed during cleanup

30 -- Source string changed

31 -- String added

32 -- Bulk status changed

33 -- Visibility changed

34 -- User added

35 -- User removed

36 -- Translation approved

37 -- Marked for edit

38 -- Component removed

39 -- Project removed

41 -- Project renamed

42 -- Component renamed

43 -- Moved component

45 -- Contributor joined

46 -- Announcement posted

47 -- Alert triggered

48 -- Language added

49 -- Language requested

50 -- Project created

51 -- Component created

52 -- User invited

53 -- Repository notification received

54 -- Translation replaced file by upload

55 -- License changed

56 -- Contributor license agreement changed

57 -- Screenshot added

58 -- Screenshot uploaded

59 -- String updated in the repository

60 -- Add-on installed

61 -- Add-on configuration changed

62 -- Add-on uninstalled

63 -- String removed

64 -- Comment removed

65 -- Comment resolved

66 -- Explanation updated

67 -- Category removed

68 -- Category renamed

69 -- Category moved

70 -- Saving string failed

71 -- String added in the repository

72 -- String updated in the upload

73 -- String added in the upload

74 -- Translation updated by source upload

75 -- Component translation completed

76 -- Applied enforced check

77 -- Propagated change

78 -- File uploaded

79 -- Extra flags updated
トリガー:

Event change

Sends notifications to external services based on selected events, following the Standard Webhooks specification.

The request payload complies with the Weblate Messaging schema. The OpenAPI description can also be found at /api/docs/. Sample request body:

{
   "change_id": 99,
   "action": "Translation changed",
   "timestamp": "2019-08-24T14:15:22Z",
   "target": "Nazdar svete!",
   "old": "Nazdar!",
   "source": "Hello, world",
   "url": "/translate/project-slug/component-slug/cs/?checksum=46add148a53cab6f",
   "author": "author-username",
   "user": "user-username",
   "project": "project-slug",
   "component": "component-slug",
   "translation": "cs"
}

Sample request body with categories:

{
   "change_id": 8910,
   "action": "Component renamed",
   "timestamp": "2025-06-11T07:15:09Z",
   "target": ["new-name"],
   "old": ["component-slug"],
   "url": "/projects/project-slug/parent-category/child-category/sub-category/component-slug/",
   "user": "testuser",
   "project": "project-slug",
   "component": "component-slug",
   "category": [
      "sub-category",
      "child-category",
      "parent-category"
   ]
}

Sample request headers:

{
   "webhook-id": "7f1c5477f6275a69af7b83236c20cb1a",
   "webhook-timestamp": "1748505623.044281",
   "webhook-signature": "v1,Ceo5qEr07ixe2NLpvHk3FH9bwy/WavXrAFQ/9tdO6mc="
}

The webhook-signature is a space separated list of HMAC signatures generated using the secret string, the request payload, the webhook-timestamp, and the webhook-id. This ensures the authenticity and integrity of the webhook request.

To verify a request, you can use the Webhook.verify method from the standardwebhooks library or an implementation of the "Standard Webhooks Specification".

参考

Standard Webhooks Specification, Weblate Messaging, Python library for Standard Webhooks

XML 出力形式のカスタマイズ

Added in version 4.15.

アドオン ID:

weblate.xml.customize

設定:

closing_tags

空白の XML タグに終了タグを含める
トリガー:

ストレージから読み込み後

XML 出力形式の変更ができます。例: 閉じタグの扱い。

YAML 出力形式のカスタマイズ

アドオン ID:

weblate.yaml.customize

設定:

indent

YAML 形式のインデント

width

長い行を折り返す

設定できる値:

80 -- 80 文字で改行

100 -- 100 文字で改行

120 -- 120 文字で改行

180 -- 180 文字で改行

65535 -- 行を折り返さない

line_break

改行コード

設定できる値:

dos -- DOS (\r\n)

unix -- UNIX (\n)

mac -- MAC (\r)
トリガー:

ストレージから読み込み後

行の長さや改行など、YAML 出力形式の変更ができます。

アドオン一覧のカスタマイズ

アドオンの一覧は WEBLATE_ADDONS で設定します。アドオンを追加するには、設定に絶対クラス名を含めるだけです。

アドオンの作成

独自のアドオンも作成できます。サブクラス weblate.addons.base.BaseAddon を作成してアドオンのメタデータを定義し、処理を行うコールバックを実装します。

参考

アドオンの開発

アドオンから実行するスクリプト

アドオンは、外部スクリプトを実行するためにも使用できます。以前は Weblate に統合されていましたが、現在はスクリプトをアドオンでラップするコードの記述が必要です。

# Copyright © Michal Čihař <michal@weblate.org>
#
# SPDX-License-Identifier: GPL-3.0-or-later

"""Example pre commit script."""

from django.utils.translation import gettext_lazy

from weblate.addons.events import AddonEvent
from weblate.addons.scripts import BaseScriptAddon


class ExamplePreAddon(BaseScriptAddon):
    # Event used to trigger the script
    events: set[AddonEvent] = {
        AddonEvent.EVENT_PRE_COMMIT,
    }
    # Name of the addon, has to be unique
    name = "weblate.example.pre"
    # Verbose name and long description
    verbose = gettext_lazy("Execute script before commit")
    description = gettext_lazy("This add-on executes a script.")

    # Script to execute
    script = "/bin/true"
    # File to add in commit (for pre commit event)
    # does not have to be set
    add_file = "po/{{ language_code }}.po"

インストールの方法は 品質検査、アドオン、自動修正のカスタマイズ を確認してください。

スクリプトは、指定したコンポーネントの VCS リポジトリのルートを、カレント ディレクトリとして実行されます。

さらに利用可能な環境変数:

WL_VCS

使用中のバージョン管理システム。

WL_REPO

上流リポジトリの URL。

WL_PATH

VCS リポジトリへの絶対パス。

WL_BRANCH

現在のコンポーネントに設定したリポジトリのブランチ。

WL_FILEMASK

現在のコンポーネントのファイルマスク。

WL_TEMPLATE

モノリンガル翻訳用のテンプレートのファイル名（空欄でも可）。

WL_NEW_BASE

新しい翻訳の作成用のファイル名（空欄でも可）。

WL_FILE_FORMAT

現在のコンポーネントで使用するファイル形式。

WL_LANGUAGE

現在実行中の翻訳言語（コンポーネント レベルのフックでは使用できません）。

WL_PREVIOUS_HEAD

更新前の HEAD（更新後のフックを実行した後にのみ利用可能）。

WL_COMPONENT_SLUG

コンポーネント URL の設定時に使用するスラッグ。

WL_PROJECT_SLUG

プロジェクト URL の設定時に使用するスラッグ。

WL_COMPONENT_NAME

コンポーネント名。

WL_PROJECT_NAME

プロジェクト名。

WL_COMPONENT_URL

コンポーネント URL。

WL_ENGAGE_URL

プロジェクト参加 URL。

参考

コンポーネント構成

リポジトリを更新後の処理

VCS の上流ソースが変更されたときに翻訳ファイルを更新するために使用できます。これを実現するには、 Weblate は VCS にコミットされたファイルだけを確認するので、スクリプトの一部として変更をコミットすることが必要であることに注意してください。

Gulp による実行例:

#! /bin/sh
gulp --gulpfile gulp-i18n-extract.js
git commit -m 'Update source strings' src/languages/en.lang.json

翻訳のコミット前処理

コミット スクリプトを使用して、翻訳文をリポジトリにコミットする前に、翻訳文を自動的に変更します。

これには、唯一の引数として現在の翻訳のファイル名が渡されます。

アドオン活動ログの記録

アドオン活動ログは、アドオンの実行を記録し、アドオンの活動を追跡するために使用できます。

ログは、ADDON_ACTIVITY_LOG_EXPIRY を設定して、一定の時間経過後に削除できます。