Weblate は、Web ベースの連携する翻訳システムで、世界中の 1500 件以上の Libre ソフトウェアのプロジェクトや、115 以上の国々の企業で使用されているコピーレフトの Libre ソフトウェアです。

インストールするか、Weblate のホストサービス weblate.org を利用してください。

サポート

Weblate は、有料のプロフェッショナル サポートとクラウド ホスティング サービスを備えた Libre ソフトウェアです。詳細については、https://weblate.org/hosting/ を参照してください。

ドキュメント

ソース コードは docs ディレクトリ、もしくは https://docs.weblate.org/ にてオンラインで閲覧できます。

導入

セットアップ手順:

https://docs.weblate.org/ja/latest/admin/install.html

バグ

機能改善のリクエストと不具合を報告してください:

https://github.com/WeblateOrg/weblate/issues

ライセンス

Copyright © 2012–2020 Michal Čihař michal@cihar.com

このプログラムはフリーソフトウェアです:　あなたは、FreeSoftware Foundation によって発行された GNU General Public License のバージョン 3 または（あなたの選択で）それ以降のバージョンのいずれかの条件のもとで、プログラムの再配布または変更ができます。

このプログラムは有用であることを願って配布していますが、いかなる保証もありません。商品性や特定目的への適合性の暗黙の保証もありません。詳細は GNU General Public License を参照してください。

あなたは、このプログラムと共に、GNU General Public License のコピーを受け取っているはずです。そうでない場合は、 https://www.gnu.org/licenses/ を参照してください。

Weblate の基本

プロジェクトとコンポーネントの構造

Weblate では、翻訳はプロジェクトとコンポーネントから成ります。各プロジェクトには複数のコンポーネントを含めることができ、コンポーネントにはそれぞれの言語への翻訳が含まれます。コンポーネントは、翻訳可能な 1 つのファイル（例えば GNU gettext や Android string resources）に対応します。プロジェクトは、コンポーネントを論理的なまとまりに分類する（たとえば、1 つのアプリケーション内で使用するすべての翻訳をグループ化する）のに便利です。

内部ではデフォルトで、各プロジェクトごとに、共通する文字列の翻訳をプロジェクト内の他のコンポーネントに伝播します。これにより、反復や複数バージョンの翻訳の負担を軽減します。翻訳を分岐する場合は、変換の伝播を Component configuration ごとに無効にできます。

参考

Integrating with Weblate

登録とユーザー情報

登録

デフォルトでは、誰もがプロジェクトの閲覧、翻訳の表示、翻訳の提案ができます。実際に変更を保存できるのは、登録ユーザのみであり、翻訳のたびに署名されます。

いくつかの簡単な手順に従って登録できます:

1. 登録フォームに資格情報を入力する。

2. 受信したメールのリンクをクリックして、登録を有効にする。

3. 必要に応じて、プロファイルを設定し、理解している言語を選択する。

ダッシュボード

サインインすると、プロジェクトとコンポーネントの概要、および各翻訳の進行状況が表示されます。

バージョン 2.5 で追加.

監視中のプロジェクトのコンポーネントは、デフォルトで表示され、優先言語とセットで表示されます。

ヒント

ナビゲーション タブから、別のタブを表示できます。

メニューにあるオプション:

• メイン メニューの プロジェクト > すべてのプロジェクトを閲覧 に、Weblate インスタンスの各プロジェクトの翻訳状況を表示します。

• メイン メニューの 言語 で言語を選択すると、すべてのプロジェクトの翻訳状況には、設定した翻訳言語の状況を表示します。

• ダッシュボードの 監視中の翻訳 には、設定した翻訳言語のみが監視中のプロジェクトの翻訳状況に表示します。

また、このドロップダウンには、Weblate 管理者が事前設定したプロジェクトのコンポーネントのセットである コンポーネント リストのセット を複数表示できます、参照 コンポーネント リストのセット。

個人用のデフォルトのダッシュボード画面は、ユーザー情報の 環境設定 タブで設定できます。

注釈

settings.py ファイル（参照 設定）で SINGLE_PROJECT を使用して Weblate を単一のプロジェクト用に設定している場合、ダッシュボードは表示されません。これは、ユーザーが単一のプロジェクトまたはコンポーネントにリダイレクトされるためです。

ユーザー情報

ユーザー情報にアクセスするには、トップメニューの右上にあるユーザー アイコンをクリックし、 設定 メニューをクリックします。

ユーザー情報には、ユーザーの環境設定が含まれています。VCS コミットでは名前とメールアドレスを使用するため、この情報は正確に登録してください。

注釈

すべての言語選択では、現在翻訳されている言語のみを提供します。

ヒント

ボタンをクリックして、翻訳する他の言語をリクエストまたは追加し、使用可能にします。

翻訳言語

翻訳したい言語を選択すると、監視中のプロジェクトのメイン ページに表示され、そこから選択した言語のすべての翻訳に簡単にアクセスできます。

参考言語

翻訳時に参考として表示する参考言語を設定できます。次の図では、ヘブライ語が参考として表示されています。

デフォルトのダッシュボード画面

環境設定 タブで、デフォルトで表示するダッシュボード画面を選択できます。コンポーネント リスト を選択した場合、デフォルトのコンポーネント リスト ドロップダウンから表示するコンポーネント リストの選択が必要です。

参考

コンポーネント リストのセット

公開するユーザー情報

このページのすべてのフィールドはオプションであり、いつでも削除できます。入力すると、あなたのユーザー情報が表示されるすべての場所で、そのデータが共有されることに同意したとみなされます。

アバターはユーザーごとに表示できます（ENABLE_AVATARS の使用）。イメージは、https://gravatar.com/ を使用して取得します。

エディタ リンク

ソース コードのリンクは、デフォルトでは Component configuration で設定した Web ブラウザに表示します。

ヒント

エディタ リンク を設定すると、ローカル エディターを使用して、翻訳した文字列の VCS ソース コードのファイルを表示します。Template markup を使用できます。

一般的には editor://open/?file={{filename}}&line={{line}} が良い選択です。

参考

エディタの独自 URL プロトコルの登録の詳細は、Nette documentation を参照してください。

通知

通知 タブから複数の通知を受け取れます。監視中または管理中のプロジェクトで選択したイベントの通知は、メールで送信されます。

通知の中には、ユーザーの言語のイベントに対してのみ送信されるもの（たとえば新しく翻訳した文字列）と、コンポーネントから発生するイベント（マージ エラーなど）があります。この 2 つの通知グループは、設定では見やすく分かれています。

監視中のプロジェクトと管理中のプロジェクトの通知を切り替えたり、プロジェクトやコンポーネントごとに詳細に設定（非通知など）にできます。コンポーネントの概要ページにアクセスし、監視中 メニューから適切な項目を選択します。

注釈

自分自身の操作についての通知はされません。

アカウント

アカウント タブでは、基本的なアカウントの詳細を設定したり、Weblate へのサインインに使用できる複数の外部サービスに接続したり、アカウントを完全に削除したり、個人情報（参照 Weblate ユーザー データのエクスポート）をダウンロードできます。

注釈

外部サービスの一覧は Weblate の設定によって異なりますが、 GitLab や GitHub、Google、Facebook、Bitbucket といった人気サイトや、その他の OAuth 2.0 プロバイダでも利用可能に設定できます。

API access

You can get or reset your API access token here.

監査ログ

監査ログは、アカウントで実行された作業を記録します。重要な作業ごとに、IP アドレスとブラウザをアカウントに記録します。重要な作業では、デフォルトのメールアドレスへの通知も行います。

参考

Running behind reverse proxy

Weblate を使用した翻訳

Weblate を使用した翻訳に関心をお寄せいただきありがとうございます。プロジェクトは、直接翻訳するように設定することも、アカウントを持たないユーザーからの提案を受け入れるように設定することもできます。

全体として、2 つの翻訳モードがあります。

• 直接翻訳を受け入れるプロジェクト

• 提案のみを受け入れるプロジェクト、提案は、指定した投票数に達すると自動的に検証される

翻訳のワークフローの詳細については、翻訳ワークフロー をご覧ください。

翻訳プロジェクトの表示オプション:

• 一般に公開し、誰でも貢献可能

• 特定のグループの翻訳者のみ閲覧可能

参考

アクセス制御、翻訳ワークフロー

翻訳プロジェクト

翻訳プロジェクトには、同じソフトウェア、書籍、またはプロジェクトに関連する関連コンポーネントが含まれます。

翻訳リンク

コンポーネントでは、翻訳の編集画面に移動できるリンクの一覧があります。さらに翻訳は、次のような個別の検査結果に分類されています、例えば 未翻訳の文字列 または 作業が必要な文字列。プロジェクト全体で不合格とならずに翻訳できた場合であっても、すべての文字列 が使用できます。また、検索フィールドを使用して、特定の文字列または用語の検索もできます。

提案

注釈

実際の権限は、Weblate の構成によって異なります。

匿名のユーザーは、（許可した場合）候補の提案しかできません。サインインしているユーザーは、 翻訳が適当でない場合、他の翻訳者に翻訳を確認してもらうために提案できます。

提案は、現在の翻訳と一致する重複や提案を削除するために、毎日スキャンされます。

コメント

コメントは、原文または翻訳文の 2 つの範囲に対して投稿できます。議論のテーマに合わせて選んでください。原文のコメントは、元の文字列に対するフィードバックの提供に適しています。例えば、言い換えなければならないとか、紛らわしいなどです。

コメントの中では、 Markdown 構文を用い @mention を使用して他のユーザーを指定できます。

参考

原文のフィードバックの受信

関連性

バリアントは、文字列のバリアントを異なる長さでグループ化するために使用します。フロントエンドは、画面またはウィンドウのサイズに応じて異なる文字列を使用できます。

参考

String variants

ラベル

ラベルは、プロジェクト内の文字列を分類するために使用します。これは、現地語化のワークフローをさらにカスタマイズするために使用できます、例えば、文字列のカテゴリを定義するなど。

参考

String labels

翻訳

翻訳ページでは、翻訳元の文字列と翻訳対象の編集フィールドが表示されます。翻訳が複数形である場合、複数形の原文および編集フィールドが表示され、それぞれ複数形で記述されてラベルが付けられます。

すべての特殊な空白文字には、赤い下線が引かれ、灰色の記号で示されます。後続の複数のスペースにも赤い下線が引かれ、翻訳者にフォーマット上の問題が発生することが警告されます。

このページには、さまざまな追加情報が表示されます、そのほとんどはプロジェクトの原文からのものです（コンテキスト、コメント、メッセージを使用している場所など）。環境設定で第 2 言語を選択すると、これらの言語への翻訳が原文の上側に表示されます（参照 参考言語）。

翻訳の下側には、他のユーザの提案が表示され、提案は、採用、採用して編集、削除したりできます。

複数形

数字の指定に応じて形式が変わる単語は、複数形と呼ばれています。各言語には、それぞれ複数の定義があります。例えば、英語は 1 つの複数形をサポートします。例えば「自動車」の単数定義では暗黙のうちに 1 台の自動車が参照され、複数定義の「自動車」では複数台の自動車が参照されるか、名詞としての自動車の概念が使用されます。チェコ語やアラビア語などの言語では、複数形の数が多く、複数形の規則も異なります。

Weblate は、それぞれの言語で複数を別々に翻訳することにより、これらの各形式を完全にサポートしています。フィールドの数と、翻訳したアプリケーションでどのように使用するのかは、定義した複数形によって異なります。Weblate は基本的な情報を表示していますが、詳細な説明は Unicode コンソーシアムの Language Plural Rules にあります。

参考

複数形判別式

キーボード ショートカット

バージョン 2.18 で変更: キーボード ショートカットは 2.18 で刷新し、ブラウザやシステムのデフォルトと衝突する可能性が低くなりました。

翻訳中に利用できるキーボード ショートカット:

キーボード ショートカット	解説
Alt Home	検索した、先頭の翻訳に移動する。
Alt Home	検索した、先頭の翻訳に移動する。
Alt End	検索した、末尾の翻訳に移動する。
Alt PageUp or Ctrl ↑ or Alt ↑ or Cmd ↑	検索した、1 つ前の翻訳に移動する。
Alt PageDown or Ctrl ↓ or Alt ↓ or Cmd ↓	検索した、次の翻訳に移動する。
Alt Enter or Ctrl Enter or Cmd Enter	現在の翻訳を保存する。
Ctrl Shift Enter or Cmd Shift Enter	翻訳のあいまいのマークを解除して送信する。
Ctrl E or Cmd E	翻訳フォームにフォーカスを移動する。
Ctrl U or Cmd U	コメント フィールドにフォーカスを移動する。
Ctrl M or Cmd M	自動提案 タブの表示、参照 自動提案。
Ctrl 1 ～ Ctrl 9 or Cmd 1 ～ Cmd 9	番号を指定して、原文に設定されたプレースホルダを、翻訳にコピーする。
Ctrl M 1 ～ 9 or Cmd M 1 ～ 9	番号を指定して、機械翻訳を翻訳にコピーする。
Ctrl I 1 ～ 9 or Cmd I 1 to 9	番号を指定して、検査不合格の 1 項目を除外する。
Ctrl J or Cmd J	前後の文字列 タブの表示。
Ctrl S or Cmd S	翻訳メモリの検索にフォーカス移動。
Ctrl O or Cmd O	原文を、翻訳に複製する。
Ctrl Y or Cmd Y	要編集 フラグを付ける。

ビジュアル キーボード

小さなビジュアル キーボードを翻訳フィールドのすぐ上に表示しています。これは、通常は場所が分からない文字や、入力が困難な文字を入力する場合に便利です。

表示している記号は、3 つのカテゴリに分かれています。

• ユーザー情報 で定義したユーザー設定文字

• Weblate が提供する言語ごとの文字（引用符や RTL 固有の文字など）

• SPECIAL_CHARS で設定した文字

翻訳コンテキスト

このコンテキストの説明は、現在の文字列に関する関連情報を提供します。

文字列属性

メッセージ ID、コンテキスト（msgctxt）、原文の参照など。

スクリーンショット

スクリーンショットを Weblate にアップロードして、文字列がどこでどのように使用されているかを翻訳者に伝えることができます、参照 Visual context for strings。

前後の文字列

翻訳ファイルの前後の文字列を表示します。これらは通常、同様のコンテキストで使用されるので、翻訳の一貫性の維持に便利です。

その他の出現箇所

メッセージが複数の場所で表示される場合（複数のコンポーネントなど）、一貫性がないと判断されると（参照 一貫性の欠如）、このタブにすべてのメッセージを表示します。どれを使用するかは選択できます。

翻訳メモリ

過去に翻訳した同様の文字列を確認します、参照 Memory Management。

用語集

現在のメッセージで使用しているプロジェクトの用語集の用語を表示します。

最近の更新

Weblate を使用して最近このメッセージを変更したユーザーの一覧です。

プロジェクト

翻訳者への指示などのプロジェクト情報、またはそのバージョン管理システム リポジトリに関する情報。

翻訳形式が対応している場合は、それぞれの原文を含む原文へのリンクをたどることもできます。

翻訳履歴

すべての変更はデフォルトで（コンポーネントの設定で無効にしていない限り）データベースに保存され、元に戻すことができます。必要に応じて、基になるバージョン管理システムの任意の項目を元に戻すこともできます。

翻訳した文字列の長さ

Weblate では、翻訳した文字列が長すぎないように、複数の方法で翻訳の長さを制限できます。

• デフォルトの翻訳文の長さの制限は、原文の 10 倍です。LIMIT_TRANSLATION_LENGTH_BY_SOURCE_LENGTH で、無効にできます。これに該当した場合、単一言語翻訳がバイリンガルに設定されているために、Weblate が翻訳キーを実際の原文ではなくソース文字列として認識することが原因の場合があります。詳細は Bilingual and monolingual formats をご覧ください。

• 翻訳ファイルまたはフラグによって定義した文字の最大長、参照 翻訳文の最大長。

• フラグで定義してピクセル単位の最大表示変換サイズ、参照 翻訳の最大長。

用語集

各プロジェクトには、用語を保存するための略語として、任意の言語に割り当てられた用語集を用意できます。この方法の方が整合性を維持しやすくなります。現在翻訳した文字列の用語は、下部のタブに表示されます。

用語集の管理

各プロジェクト ページの 用語集 タブで、既存の用語集を編集できます。

プロジェクトの作成時に、特定のプロジェクトの空の用語集が自動的に作成されます。用語集は同じプロジェクトのすべてのコンポーネントで共有され、別のプロジェクトと共有することもできます。これは、管理できるプロジェクトに対してのみ実行できます。

このリストでは、管理する用語集を選択できます（現在のプロジェクトで使用しているすべての言語が表示されます）。言語リンクをクリックすると、選択した用語集の編集、インポート、エクスポート、または編集履歴の表示に使用できるページが表示されます。

自動提案

設定と翻訳された言語に基づいて、Weblate は複数の機械翻訳ツールと 翻訳メモリ からの提案を提供します。すべての機械翻訳は、各翻訳ページの単一タブで利用できます。

参考

対応するツールの一覧の検索、参照 機械翻訳。

自動翻訳

自動変換を使用して、外部ソースに基づいたブートストラップ変換を行うことができます。このツールの名前は 自動翻訳 と呼ばれ、コンポーネントと言語を選択して ツール メニューから操作できます。

2 つの操作モードが可能:

• 他の Weblate コンポーネントを翻訳のソースとして使用する。

• 特定の品質しきい値を超える翻訳で、選択した機械翻訳サービスを使用する。

自動翻訳する文字列の選択もできます。

警告

すべての文字列 などの範囲が大きいフィルターを使用すると、既存の翻訳が上書きされてしまうことに注意してください。

異なるコンポーネント間の変換を統合する場合（例えば WEB サイトやアプリケーション）や、既存の変換を使用して新しいコンポーネントの変換をブートストラップする場合（翻訳メモリ）などの状況で役立ちます。

参考

Keeping translations same across components

レート制限

インターフェイスの悪用を避けるために、検索、連絡先フォームの送信、翻訳などの複数の操作に適用されるレート制限があります。この問題に遭遇した場合、操作を再度実行できるまで、一定期間ブロックされます。

デフォルトの制限値については、管理者ドキュメントの レート制限 に説明がありますが、設定によって微調整できます。

検索と置換

用語を変更したり、文字列を一括修正する場合は、検索と置換 で行います。これは ツール メニューにあります。

ヒント

文字列の破壊を心配する必要はありません。実行は 2 段階で行われ、実際に変更する前に編集画面で確認をします。

一括編集

一括編集では、多くの文字列に対して操作を実行できます。検索文字列と実行する操作を定義すると、一致するすべての文字列が更新されます。次の操作に対応しています。

• 文字列の状態の変更（例、査読待ちのすべての文字列の承認）

• 翻訳フラグの調整（参照 動作のカスタマイズ）

• 文字列のラベル調整（参照 String labels）

ヒント

このツールは 一括編集 と呼ばれ、プロジェクト、コンポーネント、翻訳ごとに ツール メニューから操作できます。

参考

Bulk edit addon

翻訳のダウンロードとアップロード

翻訳のファイルをエクスポートし、変更を加えて、再度インポートできます。これにより、オフラインで作業してから、変更内容を既存の翻訳にマージできます。この作業は、その間に変更されても機能します。

注釈

使用可能なオプションは、アクセス制御 により制限されることがあります。

翻訳のダウンロード

プロジェクトまたはコンポーネントのダッシュボードを表示し、翻訳可能なファイルを ファイル メニューの オリジナルの翻訳ファイルのダウンロード からダウンロードします。オリジナルのファイルのコピーは、ファイルを upstream バージョン管理システムに保存するときに作成されます。

また、一般的な翻訳形式などに変換した翻訳のダウンロードもできます。変換したファイルには、追加のコンテキスト、コメント、フラグなど、Weblate が提供するデータが追加されます。

ファイル メニューを使用して選択したアプリケーション（例 GNU Gettext の .mo ファイル）で使用するコンパイル済みファイルなど、複数のファイル形式を使用できます。

翻訳のアップロード

ファイルに変更を加えたら、ファイル メニューの 翻訳のアップロード を実行します。

Supported file formats

対応しているファイル形式のファイルはすべてアップロードできますが、翻訳に使用するファイル形式と同じファイル形式を使用することをお勧めします。ファイル形式が異なると、一部の内容が正しく翻訳されないことがあります。

参考

Supported file formats

アップロードしたファイルは翻訳の更新のためにマージされ、デフォルトで既存のエントリが上書きされます（アップロードのオプション画面で上書き する/しない を選択できます）。

インポート方法

これは、翻訳ファイルをアップロードするときに表示される選択肢です:

翻訳として追加 (translate)

インポートした翻訳を翻訳として追加します。これは最も一般的な使用例であり、デフォルトの動作です。

提案として追加 (suggest)

インポートした翻訳を候補として追加します。アップロードした文字列を確認するには、この操作を行ってください。

翻訳を要編集として追加 (fuzzy)

インポートした翻訳を要編集の翻訳として追加します。これは、翻訳や査読もできて便利です。

既存の翻訳ファイルの置き換え (replace)

既存のファイルを新しいコンテンツで置き換えます。既存の翻訳を失うことがあるので使用に注意してください。

原文の更新 (source)

対訳ファイルの原文を更新します。これは POT に一致する PO ファイルの更新 (msgmerge) と似ています。

参考

POST /api/translations/(string:project)/(string:component)/(string:language)/file/

コンフリクト処理

すでに翻訳されているアップロード済みの文字列の処理方法を定義します。

要編集の文字列

また、インポートしたファイルで編集が必要な文字列を処理するオプションもあります。文字列は、「インポートしない」、「要編集として文字列をインポート」、「翻訳済みとしてインポート」の三択から 1 つ選んで処理できます。

翻訳者の変更

管理者権限で、アップロードしたファイルの翻訳者を設定できます。これは、他の方法でファイルを受け取り、本来の翻訳者に署名しなおして、既存の翻訳にマージする場合に便利です。

検査と修正

品質検査は、一般的な翻訳ミスを発見しやすくして、翻訳が整形された状態であることを保証します。誤検出の場合は、その検査を除外にできます。

保存した翻訳が検査で不合格となった場合、すぐにユーザーに警告を表示します。

自動修正

品質検査 に加えて、Weblate は翻訳した文字列の一般的な翻訳ミスを自動的に修正できます。翻訳ミスを誘発しないよう設定には注意をしてください。

参考

AUTOFIX_LIST

品質検査

Weblate では、文字列に対してさまざまな品質検査をしています。次のセクションでは、すべての検査項目について詳しく説明します。言語固有の検査もあります。誤検出が起こる場合はバグを報告してください。

参考

CHECK_LIST、動作のカスタマイズ

翻訳時の検査

翻訳を変更するたびに検査をするため、翻訳者は高品質な翻訳を維持できます。

BBcode マークアップ

翻訳の BBcode が原文と一致しない

BBCode は、メッセージの重要な部分をボールド フォントやイタリックで強調するなどの表示を、単純なマークアップで記述します。

この検査は、それらが翻訳にも含まれていることを確認します。

注釈

BBcode を検出する方法は現在非常に単純な方法なので、この検査では誤検知が発生することがあります。

重複単語の連続

テキストには同じ単語が 2 回連続したものが含まれている:

バージョン 4.1 で追加.

翻訳に重複する単語が連続してないか検査します。通常は、翻訳ミスです。

ヒント

この検査には、誤検出を避けるための言語固有の規則が含まれています。お客様のケースで誤作動した場合はお知らせください。参照 Weblate の問題の報告。

連続スペース

翻訳に 2 回連続したスペースが含まれている

翻訳でスペースが連続しているか検査し、ほかのスペース関連の検査での誤検出を防止します。

原文で、スペースが連続していれば、検査で不合格になりません。スペースを意図的に連続させているからです。

書式指定文字列

原文から翻訳に文字列の書式指定が複製されているか検査します。翻訳で書式指定文字列を省略すると、通常は深刻な問題が発生するので、文字列の書式指定は、通常は原文と一致していなければなりません。

Weblate では、複数の言語での書式指定文字列の検査に対応しています。検査は、文字列に適切なフラグが設定されている場合にのみ自動的に有効になります（例: C 形式の 'c-format'）。Gettext はこれを自動的に追加しますが、他のファイル形式や PO ファイルが xgettext で生成されていない場合は、手動で追加する必要があります。

これは、ユニットごとに行うこともできますし（参照 Additional info on source strings）、Component configuration で行うこともできます。コンポーネントごとに定義する方が簡単ですが、文字列が書式指定文字列として解釈されず、書式指定文字列の構文がすでに使用されている場合は、誤検出が発生することがあります。

ヒント

Weblate で指定した書式指定の検査ができない場合は、汎用の プレースホルダー を使用できます。

検査に加えて、書式指定文字列をハイライトで表示して翻訳文字列に簡単に挿入できるようにする:

AngularJS 補間文字列

AngularJS 補間文字列が原文と一致しない

名前付きフォーマット文字列	Your balance is {{amount}} {{ currency }}
有効にするフラグ	angularjs-format

参考

AngularJS: API: $interpolate

C 言語書式

C フォーマット文字列が原文と一致しない

単純な書式指定文字列	There are %d apples
書式指定文字列の位置	Your balance is %1$d %2$s
有効にするフラグ	c-format

参考

C format strings、 C printf format

C# 言語形式

C# 形式の文字列が原文と一致しない

書式指定文字列の位置	There are {0} apples
有効にするフラグ	c-sharp-format

参考

C# String Format

ECMAScript テンプレート リテラル

ECMAScript テンプレート リテラルが原文と一致しない

代入	There are ${number} apples
有効にするフラグ	es-format

参考

Template literals

i18next 補間

i18next 補間が原文と一致しない

バージョン 4.0 で追加.

代入	There are {{number}} apples
ネスティング	There are $t(number) apples
有効にするフラグ	i18next-interpolation

参考

i18next interpolation

Java 形式

Java フォーマット文字列が原文と一致しない

単純な書式指定文字列	There are %d apples
書式指定文字列の位置	Your balance is %1$d %2$s
有効にするフラグ	java-format

参考

Java Format Strings

Java MessageFormat

Java メッセージ フォーマット文字列が原文と一致しない

書式指定文字列の位置	There are {0} apples
有効にするフラグ	java-messageformat は無条件に検査を有効にします
	auto-java-messageformat 原文に書式指定文字列がある場合のみ検査を有効にします

参考

Java MessageFormat

JavaScript 形式

JavaScript 書式指定文字列が原文と一致しない

単純な書式指定文字列	There are %d apples
有効にするフラグ	javascript-format

参考

JavaScript formatting strings

パーセントのプレースホルダー

パーセントのプレースホルダーが原文と一致しない

バージョン 4.0 で追加.

単純な書式指定文字列	There are %number% apples
有効にするフラグ	percent-placeholders

Perl 形式

Perl 書式指定文字列が原文と一致しない

単純な書式指定文字列	There are %d apples
書式指定文字列の位置	Your balance is %1$d %2$s
有効にするフラグ	perl-format

参考

Perl sprintf、Perl Format Strings

PHP 形式

PHP フォーマット文字列が原文と一致しない

単純な書式指定文字列	There are %d apples
書式指定文字列の位置	Your balance is %1$d %2$s
有効にするフラグ	php-format

参考

PHP sprintf documentation、 PHP Format Strings

Python のブレース書式

Python ブレース形式文字列が原文と一致しない

単純な書式指定文字列	There are {} apples
名前付きフォーマット文字列	Your balance is {amount} {currency}
有効にするフラグ	python-brace-format

参考

Python brace format、Python Format Strings

Python 形式

Python format string does not match source

単純な書式指定文字列	There are %d apples
名前付きフォーマット文字列	Your balance is %(amount) %(currency)
有効にするフラグ	python-format

参考

Python string formatting、Python Format Strings

Qt 形式

Qt 形式の文字列が原文と一致しない

書式指定文字列の位置	There are %1 apples
有効にするフラグ	qt-format

参考

Qt QString::arg()

Qt 複数形式

Qt 複数形の書式指定文字列が原文と一致しない

複数形の書式指定文字列	There are %Ln apple(s)
有効にするフラグ	qt-plural-format

参考

Qt i18n guide

Ruby 形式

Ruby 書式指定文字列が原文と一致しない

単純な書式指定文字列	There are %d apples
書式指定文字列の位置	Your balance is %1$f %2$s
名前付きフォーマット文字列	Your balance is %+.2<amount>f %<currency>s
名前付きテンプレート文字列	Your balance is %{amount} %{currency}
有効にするフラグ	ruby-format

参考

Ruby Kernel#sprintf

Vue I18n 書式

Vue I18n 書式が原文と一致しない

名前付きフォーマット	There are {count} apples
Rails i18n 書式	There are %{count} apples
リンクされたロケール メッセージ	@:message.dio @:message.the_world!
有効にするフラグ	vue-format

参考

Vue I18n Formatting、 Vue I18n Linked locale messages

翻訳済み

この文字列は過去に翻訳されています

文字列がすでに翻訳されていることを意味します。これは、VCS で翻訳が復元された場合、または VCS 以外で翻訳が失われた場合に発生します。

一貫性の欠如

この原文の文字列は、このプロジェクト内で異なる翻訳が複数あるか、一部のコンポーネントには翻訳がありません。

Weblateは、プロジェクト内のすべての翻訳で同じ文字列の翻訳を検査し、一貫性のある翻訳を維持します。

プロジェクト内の 1 つの文字列の翻訳が異なる場合、検査で不合格となります。これにより、表示される検索に矛盾が生じることもあります。この文字列の他の翻訳は その他の出現箇所 タブにあります。

注釈

この検査は、文字列があるコンポーネントでは翻訳されていて、別のコンポーネントでは翻訳されていない場合にも発生します。これは、その他の出現箇所 タブの各行に表示される この翻訳を使う ボタンをクリックするだけで、一部のコンポーネントで翻訳されていない文字列を手動で処理する簡単な方法として使用できます。

自動翻訳 アドオンを使用して、別のコンポーネントですでに翻訳されている、新しく追加された文字列の翻訳を自動化できます。

参考

Keeping translations same across components

Kashida 文字の使用

装飾用の Kashida 文字は使用しないでください

バージョン 3.5 で追加.

Kashida の装飾文字は翻訳に使用しないでください。これは Tatweel とも呼ばれます。

参考

Kashida Wikipedia 参照

Markdown のリンク

マークダウン リンクは原文と一致しない

バージョン 3.5 で追加.

マークダウン リンクが原文と一致しません。

参考

Markdown links

Markdown の参照

マークダウン リンクの参照が原文と一致しない

バージョン 3.5 で追加.

マークダウン リンクの参照が原文と一致しません。

参考

Markdown links

Markdown 構文

マークダウンの構文が原文と一致しない

バージョン 3.5 で追加.

Markdown 構文が原文と一致しません

参考

Markdown span elements

翻訳文の最大長

翻訳は、指定された長さを超えてはならない

翻訳が使用可能なスペースに収まる長さか検査します。これは、翻訳文字の長さのみの検査です。

他の検査とは違い、フラグは max-length:100 のような key:value ペアとして設定する必要があります。

ヒント

この検査では文字数を確認するので、プロポーショナル フォントを使用してテキストを表示する場合は適さないかもしれません。翻訳の最大長 検査は、テキストの実際のレンダリング結果を検査します。

replacements: フラグは、文字列を検査する前にプレースホルダを展開する場合にも便利です。

翻訳の最大長

翻訳が表示変換されたテキストは、指定されたサイズを超えてはならない

バージョン 3.7 で追加.

表示変換されたテキストは、指定されたサイズを超えないようにしてください。行折り返しでテキストを表示変換し、指定した境界に収まるかどうかを確認します。

この検査には、最大幅と最大行数の 1 つまたは 2 つのパラメータが必要です。行数を指定しない場合は、1 行のテキストと判断されます。

使用するフォントは font-* ディレクティブ（参照 動作のカスタマイズ）で設定できます。たとえば次の設定の翻訳フラグは、ubuntu のフォント サイズ 22 を使ったテキストは 2 行 500 ピクセルに収める設定:

max-size:500:2, font-family:ubuntu, font-size:22

ヒント

Component configuration 内の font-* ディレクティブを設定して、コンポーネント内のすべての文字列に同じフォントを設定できます。文字列ごとにカスタマイズする必要がある場合に備えて、文字列ごとにこれらの値を上書きできます。

replacements: フラグは、文字列を検査する前にプレースホルダを展開する場合にも便利です。

参考

フォントの管理、動作のカスタマイズ、翻訳文の最大長

\n の不一致

\n の数が原文と一致しないもの

通常、エスケープされた改行はプログラムの出力をフォーマットする際に重要です。翻訳の \n リテラルの数が原文と一致しない場合、検査で不合格となります。

コロンの不一致

原文と翻訳の一方の末尾がコロンではない

原文から翻訳にコロンが複製されているか検査します。コロンの有無は、それが属していないさまざまな言語についても検査されます（中国語または日本語）。

参考

コロン Wikipedia 参照

省略記号の不一致

原文と翻訳の一方が省略記号で終わっていない

原文から翻訳に末尾の省略記号が複製されているか検査します。これは、3 つのドット (…) ではなく、実際の省略記号 (...) のみを検査します。

省略記号は、通常、印刷物の 3 つのドットよりも綺麗に表示変換され、テキスト読み上げの方が良く聞こえます。

参考

省略記号 Wikipedia 参照

感嘆符の不一致

原文と翻訳の一方が感嘆符で終わっていない

原文から翻訳に感嘆符が複製されているか検査します。感嘆符の有無は、感嘆符を持たないさまざまな言語についても検査されます（中国語、日本語、韓国語、アルメニア語、リンブ語、ミャンマー語、またはンコ語）。

参考

感嘆符 Wikipedia 参照

終止符の不一致

原文と翻訳の一方が終止符で終わっていない

原文から翻訳に終止符止が複製されているか検査します。終止符の有無は、その終止符が属していない複数の言語（中国語、日本語、デーヴァナーガリー文字またはウルドゥー語）について検査します。

参考

終止符 Wikipedia 参照

疑問符の不一致

原文と翻訳の一方が疑問符で終わっていない

原文から翻訳に疑問符が複製されているか検査します。疑問符の有無は、疑問符を持たない複数の言語（アルメニア語、アラビア語、中国語、韓国語、日本語、エチオピア語、ヴァイ語またはコプト語）についても検査します。

参考

疑問符 Wikipedia 参照

セミコロンの不一致

原文と翻訳の一方がセミコロンで終わってない

原文から翻訳に末尾のセミコロンが複製されているか検査します。これは、デスクトップ ファイルなどのエントリの書式を維持する場合に便利です。

参考

セミコロン Wikipedia 参照

改行数の不一致

翻訳の改行数が原文と一致しない

通常、改行はプログラムの出力をフォーマットするために重要です。翻訳の \n リテラルの数が原文と一致しない場合、検査で不合格となります。

複数形の不足

一部の複数形は翻訳されていない

原文のすべての複数形が翻訳されているか検査します。各複数形の使用方法の詳細については、文字列の定義で確認できます。

複数形を記入しないと、複数形が使用されているときに何も表示されない場合があります。

プレースホルダー

翻訳にはいくつかのプレースホルダーが足りない

バージョン 3.9 で追加.

バージョン 4.3 で変更: 正規表現をプレースホルダーとして使用できる。

一部のプレースホルダーが翻訳に欠けています。これらは翻訳ファイルから抽出されるか、placeholders フラグを使用して手動で定義します。フラグはコロンで区切り、スペースを含む文字列は引用符で囲んで使用します。

placeholders:$URL$:$TARGET$:"some long text"

プレースホルダに構文がある場合は、正規表現が使用できる：

placeholders:r"%[^% ]%"

参考

動作のカスタマイズ

句読点のスペース

句読点記号の前にノーブレークスペースがない

バージョン 3.9 で追加.

句読点記号（感嘆符、疑問符、セミコロン、コロン）の前に改行できないスペースがあるか検査します。このルールは、フランス語やブルトン語などの、句読点記号の前のスペースはタイポグラフィの規則に準じる一部の言語でのみ使用されます。

参考

フランス語と英語における 文の間隔の歴史 Wikipedia 参照

正規表現

翻訳は正規表現に一致しない

バージョン 3.9 で追加.

翻訳は正規表現に一致しません。式は、翻訳ファイルから抽出するか、regex フラグを使用して手動で定義します。

regex:^foo|bar$

同一の複数形

一部の複数形は同じ方法で翻訳する

翻訳の中で複数形が重複している場合は、不合格となるか検査します。ほとんどの言語では、複数形は異なっている必要があります。

文頭の改行

原文と翻訳の一方が改行で開始していない

改行は通常、適切な理由で原文内に表示されます。翻訳されたテキストを使用する場合は、省略や追加によってフォーマットが崩れることがあります。

参考

文末の改行

先頭の空白

原文と翻訳の先頭のスペースの数が異なる

文字列の先頭にあるスペースは、通常、インターフェイスのインデントに使用されるため、維持することが重要です。

文末の改行

原文と翻訳の文末の改行が一致しない

改行は通常、適切な理由で原文内に表示されます。翻訳されたテキストを使用する場合は、省略や追加によってフォーマットが崩れることがあります。

参考

文頭の改行

文末の空白

原文と翻訳の文末のスペースが一致しない

原文から翻訳に末尾のスペースが複製されているか検査します。

末尾のスペースは、通常、隣接する要素をスペースに入れるため、削除するとレイアウトが壊れることがあります。

未翻訳の翻訳文

原文と翻訳は同一です

原文と対応する翻訳文字列が、複数の形式の少なくとも 1 つまで同一である場合に発生します。すべての言語に共通する一部の文字列は無視され、さまざまなマークアップが除去されます。これにより、誤検出の数が減ります。

この検査は、誤って翻訳されていない文字列を見つけるのに便利です。

この検査のデフォルトの動作では、内蔵したブラックリストから単語を検査対象から除外します。これは頻繁に翻訳されない単語です。これは、複数の言語で同じ 1 つの単語だけで構成される短い文字列での誤検出を避けるために便利です。このブラックリストを無効にするには、文字列またはコンポーネントに strict-same フラグを追加します。

参考

Component configuration、動作のカスタマイズ

安全でない HTML

翻訳には安全でない HTML マークアップが含まれている

バージョン 3.9 で追加.

翻訳には、安全でない HTML マークアップが含まれています。この検査は safe-html フラグ（参照 動作のカスタマイズ）を使用して有効にしなければなりません。マークアップを自動的にサニタイズできる autofixer も付属しています。

参考

HTML の検査は、Mozilla が開発した Bleach library によって行われます。

URL

翻訳に URL が含まれていない

バージョン 3.5 で追加.

翻訳に URL が含まれていません。これは、ユニットが URL を含むとマークされている場合にのみトリガーされます。その場合、翻訳は有効な URL である必要があります。

XML マークアップ

翻訳内の XML が原文と一致しない

これは通常、出力結果が異なることを意味します。ほとんどの場合、これは翻訳の変更による望ましい結果ではありませんが、場合によっては変更されることもあります。

原文から翻訳に XML タグが複製されているか検査します。

XML 構文

翻訳は有効な XML ではない

バージョン 2.8 で追加.

XML マークアップは無効です。

ゼロ幅スペース

翻訳には余分なゼロ幅のスペース文字が含まれている

単語内でのメッセージの改行（ワードラッピング）には、半角スペース（<U+200B>）文字を使用します。

通常は誤って挿入するため、この検査は翻訳中に検出した時点で警告します。この文字を使用すると、一部のプログラムで問題が発生することがあります。

参考

ゼロ幅スペース Wikipedia 参照

原文検査

原文検査は、開発者が原文の品質を向上させるため便利です。

省略記号

文字列では、省略記号 (…) の代わりに 3 つのドット (...) が使われています

これは、文字列で省略記号 (...) を使用すべきところで、3 つのドット (…) を使用すると不合格となります。

ほとんどの場合、Unicode 文字を使用する方が適切で表示変換の見栄えがよく、音声合成を使用した方が適切に聞こえるかもしれません。

参考

省略記号 Wikipedia 参照

長期間未翻訳

長期間、未翻訳のまま放置されていた文字列

バージョン 4.1 で追加.

文字列が長期間未翻訳のまま放置されていた場合は、原文に問題があり、翻訳が困難になっていることがあります。

複数の検査で不合格

複数の言語の翻訳は、検査で不合格となっている

この文字列の翻訳の多くは、品質検査で不合格となっています。これは通常、原文を改善する方法が何かあるという意味です。

この検査の不合格は、文字列の末端の終止符の欠落、または翻訳者が翻訳で修正する傾向がある同様のささいな問題によって引き起こされることが多いが、原文で修正することをお勧めします。

複数の無名変数

文字列には複数の無名の変数があり、翻訳者がそれらを並べ替えることはできない

バージョン 4.1 で追加.

文字列内に複数の名前のない変数があるため、翻訳者がそれらを並べ替えることはできません。

代わりに名前付き変数を使用して、翻訳者が変数の順序を変更できるように検討してください。

複数形の除外

文字列を複数形として解釈するが、複数形のつづりは使用しない

文字列を複数形として解釈するが、複数形のつづりは使用しない。翻訳システムがこれをサポートしている場合は、複数形を認識するつづりを使用する必要があります。

Python を使用した Gettext の例：

from gettext import ngettext

print ngettext("Selected %d file", "Selected %d files", files) % files

検索

バージョン 3.9 で追加.

ブール演算、かっこ、またはフィールド固有のルックアップを使用した高度なクエリを使用して、必要な文字列を検索できます。

フィールドが定義されていない場合は、原文、翻訳文 および コンテキスト フィールドで検索されます。

単純な検索

検索ボックスに入力した語句はすべて単語に分割されます。分割した単語のいずれかを含む文字列が表示されます。正確な語句を探すには、引用符（一重引用符 (') と二重引用符 (") の両方を使用できる）に「検索語句」を入れます: "this is a quoted string" または 'another quoted string'。

検索方法

source:TEXT

原文の大文字と小文字を区別しない検索。

target:TEXT

対象文字列の大文字と小文字を区別しない検索。

context:TEXT

コンテキスト文字列の大文字と小文字を区別しない検索。

key:TEXT

キー文字列の大文字と小文字を区別しない検索。

note:TEXT

コメント文字列の大文字と小文字を区別しない検索。

location:TEXT

ロケーション文字列の大文字と小文字を区別しない検索。

priority:NUMBER

文字列の優先順位。

added:DATETIME

文字列が Weblate に追加されたときのタイムスタンプ。

state:TEXT

状態検索（approved、translated、needs-editing、empty、read-only）、rts フィールド演算子 対応。

pending:BOOLEAN

VCS へのフラッシュのために保留中の文字列。

has:TEXT

属性を持つ文字列の検索 - plural、context、suggestion、comment、check、dismissed-check、translation、variant、``screenshot``（原文でのみ有効）。

is:TEXT

文字列の状態の検索（pending、translated、untranslated）。

language:TEXT

翻訳対象の言語。

component:TEXT

コンポーネントのスラッグ、参照 Component slug。

project:TEXT

プロジェクトのスラッグ、参照 Project slug。

changed_by:TEXT

文字列は、ユーザー名を設定している翻訳者に変更された。

changed:DATETIME

文字列の内容が変更された日付、フィールド演算子 に対応。

change_time:DATEIME

String was changed on date, supports フィールド演算子, unlike changed this includes event which don't change content and you can apply custom action filtering using change_action.

change_action:TEXT

Filters on change action, useful together with change_time. Accepts English name of the change action, either quoted and with spaces or lowercase and spaces replaced by dash. See 変更の検索 for examples.

check:TEXT

検査に不合格となった文字列。

dismissed_check:TEXT

検査を除外した文字列。

comment:TEXT

ユーザー コメントの検索。

comment_author:TEXT

コメントした翻訳者でフィルターをかける。

suggestion:TEXT

提案の検索。

suggestion_author:TEXT

提案した翻訳者でフィルターをかける。

ブール演算子

「AND」、「OR」、「NOT」、および括弧を使用して検索を組み合わせると、複雑なクエリを作成できます。たとえば: state:translated AND (source:hello OR source:bar)

フィールド演算子

日付または数値検索の演算子、範囲または部分参照を指定できる:

state:>=translated

状態は translated か、それ以上の（approved）。

changed:2019

2019 年に変更。

changed:[2019-03-01 to 2019-04-01]

開始日と終了日の期間内の変更。

正確な演算子

= 演算子を使用すると、異なる文字列フィールドに対して完全一致クエリを実行できます。たとえば、hello world に完全に一致するすべての原文を検索するには、source:="hello world" を使用します。単一の単語式を検索する場合は、引用符を省略できます。たとえば、hello に一致するすべての原文を検索するには、source:=hello と入力します。

変更の検索

バージョン 4.4 で追加.

Searching for history events can be done using change_action and change_time operators.

For example, searching for strings marked for edit in 2018 can be entered as change_time:2018 AND change_action:marked-for-edit or change_time:2018 AND change_action:"Marked for edit".

正規表現

テキストを入力できる場合は、r"regexp" として正規表現を指定できます。

たとえば、2 ~ 5 の数字を含むすべての原文を検索するには、source:r"[2-5]" と記述します。

定義済みのクエリ

検索ページで事前に定義されたクエリーから選択すると、最も頻繁に実行する検索にすばやくアクセスできます。

結果の並び替え

必要に応じて文字列を並べ替えるには、多くの選択肢があります。

翻訳ワークフロー

Weblate を使用すると、翻訳者との距離を近づけ、ユーザーとの距離を縮めます。機能をどこまで利用するかはあなた次第です。

以下の項目は、Weblate の完璧な設定方法ではありません。記載している最も一般的な例をもとに、他のワークフローを作成できます。

翻訳にアクセス

アクセス制御 は、各アクセス制御のオプションを、どのワークフローにも適用できるため、ワークフローではあまり説明していません。翻訳へのアクセスを管理する方法については、ドキュメントを参照してください。

以降の章では、すべてのユーザー とは翻訳にアクセスできるユーザーのことです。プロジェクトを公開している場合は認証済みのユーザー、または 翻訳 権限を持つユーザーを指定できます。

Translation states

翻訳した各文字列は、次のいずれかの状態になります。

未翻訳

翻訳は空です、保存するかしないかはファイル形式によります。

要編集

編集が必要な翻訳です。通常、原文の変更があれば設定されます。翻訳はファイルに保存されますが、ファイル形式によっては、編集が必要と設定されることがあります（たとえば、Gettext ファイルであいまいフラグを取得した場合）。

査読待ち

翻訳はできますが、査読はされません。有効な翻訳としてファイルに保存されます。

承認済み

査読で翻訳が承認されました。翻訳者は変更できませんが、査読の担当者のみが変更できます。翻訳者は提案の追加しかできません。

提案

提案は Weblate にのみ保存され、翻訳ファイルには保存されません。

直接翻訳

これは、小規模なチームのための最も一般的な設定であり、誰でも直接翻訳できます。これは Weblate のデフォルトの設定です。

• すべてのユーザー が翻訳できます。

• 提案とは、翻訳者が変更に確信を持てない場合に、変更を提案する選択方法です。

設定	Value	備考
査読の有効化	off	プロジェクト レベルで設定済み。
提案の有効化	on	ユーザーが確信が持てない場合に提案できると便利。
提案への投票	off
提案の自動採用	0
翻訳者グループ	ユーザー	または アクセス制御 で 翻訳 。
査読者グループ	該当なし	未使用。

相互評価

このワークフローを使用すると、すべてのユーザーが提案を追加でき、翻訳の承認には認証ユーザーの承認が必要です。

• すべてのユーザー が提案を追加できる。

• すべてのユーザー が提案に投票できる。

• 事前設定の票数に達すると、提案は翻訳に置き換わる。

設定	Value	備考
査読の有効化	off	プロジェクト レベルで設定済み。
提案の有効化	on
提案への投票	off
提案の自動採用	1	より多くの相互評価を必要とする高い値を設定できます。
翻訳者グループ	ユーザー	または アクセス制御 で 翻訳 。
査読者グループ	該当なし	未使用、すべての翻訳者が査読できる。

専任の査読者

バージョン 2.18 で追加: 適切な査読ワークフローは Weblate 2.18 から対応。

専用の査読者には、2 つのユーザー グループがあります、1 つは翻訳を保存できて、もう 1 つは翻訳の一貫性と品質が良好かを確認するために査読できます。

• すべてのユーザー は、未承認の翻訳を編集できる。

• 査読者 は、文字列の承認/非承認ができる。

• 査読者 は、すべての翻訳（承認済みを含む）を編集できる。

• 提案は、承認済み文字列の変更の提案もできる。

設定	Value	備考
査読の有効化	on	プロジェクト レベルで設定済み。
提案の有効化	off	ユーザーが確信が持てない場合に提案できると便利。
提案への投票	off
提案の自動採用	0
翻訳者グループ	ユーザー	または アクセス制御 で 翻訳 。
査読者グループ	査読者	または、アクセス制御 して 査読 する。

査読の有効化

査読は、プロジェクトの設定で有効にできます、場所はプロジェクトの設定の ワークフロー サブページ（ 管理 → 設定 メニューにある）:

注釈

Weblate の設定によっては、設定を使用できないことがあります。たとえば、Hosted Weblate では、無料でホストするプロジェクトでは使用できません。

原文の品質ゲートウェイ

多くの場合、開発者がコードを作成して初期の文字列を提供するため、開発者からオリジナルの原文が提供されます。しかし、開発者は原文を母国語としていないことが多く、原文に求められる品質を提供できません。中間翻訳は、この問題の解決に役立ちます - 開発者と翻訳者とユーザーとの間に、追加の文字列用の品質ゲートウェイがあります。

中間言語ファイル を設定すると、このファイルは文字列の原文として使用しますが、原文の言語で磨いて編集します。文字列が原文言語で用意されると、翻訳者は他の言語に翻訳できます。

参考

中間言語ファイル、単一言語のベース言語ファイル、Bilingual and monolingual formats

原文の査読

原文の査読の有効化 を有効にすると、査読の処理を原文に適用できます。有効にすると、ユーザーは原文の問題を報告できます。 実際の処理は、バイリンガル形式と単一言語形式のどちらを使用するかで変わります。

単一言語形式の場合、原文の査読は 専任の査読者 と同じように動作します - 原文で問題が報告されると、Needs editing が設定される。

バイリンガル形式では、原文を直接編集できません（通常はソース コードから直接抽出します)。この場合、 翻訳者から報告された文字列には 査読が必要な原文 というラベルが付きます。この文字列を確認して、ソースで編集するか、ラベルを削除するかの処理が必要です。

参考

Bilingual and monolingual formats、専任の査読者、String labels

Frequently Asked Questions

設定

自動化したワークフローを作成する方法は？

Weblate は翻訳に関するすべての作業を半自動的に処理できます。あなたのリポジトリへのプッシュ権限を与えれば、マージの競合が発生しない限り、操作なしで翻訳が反映されます。

1. 変更があれば Weblate に通知するように Git リポジトリを設定します、方法は 通知フック を参照してください。

2. Weblate の Component configuration でプッシュ URL を設定します。これにより、Weblate は変更をリポジトリにプッシュできます。

3. Weblate の Project configuration で push-on-commit を有効にすると、Weblate で変更が行われるたびに Weblate のプッシュがリポジトリに反映されます。

参考

Web サービスを連携して翻訳、Avoiding merge conflicts

SSH 経由でリポジトリに接続する方法は？

SSH 鍵の設定については、リポジトリへの接続 を参照してください。

翻訳のマージの競合を修正する方法は？

マージの競合は、Weblate と upstream リポジトリの両方で翻訳ファイルが同時に変更されたとき、たまに発生します。通常、翻訳ファイルに変更を加える前に（msgmerge を実行する前）Weblate 翻訳をマージすることで、これを回避できます。Weblate に、保留中の翻訳をすべてコミットして（管理 メニューの リポジトリのメンテナンス から操作）、リポジトリをマージするように指示するだけです（自動プッシュが無効のとき）。

マージの競合が既に発生している場合、最も簡単な方法は、ワークステーションのローカルですべての競合を解決することです - Weblate をリモート リポジトリとして追加し、それを upstream にマージして、競合を修正するだけです。変更をプッシュ バックすると、Weblate はそのままでマージされたバージョンを使用できます。

注釈

設定によっては、Weblate リポジトリへの接続に認証が必要な場合があります。Weblate に組み込まれている Git exporter を使用すると、ユーザー名と API キーで認証されます。

# Commit all pending changes in Weblate, you can do this in the UI as well:
wlc commit
# Lock the translation in Weblate, again this can be done in the UI as well:
wlc lock
# Add Weblate as remote:
git remote add weblate https://hosted.weblate.org/git/project/component/
# You might need to include credentials in some cases:
git remote add weblate https://username:APIKEY@hosted.weblate.org/git/project/component/

# Update weblate remote:
git remote update weblate

# Merge Weblate changes:
git merge weblate/master

# Resolve conflicts:
edit …
git add …
…
git commit

# Push changes to upstream repository, Weblate will fetch merge from there:
git push

# Open Weblate for translation:
wlc unlock

Weblate で複数のブランチを使っている場合は、すべてのブランチに対して同じことができます。

# Add and update Weblate remotes
git remote add weblate-one https://hosted.weblate.org/git/project/one/
git remote add weblate-second https://hosted.weblate.org/git/project/second/
git remote update weblate-one weblate-second

# Merge QA_4_7 branch:
git checkout QA_4_7
git merge weblate-one/QA_4_7
... # Resolve conflicts
git commit

# Merge master branch:
git checkout master
git merge weblates-second/master
... # Resolve conflicts
git commit

# Push changes to the upstream repository, Weblate will fetch the merge from there:
git push

gettext PO ファイルの場合は、競合を半自動でマージする方法があります。

Weblate Git リポジトリのローカル クローンを取得して保持します。また、upstream の Git リポジトリの新しいローカル クローンも取得します（つまり、upstream の Git リポジトリのコピーが 2 つ必要：　完全なコピーと作業用コピー）：

# Add remote:
git remote add weblate /path/to/weblate/snapshot/

# Update Weblate remote:
git remote update weblate

# Merge Weblate changes:
git merge weblate/master

# Resolve conflicts in the PO files:
for PO in `find . -name '*.po'` ; do
    msgcat --use-first /path/to/weblate/snapshot/$PO\
               /path/to/upstream/snapshot/$PO -o $PO.merge
    msgmerge --previous --lang=${PO%.po} $PO.merge domain.pot -o $PO
    rm $PO.merge
    git add $PO
done
git commit

# Push changes to the upstream repository, Weblate will fetch merge from there:
git push

参考

How to export the Git repository that Weblate uses?、Web サービスを連携して翻訳、Avoiding merge conflicts

複数のブランチを一度に翻訳する方法は？

Weblate supports pushing translation changes within one Project configuration. For every Component configuration which has it turned on (the default behavior), the change made is automatically propagated to others. This way translations are kept synchronized even if the branches themselves have already diverged quite a lot, and it is not possible to simply merge translation changes between them.

Once you merge changes from Weblate, you might have to merge these branches (depending on your development workflow) discarding differences:

git merge -s ours origin/maintenance

参考

Keeping translations same across components

How to translate multi-platform projects?

Weblate supports a wide range of file formats (see Supported file formats) and the easiest approach is to use the native format for each platform.

Once you have added all platform translation files as components in one project (see Adding translation projects and components), you can utilize the translation propagation feature (turned on by default, and can be turned off in the Component configuration) to translate strings for all platforms at once.

参考

Keeping translations same across components

How to export the Git repository that Weblate uses?

There is nothing special about the repository, it lives under the DATA_DIR directory and is named vcs/<project>/<component>/. If you have SSH access to this machine, you can use the repository directly.

For anonymous access, you might want to run a Git server and let it serve the repository to the outside world.

Alternatively, you can use Git exporter inside Weblate to automate this.

What are the options for pushing changes back upstream?

This heavily depends on your setup, Weblate is quite flexible in this area. Here are examples of some workflows used with Weblate:

• Weblate automatically pushes and merges changes (see 自動化したワークフローを作成する方法は？).

• You manually tell Weblate to push (it needs push access to the upstream repository).

• Somebody manually merges changes from the Weblate git repository into the upstream repository.

• Somebody rewrites history produced by Weblate (e.g. by eliminating merge commits), merges changes, and tells Weblate to reset the content in the upstream repository.

Of course you are free to mix all of these as you wish.

How can I limit Weblate access to only translations, without exposing source code to it?

You can use git submodule for separating translations from source code while still having them under version control.

1. Create a repository with your translation files.

2. Add this as a submodule to your code:

   git submodule add git@example.com:project-translations.git path/to/translations
   

3. Link Weblate to this repository, it no longer needs access to the repository containing your source code.

4. You can update the main repository with translations from Weblate by:

   git submodule update --remote path/to/translations
   

Please consult the git submodule documentation for more details.

How can I check whether my Weblate is set up properly?

Weblate includes a set of configuration checks which you can see in the admin interface, just follow the Performance report link in the admin interface, or open the /manage/performance/ URL directly.

Why are all commits committed by Weblate <noreply@weblate.org>?

This is the default committer name, configured when you create a translation component. You can change it in the administration at any time.

The author of every commit (if the underlying VCS supports it) is still recorded correctly as the user that made the translation.

参考

Component configuration

Usage

How do I review the translations of others?

• You can subscribe to any changes made in 通知 and then check others contributions as they come in by e-mail.

• There is a review tool available at the bottom of the translation view, where you can choose to browse translations made by others since a given date.

How do I provide feedback on a source string?

On context tabs below translation, you can use the Comments tab to provide feedback on a source string, or discuss it with other translators.

参考

原文のフィードバックの受信、コメント

How can I use existing translations while translating?

• Use the import functionality to load compendium as translations, suggestions or translations needing review. This is the best approach for a one-time translation using a compendium or a similar translation database.

• You can set up tmserver with all databases you have and let Weblate use it. This is good when you want to use it several times during translation.

• Another option is to translate all related projects in a single Weblate instance, which will make it automatically pick up translations from other projects as well.

参考

機械翻訳、自動提案

Does Weblate update translation files besides translations?

Weblate tries to limit changes in translation files to a minimum. For some file formats it might unfortunately lead to reformatting the file. If you want to keep the file formatted your way, please use a pre-commit hook for that.

For monolingual files (see Supported file formats) Weblate might add new translation strings not present in the template, 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 an appropriate addon 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 or using an addon.

参考

Processing repository with scripts, 翻訳ファイルのクリーンアップ, 空白文字列の削除, RESX ファイルの更新, POT に一致する PO ファイルの更新 (msgmerge)

Where do language definitions come from and how can I add my own?

The basic set of language definitions is included within Weblate and Translate-toolkit. This covers more than 150 languages and includes info about plural forms or text direction.

You are free to define your own languages in the administrative interface, you just need to provide info about it.

Can Weblate highlight changes in a fuzzy string?

Weblate supports this, however it needs the data to show the difference.

For Gettext PO files, you have to pass the parameter --previous to msgmerge when updating PO files, for example:

msgmerge --previous -U po/cs.po po/phpmyadmin.pot

For monolingual translations, Weblate can find the previous string by ID, so it shows the differences automatically.

Why does Weblate still show old translation strings when I've updated the template?

Weblate does not try to manipulate the translation files in any way other than allowing translators to translate. So it also does not update the translatable files when the template or source code have been changed. You simply have to do this manually and push changes to the repository, Weblate will then pick up the changes automatically.

注釈

It is usually a good idea to merge changes done in Weblate before updating translation files, as otherwise you will usually end up with some conflicts to merge.

For example with gettext PO files, you can update the translation files using the msgmerge tool:

msgmerge -U locale/cs/LC_MESSAGES/django.mo locale/django.pot

In case you want to do the update automatically, you can install addon POT に一致する PO ファイルの更新 (msgmerge).

Troubleshooting

Requests sometimes fail with "too many open files" error

This happens sometimes when your Git repository grows too much and you have many of them. Compressing the Git repositories will improve this situation.

The easiest way to do this is to run:

# Go to DATA_DIR directory
cd data/vcs
# Compress all Git repositories
for d in */* ; do
    pushd $d
    git gc
    popd
done

参考

DATA_DIR

When accessing the site I get a "Bad Request (400)" error

This is most likely caused by an improperly configured ALLOWED_HOSTS. It needs to contain all hostnames you want to access on your Weblate. For example:

ALLOWED_HOSTS = ["weblate.example.com", "weblate", "localhost"]

参考

Allowed hosts setup

What does mean "There are more files for the single language (en)"?

This typically happens when you have translation file for source language. Weblate keeps track of source strings and reserves source language for this. The additional file for same language is not processed.

• 原文の言語への翻訳が必要な場合は、コンポーネント設定の 原文の言語 を変更してください。

• 翻訳元言語の翻訳ファイルが不必要な場合は、リポジトリから削除してください。

• 翻訳元言語用の翻訳ファイルが必要だが、Weblate で無効にする場合は、言語フィルタ で除外を設定してしてください。

機能

Does Weblate support other VCSes than Git and Mercurial?

Weblate currently does not have native support for anything other than Git (with extended support for GitHub, Gerrit and Subversion) and Mercurial, but it is possible to write backends for other VCSes.

You can also use Git リモート ヘルパー in Git to access other VCSes.

Weblate also supports VCS less operation, see ローカル ファイル.

注釈

For native support of other VCSes, Weblate requires using distributed VCS, and could probably be adjusted to work with anything other than Git and Mercurial, but somebody has to implement this support.

参考

バージョン管理の統合

How does Weblate credit translators?

Every change made in Weblate is committed into VCS under the translators name. This way every single change has proper authorship, and you can track it down using the standard VCS tools you use for code.

Additionally, when the translation file format supports it, the file headers are updated to include the translator's name.

参考

list_translators、翻訳の進捗状況レポート

Why does Weblate force showing all PO files in a single tree?

Weblate was designed in a way that every PO file is represented as a single component. This is beneficial for translators, so they know what they are actually translating. If you feel your project should be translated as one, consider merging these po files. It will make life easier even for translators not using Weblate.

注釈

In case there is great demand for this feature, it might be implemented in future versions.

Why does Weblate use language codes such sr_Latn or zh_Hant?

These are language codes defined by RFC 4646 to better indicate that they are really different languages instead previously wrongly used modifiers (for @latin variants) or country codes (for Chinese).

Weblate still understands legacy language codes and will map them to current one - for example sr@latin will be handled as sr_Latn or zh@CN as zh_Hans.

Supported file formats

Weblate supports most translation format understood by translate-toolkit, however each format being slightly different, some issues with formats that are not well tested can arise.

参考

Translation Related File Formats

注釈

When choosing a file format for your application, it's better to stick some well established format in the toolkit/platform you use. This way your translators can additionally use whatever tools they are used to, and will more likely contribute to your project.

Bilingual and monolingual formats

Both monolingual and bilingual formats are supported. Bilingual formats store two languages in single file—source and translation (typical examples are GNU gettext, XLIFF or Apple iOS strings). On the other side, monolingual formats identify the string by ID, and each language file contains only the mapping of those to any given language (typically Android string resources). Some file formats are used in both variants, see the detailed description below.

For correct use of monolingual files, Weblate requires access to a file containing complete list of strings to translate with their source—this file is called 単一言語のベース言語ファイル within Weblate, though the naming might vary in your paradigm.

Additionally this workflow can be extended by utilizing 中間言語ファイル to include strings provided by developers, but not to be used as is in the final strings.

自動検出

Weblate can automatically detect several widespread file formats, but this detection can harm your performance and will limit features specific to given file format (for example automatic addition of new translations).

Translation types capabilities

Capabilities of all supported formats:

Format	Linguality 1	Plurals 2	Comments 3	Context 4	Location 5	Flags 8	Additional states 6
GNU gettext	bilingual	yes	yes	yes	yes	yes 9	needs editing
Monolingual gettext	mono	yes	yes	yes	yes	yes 9	needs editing
XLIFF	both	yes	yes	yes	yes	yes 10	needs editing, approved
Java properties	both	no	yes	no	no	no
GWT properties	mono	yes	yes	no	no	no
Joomla translations	mono	no	yes	no	yes	no
Qt Linguist .ts	both	yes	yes	no	yes	yes 10	needs editing
Android string resources	mono	yes	yes 7	no	no	yes 10
Apple iOS strings	bilingual	no	yes	no	no	no
PHP 文字列	mono	no 11	yes	no	no	no
JSON files	mono	no	no	no	no	no
JSON i18next files	mono	yes	no	no	no	no
go-i18n JSON files	mono	yes	no	no	no	no
ARB File	mono	yes	yes	no	no	no
WebExtension JSON	mono	yes	yes	no	no	no
.XML resource files	mono	no	yes	no	no	yes 10
CSV files	both	no	yes	yes	yes	no	needs editing
YAML files	mono	no	yes	no	no	no
Ruby YAML files	mono	yes	yes	no	no	no
DTD files	mono	no	no	no	no	no
Flat XML	mono	no	no	no	no	yes 10
Windows RC files	mono	no	yes	no	no	no
Excel Open XML	mono	no	yes	yes	yes	no	needs editing
アプリ ストア メタデータ ファイル	mono	no	no	no	no	no
Subtitle files	mono	no	no	no	yes	no
HTML files	mono	no	no	no	no	no
OpenDocument Format	mono	no	no	no	no	no
IDML Format	mono	no	no	no	no	no
INI translations	mono	no	no	no	no	no
Inno Setup INI の翻訳	mono	no	no	no	no	no

1

See Bilingual and monolingual formats

2

Plurals are necessary to properly localize strings with variable count.

3

Comments can be used to pass additional info about the string to translate.

4

Context is used to differentiate identical strings used in different scopes (for example Sun can be used as an abbreviated name of the day "Sunday" or as the name of our closest star).

5

Location of a string in source code might help proficient translators figure out how the string is used.

6

Additional states supported by the file format in addition to "Not translated" and "Translated".

7

XML comment placed before the <string> element, parsed as a developer comment.

8

See 動作のカスタマイズ

9(1,2)

The gettext type comments are used as flags.

10(1,2,3,4,5)

The flags are extracted from the non-standard attribute weblate-flags for all XML based formats. Additionally max-length:N is supported through the maxwidth attribute as defined in the XLIFF standard, see Specifying translation flags.

11

The plurals are supported only for Laravel which uses in string syntax to define them, see Localization in Laravel.

GNU gettext

libre ソフトウェアの翻訳に最も広く使用されているフォーマット。

Contextual info stored in the file is supported by adjusting its headers or linking to corresponding source files.

The bilingual gettext PO file typically looks like this:

#: weblate/media/js/bootstrap-datepicker.js:1421
msgid "Monday"
msgstr "Pondělí"

#: weblate/media/js/bootstrap-datepicker.js:1421
msgid "Tuesday"
msgstr "Úterý"

#: weblate/accounts/avatar.py:163
msgctxt "No known user"
msgid "None"
msgstr "Žádný"

Typical Weblate Component configuration
ファイルマスク	po/*.po
単一言語のベース言語ファイル	Empty
新しい翻訳のテンプレート	po/messages.pot
ファイル形式	Gettext PO file

参考

Translating software using GNU Gettext、Translating documentation using Sphinx、Gettext Wikipedia 参照 、PO Files、configure ファイルの ALL_LINGUAS 変数の更新、gettext 出力のカスタマイズ、LINGUAS ファイルの更新、MO ファイルの生成、POT に一致する PO ファイルの更新 (msgmerge)

Monolingual gettext

Some projects decide to use gettext as monolingual formats—they code just the IDs in their source code and the string then needs to be translated to all languages, including English. This is supported, though you have to choose this file format explicitly when importing components into Weblate.

The monolingual gettext PO file typically looks like this:

#: weblate/media/js/bootstrap-datepicker.js:1421
msgid "day-monday"
msgstr "Pondělí"

#: weblate/media/js/bootstrap-datepicker.js:1421
msgid "day-tuesday"
msgstr "Úterý"

#: weblate/accounts/avatar.py:163
msgid "none-user"
msgstr "Žádný"

While the base language file will be:

#: weblate/media/js/bootstrap-datepicker.js:1421
msgid "day-monday"
msgstr "Monday"

#: weblate/media/js/bootstrap-datepicker.js:1421
msgid "day-tuesday"
msgstr "Tuesday"

#: weblate/accounts/avatar.py:163
msgid "none-user"
msgstr "None"

Typical Weblate Component configuration
ファイルマスク	po/*.po
単一言語のベース言語ファイル	po/en.po
新しい翻訳のテンプレート	po/messages.pot
ファイル形式	Gettext PO file (monolingual)

XLIFF

XML-based format created to standardize translation files, but in the end it is one of many standards, in this area.

XML Localization Interchange File Format (XLIFF) is usually used as bilingual, but Weblate supports it as monolingual as well.

参考

XML Localization Interchange File Format (XLIFF) specification

Translation states

バージョン 3.3 で変更: Weblate ignored the state attribute prior to the 3.3 release.

The state attribute in the file is partially processed and mapped to the "Needs edit" state in Weblate (the following states are used to flag the string as needing edit if there is a target present: new, needs-translation, needs-adaptation, needs-l10n). Should the state attribute be missing, a string is considered translated as soon as a <target> element exists.

If the translation string has approved="yes", it will also be imported into Weblate as "Approved", anything else will be imported as "Waiting for review" (which matches the XLIFF specification).

While saving, Weblate doesn't add those attributes unless necessary:

• The state attribute is only added in case string is marked as needing edit.

• The approved attribute is only added in case string has been reviewed.

• In other cases the attributes are not added, but they are updated in case they are present.

That means that when using the XLIFF format, it is strongly recommended to turn on the Weblate review process, in order to see and change the approved state of strings.

See 専任の査読者.

Similarly upon importing such files (in the upload form), you should choose Import as translated under Processing of strings needing edit.

Whitespace and newlines in XLIFF

Generally types or amounts of whitespace is not differentiated between in XML formats. If you want to keep it, you have to add the xml:space="preserve" flag to the string.

For example:

    <trans-unit id="10" approved="yes">
        <source xml:space="preserve">hello</source>
        <target xml:space="preserve">Hello, world!
</target>
    </trans-unit>

Specifying translation flags

You can specify additional translation flags (see 動作のカスタマイズ) by using the weblate-flags attribute. Weblate also understands maxwidth and font attributes from the XLIFF specification:

<trans-unit id="10" maxwidth="100" size-unit="pixel" font="ubuntu;22;bold">
   <source>Hello %s</source>
</trans-unit>
<trans-unit id="20" maxwidth="100" size-unit="char" weblate-flags="c-format">
   <source>Hello %s</source>
</trans-unit>

The font attribute is parsed for font family, size and weight, the above example shows all of that, though only font family is required. Any whitespace in the font family is converted to underscore, so Source Sans Pro becomes Source_Sans_Pro, please keep that in mind when naming the font group (see フォントの管理).

Unit keys or context

Weblate identifies the units in the XLIFF file by resname attribute in case it is present and falls back to id (together with file tag if present).

The resname attribute is supposed to be human friendly identifier of the unit making it more suitable for Weblate to display instead of id. The resname has to be unique in the whole XLIFF file. This is required by Weblate and is not covered by the XLIFF standard - it does not put any uniqueness restrictions on this attribute.

Typical Weblate Component configuration for bilingual XLIFF
ファイルマスク	localizations/*.xliff
単一言語のベース言語ファイル	Empty
新しい翻訳のテンプレート	localizations/en-US.xliff
ファイル形式	XLIFF Translation File

Typical Weblate Component configuration for monolingual XLIFF
File mask	localizations/*.xliff
単一言語のベース言語ファイル	localizations/en-US.xliff
新しい翻訳のテンプレート	localizations/en-US.xliff
ファイル形式	XLIFF Translation File

参考

XLIFF Wikipedia 参照 、XLIFF、font attribute in XLIFF 1.2 、maxwidth attribute in XLIFF 1.2

Java properties

Native Java format for translations.

Java properties are usually used as monolingual translations.

Weblate supports ISO-8859-1, UTF-8 and UTF-16 variants of this format. All of them support storing all Unicode characters, it is just differently encoded. In the ISO-8859-1, the Unicode escape sequences are used (for example zkou\u0161ka), all others encode characters directly either in UTF-8 or UTF-16.

注釈

Loading escape sequences works in UTF-8 mode as well, so please be careful choosing the correct encoding set to match your application needs.

Typical Weblate Component configuration
ファイルマスク	src/app/Bundle_*.properties
単一言語のベース言語ファイル	src/app/Bundle.properties
新しい翻訳のテンプレート	Empty
ファイル形式	Java Properties (ISO-8859-1)

参考

Java properties Wikipedia 参照 、Mozilla and Java properties files、Java プロパティ ファイルの整形、翻訳ファイルのクリーンアップ

GWT properties

Native GWT format for translations.

GWT properties are usually used as monolingual translations.

Typical Weblate Component configuration
ファイルマスク	src/app/Bundle_*.properties
単一言語のベース言語ファイル	src/app/Bundle.properties
新しい翻訳のテンプレート	Empty
ファイル形式	GWT Properties

参考

GWT localization guide Mozilla and Java properties files、Java プロパティ ファイルの整形、翻訳ファイルのクリーンアップ

INI translations

バージョン 4.1 で追加.

INI file format for translations.

INI translations are usually used as monolingual translations.

Typical Weblate Component configuration
ファイルマスク	language/*.ini
単一言語のベース言語ファイル	language/en.ini
新しい翻訳のテンプレート	Empty
ファイル形式	INI File

参考

INI Files、Joomla translations、Inno Setup INI の翻訳

Inno Setup INI の翻訳

バージョン 4.1 で追加.

翻訳用の Inno Setup INI ファイル形式。

Inno Setup INI の翻訳は、通常、単一言語の翻訳として使用されます。

注釈

The only notable difference to INI translations is in supporting %n and %t placeholders for line break and tab.

Typical Weblate Component configuration
ファイルマスク	language/*.islu
単一言語のベース言語ファイル	language/en.islu
新しい翻訳のテンプレート	Empty
ファイル形式	Inno Setup INI File

注釈

Only Unicode files (.islu) are currently supported, ANSI variant (.isl) is currently not supported.

参考

INI Files、Joomla translations、INI translations

Joomla translations

バージョン 2.12 で追加.

Native Joomla format for translations.

Joomla translations are usually used as monolingual translations.

Typical Weblate Component configuration
ファイルマスク	language/*/com_foobar.ini
単一言語のベース言語ファイル	language/en-GB/com_foobar.ini
新しい翻訳のテンプレート	Empty
ファイル形式	Joomla Language File

参考

Specification of Joomla language files 、Mozilla and Java properties files、INI translations、Inno Setup INI の翻訳

Qt Linguist .ts

Translation format used in Qt based applications.

Qt Linguist files are used as both bilingual and monolingual translations.

Typical Weblate Component configuration when using as bilingual
ファイルマスク	i18n/app.*.ts
単一言語のベース言語ファイル	Empty
新しい翻訳のテンプレート	i18n/app.de.ts
ファイル形式	Qt Linguist Translation File

Typical Weblate Component configuration when using as monolingual
ファイルマスク	i18n/app.*.ts
単一言語のベース言語ファイル	i18n/app.en.ts
新しい翻訳のテンプレート	i18n/app.en.ts
ファイル形式	Qt Linguist Translation File

参考

Qt Linguist manual 、Qt .ts、Bilingual and monolingual formats

Android string resources

Android specific file format for translating applications.

Android string resources are monolingual, the 単一言語のベース言語ファイル file is stored in a different location from the others res/values/strings.xml.

Typical Weblate Component configuration
ファイルマスク	res/values-*/strings.xml
単一言語のベース言語ファイル	res/values/strings.xml
新しい翻訳のテンプレート	Empty
ファイル形式	Android String Resource

参考

Android string resources documentation 、Android string resources

注釈

Android string-array structures are not currently supported. To work around this, you can break your string arrays apart:

<string-array name="several_strings">
    <item>First string</item>
    <item>Second string</item>
</string-array>

become:

<string-array name="several_strings">
    <item>@string/several_strings_0</item>
    <item>@string/several_strings_1</item>
</string-array>
<string name="several_strings_0">First string</string>
<string name="several_strings_1">Second string</string>

The string-array that points to the string elements should be stored in a different file, and not be made available for translation.

This script may help pre-process your existing strings.xml files and translations: https://gist.github.com/paour/11291062

Apple iOS strings

Apple specific file format for translating applications, used for both iOS and iPhone/iPad application translations.

Apple iOS strings are usually used as bilingual translations.

Typical Weblate Component configuration
ファイルマスク	Resources/*.lproj/Localizable.strings
単一言語のベース言語ファイル	Resources/en.lproj/Localizable.strings or Resources/Base.lproj/Localizable.strings
新しい翻訳のテンプレート	Empty
ファイル形式	iOS Strings (UTF-8)

参考

Apple "strings files" documentation 、Mac OSX strings

PHP 文字列

PHP translations are usually monolingual, so it is recommended to specify a base file with (what is most often the) English strings.

Example file:

<?php
$LANG['foo'] = 'bar';
$LANG['foo1'] = 'foo bar';
$LANG['foo2'] = 'foo bar baz';
$LANG['foo3'] = 'foo bar baz bag';

Typical Weblate Component configuration
ファイルマスク	lang/*/texts.php
単一言語のベース言語ファイル	lang/en/texts.php
新しい翻訳のテンプレート	lang/en/texts.php
ファイル形式	PHP strings

Laravel PHP 文字列

バージョン 4.1 で変更.

The Laravel PHP localization files are supported as well with plurals:

<?php
return [
    'welcome' => 'Welcome to our application',
    'apples' => 'There is one apple|There are many apples',
];

参考

PHP、Localization in Laravel

JSON files

バージョン 2.0 で追加.

バージョン 2.16 で変更: Since Weblate 2.16 and with translate-toolkit at-least 2.2.4, nested structure JSON files are supported as well.

バージョン 4.3 で変更: The structure of JSON file is properly preserved even for complex situations which were broken in prior releases.

JSON format is used mostly for translating applications implemented in JavaScript.

Weblate currently supports several variants of JSON translations:

• Simple key / value files, used for example by vue-i18n or react-intl.

• Files with nested keys.

• JSON i18next files

• go-i18n JSON files

• WebExtension JSON

• ARB File

JSON translations are usually monolingual, so it is recommended to specify a base file with (what is most often the) English strings.

Example file:

{
  "Hello, world!\n": "Ahoj světe!\n",
  "Orangutan has %d banana.\n": "",
  "Try Weblate at https://demo.weblate.org/!\n": "",
  "Thank you for using Weblate.": ""
}

Nested files are supported as well (see above for requirements), such a file can look like:

{
  "weblate": {
    "hello": "Ahoj světe!\n",
    "orangutan": "",
    "try": "",
    "thanks": ""
  }
}

ヒント

The JSON file and JSON nested structure file can both handle same type of files. The only difference between them is when adding new strings. The nested variant tries to parse the key and insert the new string into the matching structure.

Typical Weblate Component configuration
ファイルマスク	langs/translation-*.json
単一言語のベース言語ファイル	langs/translation-en.json
新しい翻訳のテンプレート	Empty
ファイル形式	JSON nested structure file

参考

JSON、JSON 出力形式のカスタマイズ、翻訳ファイルのクリーンアップ,

JSON i18next files

バージョン 2.17 で変更: Since Weblate 2.17 and with translate-toolkit at-least 2.2.5, i18next JSON files with plurals are supported as well.

i18next is an internationalization framework written in and for JavaScript. Weblate supports its localization files with features such as plurals.

i18next translations are monolingual, so it is recommended to specify a base file with (what is most often the) English strings.

注釈

Weblate supports the i18next JSON v3 format. The v2 and v1 variants are mostly compatible, with exception of how plurals are handled.

Example file:

{
  "hello": "Hello",
  "apple": "I have an apple",
  "apple_plural": "I have {{count}} apples",
  "apple_negative": "I have no apples"
}

Typical Weblate Component configuration
ファイルマスク	langs/*.json
単一言語のベース言語ファイル	langs/en.json
新しい翻訳のテンプレート	Empty
ファイル形式	i18next JSON file

参考

JSON、i18next JSON Format 、JSON 出力形式のカスタマイズ、翻訳ファイルのクリーンアップ

go-i18n JSON files

バージョン 4.1 で追加.

go-i18n translations are monolingual, so it is recommended to specify a base file with (what is most often the) English strings.

注釈

Weblate supports the go-i18n JSON v1 format, for flat JSON formats please use JSON files. The v2 format with hash is currently not supported.

Typical Weblate Component configuration
ファイルマスク	langs/*.json
単一言語のベース言語ファイル	langs/en.json
新しい翻訳のテンプレート	Empty
ファイル形式	go-i18n JSON file

参考

JSON、go-i18n 、JSON 出力形式のカスタマイズ、翻訳ファイルのクリーンアップ、

ARB File

バージョン 4.1 で追加.

ARB translations are monolingual, so it is recommended to specify a base file with (what is most often the) English strings.

Typical Weblate Component configuration
ファイルマスク	lib/l10n/intl_*.arb
単一言語のベース言語ファイル	lib/l10n/intl_en.arb
新しい翻訳のテンプレート	Empty
ファイル形式	ARB file

参考

JSON、Application Resource Bundle Specification 、Internationalizing Flutter apps 、JSON 出力形式のカスタマイズ、翻訳ファイルのクリーンアップ

WebExtension JSON

バージョン 2.16 で追加: This is supported since Weblate 2.16 and with translate-toolkit at-least 2.2.4.

File format used when translating extensions for Mozilla Firefox or Google Chromium.

注釈

While this format is called JSON, its specification allows to include comments, which are not part of JSON specification. Weblate currently does not support file with comments.

Example file:

{
  "hello": {
    "message": "Ahoj světe!\n",
    "description": "Description",
    "placeholders": {
      "url": {
        "content": "$1",
        "example": "https://developer.mozilla.org"
      }
    }
  },
  "orangutan": {
    "message": "",
    "description": "Description"
  },
  "try": {
    "message": "",
    "description": "Description"
  },
  "thanks": {
    "message": "",
    "description": "Description"
  }
}

Typical Weblate Component configuration
ファイルマスク	_locales/*/messages.json
単一言語のベース言語ファイル	_locales/en/messages.json
新しい翻訳のテンプレート	Empty
ファイル形式	WebExtension JSON file

参考

JSON、Google chrome.i18n、Mozilla Extensions Internationalization

.XML resource files

バージョン 2.3 で追加.

A .XML resource (.resx) file employs a monolingual XML file format used in Microsoft .NET applications. It is interchangeable with .resw, when using identical syntax to .resx.

Typical Weblate Component configuration
ファイルマスク	Resources/Language.*.resx
単一言語のベース言語ファイル	Resources/Language.resx
新しい翻訳のテンプレート	Empty
ファイル形式	.NET resource file

参考

.NET Resource files (.resx)、ref:addon-weblate.cleanup.generic、

CSV files

バージョン 2.4 で追加.

CSV files can contain a simple list of source and translation. Weblate supports the following files:

• Files with header defining fields (source, translation, location, …). This is the recommended approach, as it is the least error prone.

• Files with two fields—source and translation (in this order), choose Simple CSV file as file format

• Files with fields as defined by translate-toolkit: location, source, target, ID, fuzzy, context, translator_comments, developer_comments

• Remember to define 単一言語のベース言語ファイル when your files are monolingual (see Bilingual and monolingual formats)

警告

The CSV format currently automatically detects the dialect of the CSV file. In some cases the automatic detection might fail and you will get mixed results. This is especially true for CSV files with newlines in the values. As a workaround it is recommended to omit quoting characters.

Example file:

Thank you for using Weblate.,Děkujeme za použití Weblate.

Typical Weblate Component configuration for bilingual CSV
ファイルマスク	locale/*.csv
単一言語のベース言語ファイル	Empty
新しい翻訳のテンプレート	locale/en.csv
ファイル形式	CSV file

Typical Weblate Component configuration for monolingual CSV
ファイルマスク	locale/*.csv
単一言語のベース言語ファイル	locale/en.csv
新しい翻訳のテンプレート	locale/en.csv
ファイル形式	シンプルな CSV ファイル

参考

CSV

YAML files

バージョン 2.9 で追加.

The plain YAML files with string keys and values. Weblate also extract strings from lists or dictionaries.

Example of a YAML file:

weblate:
  hello: ""
  orangutan": ""
  try": ""
  thanks": ""

Typical Weblate Component configuration
ファイルマスク	translations/messages.*.yml
単一言語のベース言語ファイル	translations/messages.en.yml
新しい翻訳のテンプレート	Empty
ファイル形式	YAML file

参考

YAML、Ruby YAML files

Ruby YAML files

バージョン 2.9 で追加.

Ruby i18n YAML files with language as root node.

Example Ruby i18n YAML file:

cs:
  weblate:
    hello: ""
    orangutan: ""
    try: ""
    thanks: ""

Typical Weblate Component configuration
ファイルマスク	translations/messages.*.yml
単一言語のベース言語ファイル	translations/messages.en.yml
新しい翻訳のテンプレート	Empty
ファイル形式	Ruby YAML file

参考

YAML、YAML files

DTD files

バージョン 2.18 で追加.

Example DTD file:

<!ENTITY hello "">
<!ENTITY orangutan "">
<!ENTITY try "">
<!ENTITY thanks "">

Typical Weblate Component configuration
ファイルマスク	locale/*.dtd
単一言語のベース言語ファイル	locale/en.dtd
新しい翻訳のテンプレート	Empty
ファイル形式	DTD file

参考

Mozilla DTD format

Flat XML files

バージョン 3.9 で追加.

Example of a flat XML file:

<?xml version='1.0' encoding='UTF-8'?>
<root>
  <str key="hello_world">Hello World!</str>
  <str key="resource_key">Translated value.</str>
</root>

Typical Weblate Component configuration
ファイルマスク	locale/*.xml
単一言語のベース言語ファイル	locale/en.xml
新しい翻訳のテンプレート	Empty
ファイル形式	Flat XML file

参考

Flat XML

Windows RC files

バージョン 4.1 で変更: Support for Windows RC files has been rewritten.

注釈

Support for this format is currently in beta, feedback from testing is welcome.

Example Windows RC file:

LANGUAGE LANG_CZECH, SUBLANG_DEFAULT

STRINGTABLE
BEGIN
    IDS_MSG1                "Hello, world!\n"
    IDS_MSG2                "Orangutan has %d banana.\n"
    IDS_MSG3                "Try Weblate at http://demo.weblate.org/!\n"
    IDS_MSG4                "Thank you for using Weblate."
END

Typical Weblate Component configuration
ファイルマスク	lang/*.rc
単一言語のベース言語ファイル	lang/en-US.rc
新しい翻訳のテンプレート	lang/en-US.rc
ファイル形式	RC file

参考

Windows RC files

アプリ ストア メタデータ ファイル

バージョン 3.5 で追加.

Metadata used for publishing apps in various app stores can be translated. Currently the following tools are compatible:

• Triple-T gradle-play-publisher

• Fastlane

• F-Droid

The metadata consists of several textfiles, which Weblate will present as separate strings to translate.

Typical Weblate Component configuration
ファイルマスク	fastlane/android/metadata/*
単一言語のベース言語ファイル	fastlane/android/metadata/en-US
新しい翻訳のテンプレート	fastlane/android/metadata/en-US
ファイル形式	App store metadata files

ヒント

In case you don't want to translate certain strings (for example changelogs), mark them read-only (see 動作のカスタマイズ). This can be automated by the 一括編集.

Subtitle files

バージョン 3.7 で追加.

Weblate は、さまざまな字幕ファイルを翻訳できます。

• SubRip subtitle file (*.srt)

• MicroDVD subtitle file (*.sub)

• Advanced Substation Alpha subtitles file (*.ass)

• Substation Alpha subtitle file (*.ssa)

Typical Weblate Component configuration
ファイルマスク	path/*.srt
単一言語のベース言語ファイル	path/en.srt
新しい翻訳のテンプレート	path/en.srt
ファイル形式	SubRip subtitle file

参考

Subtitles

Excel Open XML

バージョン 3.2 で追加.

Excel Open XML (.xlsx) files can be imported and exported.

When uploading XLSX files for translation, be aware that only the active worksheet is considered, and there must be at least a column called source (which contains the source string) and a column called target (which contains the translation). Additionally there should be the column called context (which contains the context path of the translation string). If you use the XLSX download for exporting the translations into an Excel workbook, you already get a file with the correct file format.

HTML files

バージョン 4.1 で追加.

注釈

Support for this format is currently in beta, feedback from testing is welcome.

The translatable content is extracted from the HTML files and offered for the translation.

参考

HTML

OpenDocument Format

バージョン 4.1 で追加.

注釈

Support for this format is currently in beta, feedback from testing is welcome.

The translatable content is extracted from the OpenDocument files and offered for the translation.

参考

OpenDocument Format

IDML Format

バージョン 4.1 で追加.

注釈

Support for this format is currently in beta, feedback from testing is welcome.

The translatable content is extracted from the Adobe InDesign Markup Language files and offered for the translation.

その他

Most formats supported by translate-toolkit which support serializing can be easily supported, but they did not (yet) receive any testing. In most cases some thin layer is needed in Weblate to hide differences in behavior of different translate-toolkit storages.

参考

Translation Related File Formats

読み取り専用文字列

バージョン 3.10 で追加.

Read-only strings from translation files will be included, but can not be edited in Weblate. This feature is natively supported by few formats (XLIFF and Android string resources), but can be emulated in others by adding a read-only flag, see 動作のカスタマイズ.

バージョン管理の統合

Weblate は現在、バージョン管理のバックエンドとして Git （GitHub、Gerrit および Subversion の拡張サポート付き）および Mercurial に対応しています。

リポジトリへの接続

使用する VCS リポジトリに Weblate から接続する必要があります。一般に公開されているリポジトリの場合は、正しい URL（例えば https://github.com/WeblateOrg/weblate.git）を入力するだけですが、プライベートなリポジトリやプッシュ URL の場合は、設定がより複雑になり、認証が必要になります。

Hosted Weblate からリポジトリへの接続

Hosted Weblate では GitHub、Bitbucket、Codeberg、および GitLab（ユーザー名 weblate で Weblate push user と表示名）に登録したプッシュ専用ユーザーがいます。このユーザーをコラボレーターとして追加し、リポジトリに適切な権限を与える必要があります（クローン作成には読み取り専用、プッシュには書き込みが必要）。サービスと組織の設定にもよるが、すぐに実行するか、Weblate 側で確認が必要です。

GitHub への招待は 5 分以内に自動的に承認されますが、他のサービスでは手動での処理が必要な場合があるため、しばらくお待ちください。

weblate ユーザーを追加すると、SSH プロトコル（例えば git@github.com:WeblateOrg/weblate.git）を使用して ソースコードのリポジトリ と リポジトリの送信先 URL を設定できます。

SSH リポジトリ

プライベート リポジトリに接続するために最もよく使用される方法は、SSH による接続です。この方法でアップストリーム リポジトリに接続するために、Weblate SSH 公開鍵（参照 Weblate SSH キー）を承認します。

警告

GitHub では、各キーは 1 つのリポジトリにしか追加できません、参照 GitHub リポジトリ および Hosted Weblate からリポジトリへの接続。

また、Weblate は最初の接続時にホスト鍵のフィンガープリントを保存し、後で変更した場合にはホストに接続できません（参照 SSH ホスト認証鍵の承認）。

調整が必要な場合は、Weblate 管理インタフェースから設定します。

Weblate SSH キー

Weblate 公開鍵は、About ページを閲覧するすべてのユーザーに表示されます。

管理者は、管理画面のランディング ページ内の接続（ラベル SSH keys）で Weblate が現在使用している公開鍵を生成または表示できます。

注釈

対応するプライベート SSH 認証鍵は現在パスワードを設定できないため、適切に保護されているか確認してください。

ヒント

生成されたプライベートな Weblate の SSH 認証鍵のバックアップを作成します。

SSH ホスト認証鍵の承認

Weblate は、その後の使用のために、最初の接続時に SSH ホスト認証鍵を自動的に記憶します。

リポジトリに接続する前に確認する場合は、管理画面の同じセクションの Add host key で接続するサーバの SSH ホスト認証鍵を確認してください。接続するホスト名（例えば gitlab.com）を入力し、Submit を押します。フィンガープリントが追加したサーバーと一致しているか確認します。これは確認メッセージに表示されます。

GitHub リポジトリ

SSH 経由での接続もできますが（参照 SSH リポジトリ）、複数のリポジトリに接続する必要がある場合は、 SSH 認証鍵の使用は GitHub で制限されます（一つの認証鍵は一つのリポジトリにのみ使用できる）。

ブランチに push を設定していない場合、プロジェクトはフォークされ、変更はフォークを通してプッシュされます。設定されている場合、変更は upstream リポジトリと選択したブランチにプッシュされます。

小規模な設置の場合は、HTTPS 認証で個人用アクセス トークンと GitHub アカウントを使用します、参照 Creating an access token for command-line use。

大規模な設置の場合は、通常、Weblate 専用のユーザーを作成し、そこに Weblate で生成した公開 SSH 認証鍵（参照 Weblate SSH キー）を割り当て、翻訳したいすべてのリポジトリへの接続を許可することをお勧めします。このアプローチは Hosted Weblate にも適用され、専用の weblate ユーザーが存在します。

参考

Hosted Weblate からリポジトリへの接続

Weblate の内部 URL

異なるコンポーネント間で 1 つのリポジトリを共有するには、weblate://project/component のような特別な URL を使用します。このようにして、コンポーネントは VCS リポジトリ設定を参照先コンポーネント（例えば project/component）と共有します。

Weblate は、一致するリポジトリ設定を持つコンポーネントが見つかった場合、コンポーネントを作成する際に自動的にリポジトリの URL を調整します。これは、コンポーネント設定の最後の手順でオーバーライドできます。

使用理由:

• サーバーのディスク容量を節約。リポジトリは一度だけ保存される。

• 更新を高速化する。リポジトリは 1 つだけ更新される。

• Weblate 翻訳を使用してエクスポートするリポジトリは 1 つだけ（参照 Git exporter）。

• アドオンによっては、単一のリポジトリを共有する複数のコンポーネント上で動作できる、例えば Git コミットをスカッシュ。

HTTPS リポジトリ

保護された HTTPS リポジトリに接続するには、URL にユーザー名とパスワードを含めます。心配は無用です、URL がユーザーに表示されるときに、Weblate はこの情報を削除します（リポジトリ URL の表示を許可していても）。

たとえば、認証を追加した GitHub URL は次のようになります: https://user:your_access_token@github.com/WeblateOrg/weblate.git。

注釈

ユーザー名やパスワードに特殊文字が含まれている場合は、URL をエンコードする必要があります https://user%40example.com:%24password%23@bitbucket.org/…。

プロキシの使用

プロキシー サーバーを使用して HTTP/HTTPS VCS リポジトリに接続する必要がある場合は、VCS の使用を設定します。

これは環境変数（cURL documentation に記載の通り）の http_proxy、 https_proxy、および all_proxy を使用するか、VCS 設定で次のように実行する:

git config --global http.proxy http://user:password@proxy.example.com:80

注釈

プロキシの設定は、Weblate を実行しているユーザ（参照 Filesystem permissions）と ``HOME=$DATA_DIR/home``（参照 DATA_DIR）を使用して設定する必要があります。他の設定だと、Weblate は Git を実行しません。

参考

The cURL manpage、Git config documentation

Git

参考

さまざまな種類のリポジトリに接続する方法については、リポジトリへの接続 を参照してください。

Git に強制プッシュ

これは Git 本体とまったく同じように動作しますが、唯一の違いは、常に強制的にプッシュされることです。これは、翻訳に別のリポジトリを使用する場合にのみ使用します。

警告

upstream のリポジトリではコミットが失われやすいので、注意して使用してください。

Git 設定のカスタマイズ

Weblate は、すべての VCS コマンドを HOME=$DATA_DIR/home （参照 DATA_DIR）で実行します。したがって、ユーザー設定の編集は DATA_DIR/home/.git で行う必要があります。

Git リモート ヘルパー

他のバージョン管理システムを追加して対応するために remote helpers を使用できますが、これにより発生する可能性がある問題をデバッグする準備をしてください。

現時点では、Bazaar と Mercurial のヘルパーは GitHub 上の別々のリポジトリ、GitHub: git-remote-hg と git-remote-bzr で利用できます。手動でダウンロードし、検索パス（例えば ~/bin）に配置します。対応するバージョン管理システムがインストールされていることを確認してください。

これらをインストールしたら、このようなリモートを使用して Weblate でリポジトリを設定できます。

Bazaar を使用して Launchpad から gnuhello プロジェクトの複製:

bzr::lp:gnuhello

Mercurial を使用した selenic.com の hello リポジトリの場合:

hg::http://selenic.com/repo/hello

警告

Git のリモート ヘルパーを使う上で不便な点は、例えば Mercurial の場合、変更を元に戻すときにリモート ヘルパーが新しい tip を作成してしまうことがあります。

GitHub

バージョン 2.3 で追加.

これにより、リポジトリに直接プッシュするのではなく、Github API を使用して 、薄いレイヤーを Git に追加して、翻訳の変更をプル リクエストとしてプッシュできるようになります。

Git は変更を直接リポジトリにプッシュしますが、GitHub はプル リクエストを作成します。後者は Git リポジトリに接続する場合には必要ありません。

参考

Pushing changes from Weblate

プルリクエストとして変更を GitHub にプッシュする

変換を GitHub リポジトリにプッシュしたくない場合は、代わりに 1 つまたは複数のプル リクエストとして送信できます。

この機能の動作には、API 認証情報の設定が必要です。

参考

GITHUB_USERNAME、 GITHUB_TOKEN、 GITHUB_CREDENTIALS

GitLab

バージョン 3.9 で追加.

これにより、リポジトリに直接プッシュするのではなく、GitLab API を使用して 、薄いレイヤーを Git に追加して、翻訳の変更をプル リクエストとしてプッシュできるようになります。

Gitリポジトリにアクセスするためにこれを使う必要はありません。通常 Git は同じように動作しますが、唯一の違いはリポジトリへのプッシュの扱い方です。Git では、変更はリポジトリに直接プッシュされますが、GitLab ではマージ リクエストが作成されます。

参考

Pushing changes from Weblate

GitLab への変更をマージ リクエストとしてプッシュする

変換を GitLab リポジトリにプッシュしたくない場合は、代わりに 1 つまたは複数のマージ リクエストとして送信できます。

この機能の動作には、API 認証情報の設定が必要です。

参考

GITLAB_USERNAME、 GITLAB_TOKEN、 GITLAB_CREDENTIALS

Pagure

バージョン 4.3.2 で追加.

これにより、リポジトリに直接プッシュするのではなく、Pagure API を使用して 、薄いレイヤーを Git に追加するだけで、翻訳の変更をプル リクエストとしてプッシュできます。

Git リポジトリにアクセスするために、これを使う必要はありません。通常 Git は同じように動作しますが、唯一の違いはリポジトリへのプッシュの扱い方です。Git では、変更はリポジトリに直接プッシュされますが、Pagure ではマージ リクエストが作成されます。

参考

Pushing changes from Weblate

マージ リクエストとして Pagure に変更をプッシュする

翻訳を Pagure リポジトリにプッシュしたくない場合は、代わりに 1 つまたは複数のマージ リクエストとして送信できます。

この機能の動作には、API 認証情報の設定が必要です。

参考

PAGURE_USERNAME、PAGURE_TOKEN、PAGURE_CREDENTIALS

Gerrit

バージョン 2.2 で追加.

git-review ツールを使用して、リポジトリに直接プッシュするのではなく、Gerrit レビュー リクエストとして翻訳変更をプッシュするために、Git の上に薄いレイヤを追加します。

Gerrit ドキュメントには、このようなリポジトリを設定するために必要な設定の詳細が記載されています。

Mercurial

バージョン 2.1 で追加.

Mercurial は、Weblate で直接使用できるもう 1 つの VCS です。

注釈

Mercurial のどのバージョンでも動作するはずですが、コマンドライン インタフェースに互換性のない変更が追加されたので、Weblate との統合ができないことがあります。

参考

さまざまな種類のリポジトリに接続する方法については、リポジトリへの接続 を参照してください。

Subversion

バージョン 2.8 で追加.

Weblate は git-svn を使用して subversion リポジトリと通信します。これは、Git クライアントで Subversion を使用できる Perl スクリプトで、ユーザーは内部リポジトリの完全なクローンを維持し、ローカルでコミットできるようにします。

注釈

Weblate は Subversion リポジトリ レイアウトを自動的に検出しようとします ー ブランチの直接の URL と標準レイアウトのリポジトリの両方をサポートします（branches/、tags/、および trunk/)。詳細は git-svn documentation を参照してください。リポジトリに標準レイアウトがなく、エラーが発生した場合は、リポジトリ URL にブランチ名を含め、ブランチを空のままにします。

バージョン 2.19 で変更: これまでは、標準のレイアウト リポジトリのみをサポートしていました。

Subversion 資格情報

Weblate では、証明書を事前に受け入れ、必要に応じて資格情報を受け入れることを想定しています。DATA_DIR ディレクトリに挿入されます。'svn' を使用して 、'$HOME' 環境変数を DATA_DIR に設定して、証明書を受け入れます。

# Use DATA_DIR as configured in Weblate settings.py, it is /app/data in the Docker
HOME=${DATA_DIR}/home svn co https://svn.example.com/example

参考

DATA_DIR

ローカル ファイル

バージョン 3.8 で追加.

Weblate は、リモート VCS がなくても動作します。最初の翻訳は、アップロードするとインポートされます。あとで、個々のファイルをファイル アップロードで置き換えるか、Weblate から直接、翻訳文字列を追加できます（現在、単一言語翻訳でのみ使用できます）。

Weblate はバックグラウンドで Git リポジトリを作成し、すべての変更を記録します。後で VCS を使用して翻訳を保存する場合は、すでに Weblate 内に統合のベースとなるリポジトリがあります。

Weblate's REST API

バージョン 2.6 で追加: The REST API is available since Weblate 2.6.

The API is accessible on the /api/ URL and it is based on Django REST framework. You can use it directly or by Weblate クライアント.

Authentication and generic parameters

The public project API is available without authentication, though unauthenticated requests are heavily throttled (by default to 100 requests per day), so it is recommended to use authentication. The authentication uses a token, which you can get in your profile. Use it in the Authorization header:

ANY /

Generic request behaviour for the API, the headers, status codes and parameters here apply to all endpoints as well.

Query Parameters

• format -- Response format (overrides Accept). Possible values depends on REST framework setup, by default json and api are supported. The latter provides web browser interface for API.

Request Headers

• Accept -- the response content type depends on Accept header

• Authorization -- optional token to authenticate

Response Headers

• Content-Type -- this depends on Accept header of request

• Allow -- list of allowed HTTP methods on object

Response JSON Object

• detail (string) -- verbose description of failure (for HTTP status codes other than 200 OK)

• count (int) -- total item count for object lists

• next (string) -- next page URL for object lists

• previous (string) -- previous page URL for object lists

• results (array) -- results for object lists

• url (string) -- URL to access this resource using API

• web_url (string) -- URL to access this resource using web browser

Status Codes

• 200 OK -- when request was correctly handled

• 400 Bad Request -- when form parameters are missing

• 403 Forbidden -- when access is denied

• 429 Too Many Requests -- when throttling is in place

Authentication examples

Example request:

GET /api/ HTTP/1.1
Host: example.com
Accept: application/json, text/javascript
Authorization: Token YOUR-TOKEN

Example response:

HTTP/1.0 200 OK
Date: Fri, 25 Mar 2016 09:46:12 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, HEAD, OPTIONS

{
    "projects":"http://example.com/api/projects/",
    "components":"http://example.com/api/components/",
    "translations":"http://example.com/api/translations/",
    "languages":"http://example.com/api/languages/"
}

CURL example:

curl \
    -H "Authorization: Token TOKEN" \
    https://example.com/api/

Passing Parameters Examples

For the POST method the parameters can be specified either as form submission (application/x-www-form-urlencoded) or as JSON (application/json).

Form request example:

POST /api/projects/hello/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
Authorization: Token TOKEN

operation=pull

JSON request example:

POST /api/projects/hello/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"operation":"pull"}

CURL example:

curl \
    -d operation=pull \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/components/hello/weblate/repository/

CURL JSON example:

curl \
    --data-binary '{"operation":"pull"}' \
    -H "Content-Type: application/json" \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/components/hello/weblate/repository/

API レート制限

The API requests are rate limited; the default configuration limits it to 100 requests per day for anonymous users and 5000 requests per hour for authenticated users.

Rate limiting can be adjusted in the settings.py; see Throttling in Django REST framework documentation for more details how to configure it.

The status of rate limiting is reported in following headers:

X-RateLimit-Limit	Rate limiting limit of requests to perform
X-RateLimit-Remaining	Remaining limit of requests
X-RateLimit-Reset	Number of seconds until ratelimit window resets

バージョン 4.1 で変更: Added ratelimiting status headers.

参考

レート制限、レート制限

API Entry Point

GET /api/

The API root entry point.

Example request:

GET /api/ HTTP/1.1
Host: example.com
Accept: application/json, text/javascript
Authorization: Token YOUR-TOKEN

Example response:

HTTP/1.0 200 OK
Date: Fri, 25 Mar 2016 09:46:12 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, HEAD, OPTIONS

{
    "projects":"http://example.com/api/projects/",
    "components":"http://example.com/api/components/",
    "translations":"http://example.com/api/translations/",
    "languages":"http://example.com/api/languages/"
}

ユーザー

バージョン 4.0 で追加.

GET /api/users/

Returns a list of users if you have permissions to see manage users. If not, then you get to see only your own details.

参考

Users object attributes are documented at GET /api/users/(str:username)/.

POST /api/users/

Creates a new user.

Parameters

• username (string) -- ユーザー名

• full_name (string) -- User full name

• email (string) -- User email

• is_superuser (boolean) -- Is user superuser? (optional)

• is_active (boolean) -- Is user active? (optional)

GET /api/users/(str: username)/

Returns information about users.

Parameters

• username (string) -- User's username

Response JSON Object

• username (string) -- username of a user

• full_name (string) -- full name of a user

• email (string) -- email of a user

• is_superuser (boolean) -- whether the user is a super user

• is_active (boolean) -- whether the user is active

• date_joined (string) -- date the user is created

• groups (array) -- link to associated groups; see GET /api/groups/(int:id)/

Example JSON data:

{
    "email": "user@example.com",
    "full_name": "Example User",
    "username": "exampleusername",
    "groups": [
        "http://example.com/api/groups/2/",
        "http://example.com/api/groups/3/"
    ],
    "is_superuser": true,
    "is_active": true,
    "date_joined": "2020-03-29T18:42:42.617681Z",
    "url": "http://example.com/api/users/exampleusername/",
    "statistics_url": "http://example.com/api/users/exampleusername/statistics/"
}

PUT /api/users/(str: username)/

Changes the user parameters.

Parameters

• username (string) -- User's username

Response JSON Object

• username (string) -- username of a user

• full_name (string) -- full name of a user

• email (string) -- email of a user

• is_superuser (boolean) -- whether the user is a super user

• is_active (boolean) -- whether the user is active

• date_joined (string) -- date the user is created

PATCH /api/users/(str: username)/

Changes the user parameters.

Parameters

• username (string) -- User's username

Response JSON Object

• username (string) -- username of a user

• full_name (string) -- full name of a user

• email (string) -- email of a user

• is_superuser (boolean) -- whether the user is a super user

• is_active (boolean) -- whether the user is active

• date_joined (string) -- date the user is created

DELETE /api/users/(str: username)/

Deletes all user information and marks the user inactive.

Parameters

• username (string) -- User's username

POST /api/users/(str: username)/groups/

Associate groups with a user.

Parameters

• username (string) -- User's username

Form Parameters

• string group_id -- The unique group ID

GET /api/users/(str: username)/statistics/

List statistics of a user.

Parameters

• username (string) -- User's username

Response JSON Object

• translated (int) -- ユーザーごとの翻訳数

• suggested (int) -- ユーザーごとの翻訳数

• uploaded (int) -- ユーザーごとのアップロード数

• commented (int) -- ユーザーごとのコメント数

• languages (int) -- ユーザーが翻訳できる言語の数

GET /api/users/(str: username)/notifications/

List subscriptions of a user.

Parameters

• username (string) -- User's username

POST /api/users/(str: username)/notifications/

Associate subscriptions with a user.

Parameters

• username (string) -- User's username

Request JSON Object

• notification (string) -- Name of notification registered

• scope (int) -- Scope of notification from the available choices

• frequency (int) -- Frequency choices for notifications

GET /api/users/(str: username)/notifications/(int: subscription_id)/

Get a subscription associated with a user.

Parameters

• username (string) -- User's username

• subscription_id (int) -- 登録済み通知 ID

PUT /api/users/(str: username)/notifications/(int: subscription_id)/

Edit a subscription associated with a user.

Parameters

• username (string) -- User's username

• subscription_id (int) -- 登録済み通知 ID

Request JSON Object

• notification (string) -- Name of notification registered

• scope (int) -- Scope of notification from the available choices

• frequency (int) -- Frequency choices for notifications

PATCH /api/users/(str: username)/notifications/(int: subscription_id)/

Edit a subscription associated with a user.

Parameters

• username (string) -- User's username

• subscription_id (int) -- 登録済み通知 ID

Request JSON Object

• notification (string) -- Name of notification registered

• scope (int) -- Scope of notification from the available choices

• frequency (int) -- Frequency choices for notifications

DELETE /api/users/(str: username)/notifications/(int: subscription_id)/

Delete a subscription associated with a user.

Parameters

• username (string) -- User's username

• subscription_id -- Name of notification registered

• subscription_id -- int

グループ

バージョン 4.0 で追加.

GET /api/groups/

Returns a list of groups if you have permissions to see manage groups. If not, then you get to see only the groups the user is a part of.

参考

Group object attributes are documented at GET /api/groups/(int:id)/.

POST /api/groups/

Creates a new group.

Parameters

• name (string) -- グループ名

• project_selection (int) -- Group of project selection from given options

• language_selection (int) -- Group of languages selected from given options

GET /api/groups/(int: id)/

Returns information about group.

Parameters

• id (int) -- Group's ID

Response JSON Object

• name (string) -- name of a group

• project_selection (int) -- integer corresponding to group of projects

• language_selection (int) -- integer corresponding to group of languages

• roles (array) -- link to associated roles; see GET /api/roles/(int:id)/

• projects (array) -- link to associated projects; see GET /api/projects/(string:project)/

• components (array) -- link to associated components; see GET /api/components/(string:project)/(string:component)/

• componentlist (array) -- コンポーネント リストのセットの関連するリンク; 参照 GET /api/component-lists/(str:slug)/

Example JSON data:

{
    "name": "Guests",
    "project_selection": 3,
    "language_selection": 1,
    "url": "http://example.com/api/groups/1/",
    "roles": [
        "http://example.com/api/roles/1/",
        "http://example.com/api/roles/2/"
    ],
    "languages": [
        "http://example.com/api/languages/en/",
        "http://example.com/api/languages/cs/",
    ],
    "projects": [
        "http://example.com/api/projects/demo1/",
        "http://example.com/api/projects/demo/"
    ],
    "componentlist": "http://example.com/api/component-lists/new/",
    "components": [
        "http://example.com/api/components/demo/weblate/"
    ]
}

PUT /api/groups/(int: id)/

Changes the group parameters.

Parameters

• id (int) -- Group's ID

Response JSON Object

• name (string) -- name of a group

• project_selection (int) -- integer corresponding to group of projects

• language_selection (int) -- integer corresponding to group of Languages

PATCH /api/groups/(int: id)/

Changes the group parameters.

Parameters

• id (int) -- Group's ID

Response JSON Object

• name (string) -- name of a group

• project_selection (int) -- integer corresponding to group of projects

• language_selection (int) -- integer corresponding to group of languages

DELETE /api/groups/(int: id)/

Deletes the group.

Parameters

• id (int) -- Group's ID

POST /api/groups/(int: id)/roles/

Associate roles with a group.

Parameters

• id (int) -- Group's ID

Form Parameters

• string role_id -- The unique role ID

POST /api/groups/(int: id)/components/

Associate components with a group.

Parameters

• id (int) -- Group's ID

Form Parameters

• string component_id -- The unique component ID

DELETE /api/groups/(int: id)/components/(int: component_id)

Delete component from a group.

Parameters

• id (int) -- Group's ID

• component_id (int) -- The unique component ID

POST /api/groups/(int: id)/projects/

Associate projects with a group.

Parameters

• id (int) -- Group's ID

Form Parameters

• string project_id -- The unique project ID

DELETE /api/groups/(int: id)/projects/(int: project_id)

Delete project from a group.

Parameters

• id (int) -- Group's ID

• project_id (int) -- The unique project ID

POST /api/groups/(int: id)/languages/

Associate languages with a group.

Parameters

• id (int) -- Group's ID

Form Parameters

• string language_code -- The unique language code

DELETE /api/groups/(int: id)/languages/(string: language_code)

Delete language from a group.

Parameters

• id (int) -- Group's ID

• language_code (string) -- The unique language code

POST /api/groups/(int: id)/componentlists/

コンポーネント リストのセットをグループに関連付ける。

Parameters

• id (int) -- Group's ID

Form Parameters

• string component_list_id -- The unique componentlist ID

DELETE /api/groups/(int: id)/componentlists/(int: component_list_id)

Delete componentlist from a group.

Parameters

• id (int) -- Group's ID

• component_list_id (int) -- The unique componentlist ID

役割

GET /api/roles/

Returns a list of all roles associated with user. If user is superuser, then list of all existing roles is returned.

参考

Roles object attributes are documented at GET /api/roles/(int:id)/.

POST /api/roles/

Creates a new role.

Parameters

• name (string) -- Role name

• permissions (array) -- List of codenames of permissions

GET /api/roles/(int: id)/

Returns information about a role.

Parameters

• id (int) -- Role ID

Response JSON Object

• name (string) -- Role name

• permissions (array) -- list of codenames of permissions

Example JSON data:

{
    "name": "Access repository",
    "permissions": [
        "vcs.access",
        "vcs.view"
    ],
    "url": "http://example.com/api/roles/1/",
}

PUT /api/roles/(int: id)/

Changes the role parameters.

Parameters

• id (int) -- Role's ID

Response JSON Object

• name (string) -- Role name

• permissions (array) -- list of codenames of permissions

PATCH /api/roles/(int: id)/

Changes the role parameters.

Parameters

• id (int) -- Role's ID

Response JSON Object

• name (string) -- Role name

• permissions (array) -- list of codenames of permissions

DELETE /api/roles/(int: id)/

Deletes the role.

Parameters

• id (int) -- Role's ID

言語

GET /api/languages/

Returns a list of all languages.

参考

Language object attributes are documented at GET /api/languages/(string:language)/.

POST /api/languages/

Creates a new language.

Parameters

• code (string) -- 言語名

• name (string) -- 言語名

• direction (string) -- Language direction

• plural (object) -- Language plural formula and number

GET /api/languages/(string: language)/

Returns information about a language.

Parameters

• language (string) -- 言語コード

Response JSON Object

• code (string) -- 言語コード

• direction (string) -- テキストの方向

• plural (object) -- Object of language plural information

• aliases (array) -- Array of aliases for language

Example JSON data:

{
    "code": "en",
    "direction": "ltr",
    "name": "English",
    "plural": {
        "id": 75,
        "source": 0,
        "number": 2,
        "formula": "n != 1",
        "type": 1
    },
    "aliases": [
        "english",
        "en_en",
        "base",
        "source",
        "eng"
    ],
    "url": "http://example.com/api/languages/en/",
    "web_url": "http://example.com/languages/en/",
    "statistics_url": "http://example.com/api/languages/en/statistics/"
}

PUT /api/languages/(string: language)/

Changes the language parameters.

Parameters

• language (string) -- Language's code

Request JSON Object

• name (string) -- 言語名

• direction (string) -- Language direction

• plural (object) -- Language plural details

PATCH /api/languages/(string: language)/

Changes the language parameters.

Parameters

• language (string) -- Language's code

Request JSON Object

• name (string) -- 言語名

• direction (string) -- Language direction

• plural (object) -- Language plural details

DELETE /api/languages/(string: language)/

Deletes the Language.

Parameters

• language (string) -- Language's code

GET /api/languages/(string: language)/statistics/

Returns statistics for a language.

Parameters

• language (string) -- 言語コード

Response JSON Object

• total (int) -- total number of strings

• total_words (int) -- total number of words

• last_change (timestamp) -- last changes in the language

• recent_changes (int) -- total number of changes

• translated (int) -- number of translated strings

• translated_percent (float) -- percentage of translated strings

• translated_words (int) -- number of translated words

• translated_words_percent (int) -- percentage of translated words

• translated_chars (int) -- number of translated characters

• translated_chars_percent (int) -- percentage of translated characters

• total_chars (int) -- number of total characters

• fuzzy (int) -- number of fuzzy strings

• fuzzy_percent (int) -- percentage of fuzzy strings

• failing (int) -- number of failing strings

• failing -- percentage of failing strings

プロジェクト

GET /api/projects/

Returns a list of all projects.

参考

Project object attributes are documented at GET /api/projects/(string:project)/.

POST /api/projects/

バージョン 3.9 で追加.

Creates a new project.

Parameters

• name (string) -- プロジェクト名

• slug (string) -- Project slug

• web (string) -- プロジェクトの Web サイト

GET /api/projects/(string: project)/

Returns information about a project.

Parameters

• project (string) -- プロジェクト URL スラッグ

Response JSON Object

• name (string) -- project name

• slug (string) -- project slug

• web (string) -- project website

• components_list_url (string) -- URL to components list; see GET /api/projects/(string:project)/components/

• repository_url (string) -- URL to repository status; see GET /api/projects/(string:project)/repository/

• changes_list_url (string) -- URL to changes list; see GET /api/projects/(string:project)/changes/

• translation_review (boolean) -- 査読の有効化

• source_review (boolean) -- 原文の査読の有効化

• set_language_team (boolean) -- Set Language-Team header

• enable_hooks (boolean) -- フックの有効化

• instructions (string) -- 翻訳についての説明

• mail (string) -- メーリングリスト

• language_aliases (string) -- 言語の別名

Example JSON data:

{
    "name": "Hello",
    "slug": "hello",
    "url": "http://example.com/api/projects/hello/",
    "web": "https://weblate.org/",
    "web_url": "http://example.com/projects/hello/"
}

PATCH /api/projects/(string: project)/

バージョン 4.3 で追加.

Edit a project by a patch request.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

PUT /api/projects/(string: project)/

バージョン 4.3 で追加.

Edit a project by a put request.

Parameters

• project (string) -- プロジェクト URL スラッグ

DELETE /api/projects/(string: project)/

バージョン 3.9 で追加.

Deletes a project.

Parameters

• project (string) -- プロジェクト URL スラッグ

GET /api/projects/(string: project)/changes/

Returns a list of project changes. This is essentially a project scoped GET /api/changes/ accepting same params.

Parameters

• project (string) -- プロジェクト URL スラッグ

Response JSON Object

• results (array) -- array of component objects; see GET /api/changes/(int:id)/

GET /api/projects/(string: project)/repository/

Returns information about VCS repository status. This endpoint contains only an overall summary for all repositories for the project. To get more detailed status use GET /api/components/(string:project)/(string:component)/repository/.

Parameters

• project (string) -- プロジェクト URL スラッグ

Response JSON Object

• needs_commit (boolean) -- whether there are any pending changes to commit

• needs_merge (boolean) -- whether there are any upstream changes to merge

• needs_push (boolean) -- whether there are any local changes to push

Example JSON data:

{
    "needs_commit": true,
    "needs_merge": false,
    "needs_push": true
}

POST /api/projects/(string: project)/repository/

Performs given operation on the VCS repository.

Parameters

• project (string) -- プロジェクト URL スラッグ

Request JSON Object

• operation (string) -- Operation to perform: one of push, pull, commit, reset, cleanup

Response JSON Object

• result (boolean) -- result of the operation

CURL example:

curl \
    -d operation=pull \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/projects/hello/repository/

JSON request example:

POST /api/projects/hello/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"operation":"pull"}

JSON response example:

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{"result":true}

GET /api/projects/(string: project)/components/

Returns a list of translation components in the given project.

Parameters

• project (string) -- プロジェクト URL スラッグ

Response JSON Object

• results (array) -- array of component objects; see GET /api/components/(string:project)/(string:component)/

POST /api/projects/(string: project)/components/

バージョン 3.9 で追加.

バージョン 4.3 で変更: The zipfile and docfile parameters are now accepted for VCS less components, see ローカル ファイル.

Creates translation components in the given project.

ヒント

Most of the component creation happens in the background. Check the task_url attribute of created component and follow the progress there.

Parameters

• project (string) -- プロジェクト URL スラッグ

Request JSON Object

• zipfile (file) -- ZIP file to upload into Weblate for translations initialization

• docfile (file) -- 翻訳するドキュメント

Response JSON Object

• result (object) -- Created component object; see GET /api/components/(string:project)/(string:component)/

CURL example:

curl \
    --data-binary '{
        "branch": "master",
        "file_format": "po",
        "filemask": "po/*.po",
        "git_export": "",
        "license": "",
        "license_url": "",
        "name": "Weblate",
        "slug": "weblate",
        "repo": "file:///home/nijel/work/weblate-hello",
        "template": "",
        "new_base": "",
        "vcs": "git"
    }' \
    -H "Content-Type: application/json" \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/projects/hello/components/

JSON request example:

POST /api/projects/hello/components/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{
    "branch": "master",
    "file_format": "po",
    "filemask": "po/*.po",
    "git_export": "",
    "license": "",
    "license_url": "",
    "name": "Weblate",
    "slug": "weblate",
    "repo": "file:///home/nijel/work/weblate-hello",
    "template": "",
    "new_base": "",
    "vcs": "git"
}

JSON response example:

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{
    "branch": "master",
    "file_format": "po",
    "filemask": "po/*.po",
    "git_export": "",
    "license": "",
    "license_url": "",
    "name": "Weblate",
    "slug": "weblate",
    "project": {
        "name": "Hello",
        "slug": "hello",
        "source_language": {
            "code": "en",
            "direction": "ltr",
            "name": "English",
            "url": "http://example.com/api/languages/en/",
            "web_url": "http://example.com/languages/en/"
        },
        "url": "http://example.com/api/projects/hello/",
        "web": "https://weblate.org/",
        "web_url": "http://example.com/projects/hello/"
    },
    "repo": "file:///home/nijel/work/weblate-hello",
    "template": "",
    "new_base": "",
    "url": "http://example.com/api/components/hello/weblate/",
    "vcs": "git",
    "web_url": "http://example.com/projects/hello/weblate/"
}

GET /api/projects/(string: project)/languages/

Returns paginated statistics for all languages within a project.

バージョン 3.8 で追加.

Parameters

• project (string) -- プロジェクト URL スラッグ

Response JSON Object

• results (array) -- array of translation statistics objects

• language (string) -- language name

• code (string) -- language code

• total (int) -- total number of strings

• translated (int) -- number of translated strings

• translated_percent (float) -- percentage of translated strings

• total_words (int) -- total number of words

• translated_words (int) -- number of translated words

• words_percent (float) -- percentage of translated words

GET /api/projects/(string: project)/statistics/

Returns statistics for a project.

バージョン 3.8 で追加.

Parameters

• project (string) -- プロジェクト URL スラッグ

Response JSON Object

• total (int) -- total number of strings

• translated (int) -- number of translated strings

• translated_percent (float) -- percentage of translated strings

• total_words (int) -- total number of words

• translated_words (int) -- number of translated words

• words_percent (float) -- percentage of translated words

コンポーネント

GET /api/components/

Returns a list of translation components.

参考

Component object attributes are documented at GET /api/components/(string:project)/(string:component)/.

GET /api/components/(string: project)/(string: component)/

Returns information about translation component.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

Response JSON Object

• project (object) -- the translation project; see GET /api/projects/(string:project)/

• name (string) -- コンポーネント名

• slug (string) -- Component slug

• vcs (string) -- バージョン管理システム

• repo (string) -- ソースコードのリポジトリ

• git_export (string) -- エクスポートされたリポジトリ URL

• branch (string) -- リポジトリブランチ

• push_branch (string) -- ブランチに push

• filemask (string) -- File mask

• template (string) -- 単一言語のベース言語ファイル

• edit_template (string) -- 基本ファイルの編集

• intermediate (string) -- 中間言語ファイル

• new_base (string) -- 新しい翻訳のテンプレート

• file_format (string) -- ファイル形式

• license (string) -- 翻訳のライセンス

• agreement (string) -- 貢献者同意条項

• new_lang (string) -- 新しい翻訳の追加

• language_code_style (string) -- 言語コード スタイル

• source_language (object) -- source language object; see GET /api/languages/(string:language)/

• push (string) -- リポジトリの送信先 URL

• check_flags (string) -- 翻訳フラグ

• priority (string) -- 優先順位

• enforced_checks (string) -- 検査の強制

• restricted (string) -- Restricted access

• repoweb (string) -- リポジトリ ブラウザー

• report_source_bugs (string) -- 原文ミスの報告先アドレス

• merge_style (string) -- マージスタイル

• commit_message (string) -- Commit, add, delete, merge and addon messages

• add_message (string) -- Commit, add, delete, merge and addon messages

• delete_message (string) -- Commit, add, delete, merge and addon messages

• merge_message (string) -- Commit, add, delete, merge and addon messages

• addon_message (string) -- Commit, add, delete, merge and addon messages

• allow_translation_propagation (string) -- 翻訳の伝達を許可する

• enable_suggestions (string) -- 提案の有効化

• suggestion_voting (string) -- 提案への投票

• suggestion_autoaccept (string) -- 提案の自動採用

• push_on_commit (string) -- コミット時にプッシュする

• commit_pending_age (string) -- コミットするまでの経過時間

• auto_lock_error (string) -- エラー時にロック

• language_regex (string) -- 言語フィルタ

• variant_regex (string) -- バリアント正規表現

• repository_url (string) -- URL to repository status; see GET /api/components/(string:project)/(string:component)/repository/

• translations_url (string) -- URL to translations list; see GET /api/components/(string:project)/(string:component)/translations/

• lock_url (string) -- URL to lock status; see GET /api/components/(string:project)/(string:component)/lock/

• changes_list_url (string) -- URL to changes list; see GET /api/components/(string:project)/(string:component)/changes/

• task_url (string) -- URL to a background task (if any); see GET /api/tasks/(str:uuid)/

Example JSON data:

{
    "branch": "master",
    "file_format": "po",
    "filemask": "po/*.po",
    "git_export": "",
    "license": "",
    "license_url": "",
    "name": "Weblate",
    "slug": "weblate",
    "project": {
        "name": "Hello",
        "slug": "hello",
        "source_language": {
            "code": "en",
            "direction": "ltr",
            "name": "English",
            "url": "http://example.com/api/languages/en/",
            "web_url": "http://example.com/languages/en/"
        },
        "url": "http://example.com/api/projects/hello/",
        "web": "https://weblate.org/",
        "web_url": "http://example.com/projects/hello/"
    },
    "source_language": {
        "code": "en",
        "direction": "ltr",
        "name": "English",
        "url": "http://example.com/api/languages/en/",
        "web_url": "http://example.com/languages/en/"
    },
    "repo": "file:///home/nijel/work/weblate-hello",
    "template": "",
    "new_base": "",
    "url": "http://example.com/api/components/hello/weblate/",
    "vcs": "git",
    "web_url": "http://example.com/projects/hello/weblate/"
}

PATCH /api/components/(string: project)/(string: component)/

Edit a component by a patch request.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

• source_language (string) -- Project source language code (optional)

Request JSON Object

• name (string) -- name of component

• slug (string) -- slug of component

• repo (string) -- VCS repository URL

CURL example:

curl \
    --data-binary '{"name": "new name"}' \
    -H "Content-Type: application/json" \
    -H "Authorization: Token TOKEN" \
    PATCH http://example.com/api/projects/hello/components/

JSON request example:

PATCH /api/projects/hello/components/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{
    "name": "new name"
}

JSON response example:

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{
    "branch": "master",
    "file_format": "po",
    "filemask": "po/*.po",
    "git_export": "",
    "license": "",
    "license_url": "",
    "name": "new name",
    "slug": "weblate",
    "project": {
        "name": "Hello",
        "slug": "hello",
        "source_language": {
            "code": "en",
            "direction": "ltr",
            "name": "English",
            "url": "http://example.com/api/languages/en/",
            "web_url": "http://example.com/languages/en/"
        },
        "url": "http://example.com/api/projects/hello/",
        "web": "https://weblate.org/",
        "web_url": "http://example.com/projects/hello/"
    },
    "repo": "file:///home/nijel/work/weblate-hello",
    "template": "",
    "new_base": "",
    "url": "http://example.com/api/components/hello/weblate/",
    "vcs": "git",
    "web_url": "http://example.com/projects/hello/weblate/"
}

PUT /api/components/(string: project)/(string: component)/

Edit a component by a put request.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

Request JSON Object

• branch (string) -- VCS repository branch

• file_format (string) -- file format of translations

• filemask (string) -- mask of translation files in the repository

• name (string) -- name of component

• slug (string) -- slug of component

• repo (string) -- VCS repository URL

• template (string) -- base file for monolingual translations

• new_base (string) -- base file for adding new translations

• vcs (string) -- version control system

DELETE /api/components/(string: project)/(string: component)/

バージョン 3.9 で追加.

Deletes a component.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

GET /api/components/(string: project)/(string: component)/changes/

Returns a list of component changes. This is essentially a component scoped GET /api/changes/ accepting same params.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

Response JSON Object

• results (array) -- array of component objects; see GET /api/changes/(int:id)/

GET /api/components/(string: project)/(string: component)/screenshots/

Returns a list of component screenshots.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

Response JSON Object

• results (array) -- array of component screenshots; see GET /api/screenshots/(int:id)/

GET /api/components/(string: project)/(string: component)/lock/

Returns component lock status.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

Response JSON Object

• locked (boolean) -- whether component is locked for updates

Example JSON data:

{
    "locked": false
}

POST /api/components/(string: project)/(string: component)/lock/

Sets component lock status.

Response is same as GET /api/components/(string:project)/(string:component)/lock/.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

Request JSON Object

• lock -- Boolean whether to lock or not.

CURL example:

curl \
    -d lock=true \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/components/hello/weblate/repository/

JSON request example:

POST /api/components/hello/weblate/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"lock": true}

JSON response example:

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{"locked":true}

GET /api/components/(string: project)/(string: component)/repository/

Returns information about VCS repository status.

The response is same as for GET /api/projects/(string:project)/repository/.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

Response JSON Object

• needs_commit (boolean) -- whether there are any pending changes to commit

• needs_merge (boolean) -- whether there are any upstream changes to merge

• needs_push (boolean) -- whether there are any local changes to push

• remote_commit (string) -- Remote commit information

• status (string) -- VCS repository status as reported by VCS

• merge_failure -- Text describing merge failure or null if there is none

POST /api/components/(string: project)/(string: component)/repository/

Performs the given operation on a VCS repository.

See POST /api/projects/(string:project)/repository/ for documentation.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

Request JSON Object

• operation (string) -- Operation to perform: one of push, pull, commit, reset, cleanup

Response JSON Object

• result (boolean) -- result of the operation

CURL example:

curl \
    -d operation=pull \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/components/hello/weblate/repository/

JSON request example:

POST /api/components/hello/weblate/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"operation":"pull"}

JSON response example:

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{"result":true}

GET /api/components/(string: project)/(string: component)/monolingual_base/

Downloads base file for monolingual translations.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

GET /api/components/(string: project)/(string: component)/new_template/

Downloads template file for new translations.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

GET /api/components/(string: project)/(string: component)/translations/

Returns a list of translation objects in the given component.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

Response JSON Object

• results (array) -- array of translation objects; see GET /api/translations/(string:project)/(string:component)/(string:language)/

POST /api/components/(string: project)/(string: component)/translations/

Creates new translation in the given component.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

Request JSON Object

• language_code (string) -- translation language code; see GET /api/languages/(string:language)/

Response JSON Object

• result (object) -- new translation object created

CURL example:

curl \
    -d language_code=cs \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/projects/hello/components/

JSON request example:

POST /api/projects/hello/components/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"language_code": "cs"}

JSON response example:

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{
    "failing_checks": 0,
    "failing_checks_percent": 0,
    "failing_checks_words": 0,
    "filename": "po/cs.po",
    "fuzzy": 0,
    "fuzzy_percent": 0.0,
    "fuzzy_words": 0,
    "have_comment": 0,
    "have_suggestion": 0,
    "is_template": false,
    "is_source": false,
    "language": {
        "code": "cs",
        "direction": "ltr",
        "name": "Czech",
        "url": "http://example.com/api/languages/cs/",
        "web_url": "http://example.com/languages/cs/"
    },
    "language_code": "cs",
    "id": 125,
    "last_author": null,
    "last_change": null,
    "share_url": "http://example.com/engage/hello/cs/",
    "total": 4,
    "total_words": 15,
    "translate_url": "http://example.com/translate/hello/weblate/cs/",
    "translated": 0,
    "translated_percent": 0.0,
    "translated_words": 0,
    "url": "http://example.com/api/translations/hello/weblate/cs/",
    "web_url": "http://example.com/projects/hello/weblate/cs/"
}

GET /api/components/(string: project)/(string: component)/statistics/

Returns paginated statistics for all translations within component.

バージョン 2.7 で追加.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

Response JSON Object

• results (array) -- array of translation statistics objects; see GET /api/translations/(string:project)/(string:component)/(string:language)/statistics/

翻訳

GET /api/translations/

Returns a list of translations.

参考

Translation object attributes are documented at GET /api/translations/(string:project)/(string:component)/(string:language)/.

GET /api/translations/(string: project)/(string: component)/(string: language)/

Returns information about a translation.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

• language (string) -- Translation language code

Response JSON Object

• component (object) -- component object; see GET /api/components/(string:project)/(string:component)/

• failing_checks (int) -- 検査不合格の文字列の数

• failing_checks_percent (float) -- 検査不合格の文字列の割合

• failing_checks_words (int) -- 検査不合格の単語の数

• filename (string) -- translation filename

• fuzzy (int) -- number of strings marked for review

• fuzzy_percent (float) -- percentage of strings marked for review

• fuzzy_words (int) -- number of words marked for review

• have_comment (int) -- number of strings with comment

• have_suggestion (int) -- number of strings with suggestion

• is_template (boolean) -- 翻訳が単一言語ベースかどうか

• language (object) -- source language object; see GET /api/languages/(string:language)/

• language_code (string) -- language code used in the repository; this can be different from language code in the language object

• last_author (string) -- name of last author

• last_change (timestamp) -- last change timestamp

• revision (string) -- revision hash for the file

• share_url (string) -- URL for sharing leading to engagement page

• total (int) -- total number of strings

• total_words (int) -- total number of words

• translate_url (string) -- URL for translating

• translated (int) -- number of translated strings

• translated_percent (float) -- percentage of translated strings

• translated_words (int) -- number of translated words

• repository_url (string) -- URL to repository status; see GET /api/translations/(string:project)/(string:component)/(string:language)/repository/

• file_url (string) -- URL to file object; see GET /api/translations/(string:project)/(string:component)/(string:language)/file/

• changes_list_url (string) -- URL to changes list; see GET /api/translations/(string:project)/(string:component)/(string:language)/changes/

• units_list_url (string) -- URL to strings list; see GET /api/translations/(string:project)/(string:component)/(string:language)/units/

Example JSON data:

{
    "component": {
        "branch": "master",
        "file_format": "po",
        "filemask": "po/*.po",
        "git_export": "",
        "license": "",
        "license_url": "",
        "name": "Weblate",
        "new_base": "",
        "project": {
            "name": "Hello",
            "slug": "hello",
            "source_language": {
                "code": "en",
                "direction": "ltr",
                "name": "English",
                "url": "http://example.com/api/languages/en/",
                "web_url": "http://example.com/languages/en/"
            },
            "url": "http://example.com/api/projects/hello/",
            "web": "https://weblate.org/",
            "web_url": "http://example.com/projects/hello/"
        },
        "repo": "file:///home/nijel/work/weblate-hello",
        "slug": "weblate",
        "template": "",
        "url": "http://example.com/api/components/hello/weblate/",
        "vcs": "git",
        "web_url": "http://example.com/projects/hello/weblate/"
    },
    "failing_checks": 3,
    "failing_checks_percent": 75.0,
    "failing_checks_words": 11,
    "filename": "po/cs.po",
    "fuzzy": 0,
    "fuzzy_percent": 0.0,
    "fuzzy_words": 0,
    "have_comment": 0,
    "have_suggestion": 0,
    "is_template": false,
    "language": {
        "code": "cs",
        "direction": "ltr",
        "name": "Czech",
        "url": "http://example.com/api/languages/cs/",
        "web_url": "http://example.com/languages/cs/"
    },
    "language_code": "cs",
    "last_author": "Weblate Admin",
    "last_change": "2016-03-07T10:20:05.499",
    "revision": "7ddfafe6daaf57fc8654cc852ea6be212b015792",
    "share_url": "http://example.com/engage/hello/cs/",
    "total": 4,
    "total_words": 15,
    "translate_url": "http://example.com/translate/hello/weblate/cs/",
    "translated": 4,
    "translated_percent": 100.0,
    "translated_words": 15,
    "url": "http://example.com/api/translations/hello/weblate/cs/",
    "web_url": "http://example.com/projects/hello/weblate/cs/"
}

DELETE /api/translations/(string: project)/(string: component)/(string: language)/

バージョン 3.9 で追加.

Deletes a translation.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

• language (string) -- Translation language code

GET /api/translations/(string: project)/(string: component)/(string: language)/changes/

Returns a list of translation changes. This is essentially a translations-scoped GET /api/changes/ accepting the same parameters.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

• language (string) -- Translation language code

Response JSON Object

• results (array) -- array of component objects; see GET /api/changes/(int:id)/

GET /api/translations/(string: project)/(string: component)/(string: language)/units/

Returns a list of translation units.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

• language (string) -- Translation language code

• q (string) -- Search query string 検索 (optional)

Response JSON Object

• results (array) -- array of component objects; see GET /api/units/(int:id)/

POST /api/translations/(string: project)/(string: component)/(string: language)/units/

Add new monolingual unit.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

• language (string) -- Translation language code

Request JSON Object

• key (string) -- Name of translation unit

• value (string) -- The translation unit value

POST /api/translations/(string: project)/(string: component)/(string: language)/autotranslate/

Trigger automatic translation.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

• language (string) -- Translation language code

Request JSON Object

• mode (string) -- 自動翻訳モード

• filter_type (string) -- Automatic translation filter type

• auto_source (string) -- 自動翻訳元

• component (string) -- プロジェクトの共有翻訳メモリに協力を有効にして、追加コンポーネントにアクセスします。

• engines (string) -- 機械翻訳エンジン

• threshold (string) -- スコアしきい値

GET /api/translations/(string: project)/(string: component)/(string: language)/file/

Download current translation file as stored in VCS (without format parameter) or as converted to a standard format (currently supported: Gettext PO, MO, XLIFF and TBX).

注釈

This API endpoint uses different logic for output than rest of API as it operates on whole file rather than on data. Set of accepted format parameter differs and without such parameter you get translation file as stored in VCS.

Query Parameters

• format -- File format to use; if not specified no format conversion happens; supported file formats: po, mo, xliff, xliff11, tbx, csv, xlsx, json, aresource, strings

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

• language (string) -- Translation language code

POST /api/translations/(string: project)/(string: component)/(string: language)/file/

Upload new file with translations.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

• language (string) -- Translation language code

Form Parameters

• string conflicts -- How to deal with conflicts (ignore, replace-translated or replace-approved)

• file file -- Uploaded file

• string email -- 翻訳者のメールアドレス

• string author -- 翻訳者名

• string method -- アップロードの方法 (translate、approve、suggest、fuzzy、replace, source)、参照 see インポート方法

• string fuzzy -- Fuzzy strings processing (empty, process, approve)

CURL example:

curl -X POST \
    -F file=@strings.xml \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/translations/hello/android/cs/file/

GET /api/translations/(string: project)/(string: component)/(string: language)/repository/

Returns information about VCS repository status.

The response is same as for GET /api/components/(string:project)/(string:component)/repository/.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

• language (string) -- Translation language code

POST /api/translations/(string: project)/(string: component)/(string: language)/repository/

Performs given operation on the VCS repository.

See POST /api/projects/(string:project)/repository/ for documentation.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

• language (string) -- Translation language code

Request JSON Object

• operation (string) -- Operation to perform: one of push, pull, commit, reset, cleanup

Response JSON Object

• result (boolean) -- result of the operation

GET /api/translations/(string: project)/(string: component)/(string: language)/statistics/

Returns detailed translation statistics.

バージョン 2.7 で追加.

Parameters

• project (string) -- プロジェクト URL スラッグ

• component (string) -- コンポーネント URL スラッグ

• language (string) -- Translation language code

Response JSON Object

• code (string) -- language code

• failing (int) -- number of failing checks

• failing_percent (float) -- percentage of failing checks

• fuzzy (int) -- number of strings needing review

• fuzzy_percent (float) -- percentage of strings needing review

• total_words (int) -- total number of words

• translated_words (int) -- number of translated words

• last_author (string) -- name of last author

• last_change (timestamp) -- date of last change

• name (string) -- language name

• total (int) -- total number of strings

• translated (int) -- number of translated strings

• translated_percent (float) -- percentage of translated strings

• url (string) -- URL to access the translation (engagement URL)

• url_translate (string) -- URL to access the translation (real translation URL)

Units

バージョン 2.10 で追加.

GET /api/units/

Returns list of translation units.

参考

Unit object attributes are documented at GET /api/units/(int:id)/.

GET /api/units/(int: id)/

バージョン 4.3 で変更: The target and source are now arrays to properly handle plural strings.

Returns information about translation unit.

Parameters

• id (int) -- Unit ID

Response JSON Object

• translation (string) -- URL of a related translation object

• source (array) -- source string

• previous_source (string) -- previous source string used for fuzzy matching

• target (array) -- target string

• id_hash (string) -- unique identifier of the unit

• content_hash (string) -- unique identifier of the source string

• location (string) -- location of the unit in source code

• context (string) -- translation unit context

• note (string) -- translation unit note

• flags (string) -- translation unit flags

• state (int) -- unit state, 0 - not translated, 10 - needs editing, 20 - translated, 30 - approved, 100 - read only

• fuzzy (boolean) -- ユニットが曖昧か査読用にマークされているか

• translated (boolean) -- 単位が翻訳されているかどうか

• approved (boolean) -- 翻訳が承認されているかどうか

• position (int) -- unit position in translation file

• has_suggestion (boolean) -- ユニットに提案があるかどうか

• has_comment (boolean) -- ユニットにコメントがあるかどうか

• has_failing_check (boolean) -- ユニットに検査で不合格となったものがあるか

• num_words (int) -- number of source words

• priority (int) -- translation priority; 100 is default

• id (int) -- unit identifier

• explanation (string) -- String explanation, available on source units, see Additional info on source strings

• extra_flags (string) -- 原文ユニットで使用可能な追加の文字列フラグ、参照 動作のカスタマイズ

• web_url (string) -- URL where the unit can be edited

• souce_unit (string) -- Source unit link; see GET /api/units/(int:id)/

PATCH /api/units/(int: id)/

バージョン 4.3 で追加.

翻訳ユニットを部分的に更新します。

Parameters

• id (int) -- Unit ID

Request JSON Object

• state (int) -- unit state, 0 - not translated, 10 - needs editing, 20 - translated, 30 - approved (need review workflow enabled, see 専任の査読者)

• target (array) -- target string

• explanation (string) -- String explanation, available on source units, see Additional info on source strings

• extra_flags (string) -- 原文ユニットで使用可能な追加の文字列フラグ、参照 動作のカスタマイズ

PUT /api/units/(int: id)/

バージョン 4.3 で追加.

翻訳ユニットをすべて更新します。

Parameters

• id (int) -- Unit ID

Request JSON Object

• state (int) -- unit state, 0 - not translated, 10 - needs editing, 20 - translated, 30 - approved (need review workflow enabled, see 専任の査読者)

• target (array) -- target string

• explanation (string) -- String explanation, available on source units, see Additional info on source strings

• extra_flags (string) -- 原文ユニットで使用可能な追加の文字列フラグ、参照 動作のカスタマイズ

DELETE /api/units/(int: id)/

バージョン 4.3 で追加.

翻訳ユニットを削除します。

Parameters

• id (int) -- Unit ID

変更

バージョン 2.10 で追加.

GET /api/changes/

バージョン 4.1 で変更: 変更のフィルター処理は 4.1 リリースで導入しました。

Returns a list of translation changes.

参考

Change object attributes are documented at GET /api/changes/(int:id)/.

Query Parameters

• user (string) -- Username of user to filters

• action (int) -- Action to filter, can be used several times

• timestamp_after (timestamp) -- ISO 8601 formatted timestamp to list changes after

• timestamp_before (timestamp) -- ISO 8601 formatted timestamp to list changes before

GET /api/changes/(int: id)/

Returns information about translation change.

Parameters

• id (int) -- Change ID

Response JSON Object

• unit (string) -- URL of a related unit object

• translation (string) -- URL of a related translation object

• component (string) -- URL of a related component object

• glossary_term (string) -- URL of a related glossary term object

• user (string) -- URL of a related user object

• author (string) -- URL of a related author object

• timestamp (timestamp) -- event timestamp

• action (int) -- numeric identification of action

• action_name (string) -- text description of action

• target (string) -- event changed text or detail

• id (int) -- change identifier

スクリーンショット

バージョン 2.14 で追加.

GET /api/screenshots/

Returns a list of screenshot string information.

参考

Screenshot object attributes are documented at GET /api/screenshots/(int:id)/.

GET /api/screenshots/(int: id)/

Returns information about screenshot information.

Parameters

• id (int) -- Screenshot ID

Response JSON Object

• name (string) -- name of a screenshot

• component (string) -- URL of a related component object

• file_url (string) -- URL to download a file; see GET /api/screenshots/(int:id)/file/

• units (array) -- link to associated source string information; see GET /api/units/(int:id)/

GET /api/screenshots/(int: id)/file/

Download the screenshot image.

Parameters

• id (int) -- Screenshot ID

POST /api/screenshots/(int: id)/file/

Replace screenshot image.

Parameters

• id (int) -- Screenshot ID

Form Parameters

• file image -- Uploaded file

CURL example:

curl -X POST \
    -F image=@image.png \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/screenshots/1/file/

POST /api/screenshots/(int: id)/units/

Associate source string with screenshot.

Parameters

• id (int) -- Screenshot ID

Form Parameters

• string unit_id -- Unit ID

Response JSON Object

• name (string) -- name of a screenshot

• translation (string) -- URL of a related translation object

• file_url (string) -- URL to download a file; see GET /api/screenshots/(int:id)/file/

• units (array) -- link to associated source string information; see GET /api/units/(int:id)/

DELETE /api/screenshots/(int: id)/units/(int: unit_id)

スクリーンショットと原文の関連付けを削除します。

Parameters

• id (int) -- Screenshot ID

• unit_id -- 原文ユニット ID

POST /api/screenshots/

Creates a new screenshot.

Form Parameters

• file image -- Uploaded file

• string name -- スクリーンショットの名前

• string project_slug -- Project slug

• string component_slug -- Component slug

• string language_code -- 言語コード

Response JSON Object

• name (string) -- name of a screenshot

• component (string) -- URL of a related component object

• file_url (string) -- URL to download a file; see GET /api/screenshots/(int:id)/file/

• units (array) -- link to associated source string information; see GET /api/units/(int:id)/

PATCH /api/screenshots/(int: id)/

スクリーンショットに関する部分的な情報を編集します。

Parameters

• id (int) -- Screenshot ID

Response JSON Object

• name (string) -- name of a screenshot

• component (string) -- URL of a related component object

• file_url (string) -- URL to download a file; see GET /api/screenshots/(int:id)/file/

• units (array) -- link to associated source string information; see GET /api/units/(int:id)/

PUT /api/screenshots/(int: id)/

スクリーンショットのすべての情報を編集します。

Parameters

• id (int) -- Screenshot ID

Response JSON Object

• name (string) -- name of a screenshot

• component (string) -- URL of a related component object

• file_url (string) -- URL to download a file; see GET /api/screenshots/(int:id)/file/

• units (array) -- link to associated source string information; see GET /api/units/(int:id)/

DELETE /api/screenshots/(int: id)/

スクリーンショットを削除します。

Parameters

• id (int) -- Screenshot ID

コンポーネント リストのセット

バージョン 4.0 で追加.

GET /api/component-lists/

コンポーネント リストのセットの一覧を返す。

参考

コンポーネント リストのセットのオブジェクト属性は、GET /api/component-lists/(str:slug)/ に記載されています。

GET /api/component-lists/(str: slug)/

Returns information about component list.

Parameters

• slug (string) -- Component list slug

Response JSON Object

• name (string) -- name of a component list

• slug (string) -- slug of a component list

• show_dashboard (boolean) -- whether to show it on a dashboard

• components (array) -- link to associated components; see GET /api/components/(string:project)/(string:component)/

• auto_assign (array) -- automatic assignment rules

PUT /api/component-lists/(str: slug)/

Changes the component list parameters.

Parameters

• slug (string) -- Component list slug

Request JSON Object

• name (string) -- name of a component list

• slug (string) -- slug of a component list

• show_dashboard (boolean) -- whether to show it on a dashboard

PATCH /api/component-lists/(str: slug)/

Changes the component list parameters.

Parameters

• slug (string) -- Component list slug

Request JSON Object

• name (string) -- name of a component list

• slug (string) -- slug of a component list

• show_dashboard (boolean) -- whether to show it on a dashboard

DELETE /api/component-lists/(str: slug)/

Deletes the component list.

Parameters

• slug (string) -- Component list slug

POST /api/component-lists/(str: slug)/components/

Associate component with a component list.

Parameters

• slug (string) -- Component list slug

Form Parameters

• string component_id -- Component ID

DELETE /api/component-lists/(str: slug)/components/(str: component_slug)

Disassociate a component from the component list.

Parameters

• slug (string) -- Component list slug

• component_slug (string) -- Component slug

用語集

GET /api/glossary/

Returns a list of all glossaries which are associated with a project that user has access to.

参考

Language object attributes are documented at GET /api/languages/(string:language)/.

GET /api/glossary/(int: id)/

用語集の情報を返します。

Parameters

• id (int) -- 用語集 id

Response JSON Object

• name (string) -- 言語コード

• color (string) -- テキストの方向

• source_language (object) -- Object of language plural information

• projects (array) -- link to associated projects; see GET /api/projects/(string:project)/

Example JSON data:

{
    "name": "Hello",
    "id": 1,
    "color": "silver",
    "source_language": {
        "code": "en",
        "name": "English",
        "plural": {
            "id": 75,
            "source": 0,
            "number": 2,
            "formula": "n != 1",
            "type": 1
        },
        "aliases": [
            "english",
            "en_en",
            "base",
            "source",
            "eng"
        ],
        "direction": "ltr",
        "web_url": "http://example.com/languages/en/",
        "url": "http://example.com/api/languages/en/",
        "statistics_url": "http://example.com/api/languages/en/statistics/"
    },
    "project": {
        "name": "Hello",
        "slug": "hello",
        "id": 1,
        "source_language": {
            "code": "en",
            "name": "English",
            "plural": {
                "id": 75,
                "source": 0,
                "number": 2,
                "formula": "n != 1",
                "type": 1
            },
            "aliases": [
                "english",
                "en_en",
                "base",
                "source",
                "eng"
            ],
            "direction": "ltr",
            "web_url": "http://example.com/languages/en/",
            "url": "http://example.com/api/languages/en/",
            "statistics_url": "http://example.com/api/languages/en/statistics/"
        },
        "web_url": "http://example.com/projects/demo1/",
        "url": "http://example.com/api/projects/demo1/",
        "components_list_url": "http://example.com/api/projects/demo1/components/",
        "repository_url": "http://example.com/api/projects/demo1/repository/",
        "statistics_url": "http://example.com/api/projects/demo1/statistics/",
        "changes_list_url": "http://example.com/api/projects/demo1/changes/",
        "languages_url": "http://example.com/api/projects/demo1/languages/"
    },
    "projects_url": "http://example.com/api/glossary/7/projects/",
    "terms_url": "http://example.com/api/glossary/7/terms/",
    "url": "http://example.com/api/glossary/7/"
}

PUT /api/glossary/(int: id)/

用語集のパラメーターを変更します。

Parameters

• id (int) -- 用語集 id

Request JSON Object

• name (string) -- 言語名

• color (string) -- Language direction

• source_language (object) -- Language plural details

PATCH /api/glossary/(int: id)/

用語集のパラメーターを変更します。

Parameters

• id (int) -- 用語集 id

Request JSON Object

• name (string) -- 言語名

• color (string) -- Language direction

• source_language (object) -- Language plural details

DELETE /api/glossary/(int: id)/

用語集を削除します。

Parameters

• id (int) -- 用語集 id

GET /api/glossary/(int: id)/projects/

Returns projects linked with a glossary.

Parameters

• id (int) -- 用語集 id

Response JSON Object

• projects (array) -- 関連するプロジェクト; 参照 GET /api/projects/(string:project)/

POST /api/glossary/(int: id)/projects/

プロジェクトを用語集に関連付けます。

Parameters

• id (int) -- 用語集 id

Form Parameters

• string project_slug -- Project slug

DELETE /api/glossary/(int: id)/projects/

用語集とプロジェクトの関連付けを削除します。

Parameters

• id (int) -- 用語集 id

Form Parameters

• string project_slug -- Project slug

GET /api/glossary/(int: id)/terms/

用語集の用語を一覧表示します。

Parameters

• id (int) -- 用語集 id

POST /api/glossary/(int: id)/terms/

用語を用語集に関連付けます。

Parameters

• id (int) -- 用語集 id

Request JSON Object

• language (object) -- 用語の言語

• source (string) -- 用語の原文

• target (string) -- 用語のターゲット文字列

GET /api/glossary/(int: id)/terms/(int: term_id)/

用語集に関連付けられた用語を取得します。

Parameters

• id (int) -- 用語集 id

• term_id (int) -- ID of term

PUT /api/glossary/(int: id)/terms/(int: term_id)/

用語集に関連付けられた用語を編集します。

Parameters

• id (int) -- 用語集 id

• term_id (int) -- ID of term

Request JSON Object

• language (object) -- 用語の言語

• source (string) -- 用語の原文

• target (string) -- 用語のターゲット文字列

PATCH /api/glossary/(int: id)/terms/(int: term_id)/

用語集に関連付けられた用語を編集します。

Parameters

• id (int) -- 用語集 id

• term_id (int) -- ID of term

Request JSON Object

• language (object) -- 用語の言語

• source (string) -- 用語の原文

• target (string) -- 用語のターゲット文字列

DELETE /api/glossary/(int: id)/terms/(int: term_id)/

Delete a term associated with a glossary.

Parameters

• id (int) -- 用語集 id

• term_id (int) -- ID of term

Tasks

バージョン 4.4 で追加.

GET /api/tasks/

タスクの一覧は現在使用できません。

GET /api/tasks/(str: uuid)/

タスクに関する情報を返します

Parameters

• uuid (string) -- Task UUID

Response JSON Object

• completed (boolean) -- タスクが完了したかどうか

• progress (int) -- Task progress in percent

• result (object) -- タスクの結果または進捗状況の詳細

• log (string) -- タスクの履歴

通知フック

Notification hooks allow external applications to notify Weblate that the VCS repository has been updated.

You can use repository endpoints for projects, components and translations to update individual repositories; see POST /api/projects/(string:project)/repository/ for documentation.

GET /hooks/update/(string: project)/(string: component)/

バージョン 2.6 で非推奨: Please use POST /api/components/(string:project)/(string:component)/repository/ instead which works properly with authentication for ACL limited projects.

Triggers update of a component (pulling from VCS and scanning for translation changes).

GET /hooks/update/(string: project)/

バージョン 2.6 で非推奨: Please use POST /api/projects/(string:project)/repository/ instead which works properly with authentication for ACL limited projects.

Triggers update of all components in a project (pulling from VCS and scanning for translation changes).

POST /hooks/github/

Special hook for handling GitHub notifications and automatically updating matching components.

注釈

GitHub includes direct support for notifying Weblate: enable Weblate service hook in repository settings and set the URL to the URL of your Weblate installation.

参考

Automatically receiving changes from GitHub

For instruction on setting up GitHub integration

https://docs.github.com/en/free-pro-team@latest/github/extending-github/about-webhooks

Generic information about GitHub Webhooks

ENABLE_HOOKS

For enabling hooks for whole Weblate

POST /hooks/gitlab/

Special hook for handling GitLab notifications and automatically updating matching components.

参考

Automatically receiving changes from GitLab

For instruction on setting up GitLab integration

https://docs.gitlab.com/ce/user/project/integrations/webhooks.html

Generic information about GitLab Webhooks

ENABLE_HOOKS

For enabling hooks for whole Weblate

POST /hooks/bitbucket/

Special hook for handling Bitbucket notifications and automatically updating matching components.

参考

Automatically receiving changes from Bitbucket

For instruction on setting up Bitbucket integration

https://support.atlassian.com/bitbucket-cloud/docs/manage-webhooks/

Generic information about Bitbucket Webhooks

ENABLE_HOOKS

For enabling hooks for whole Weblate

POST /hooks/pagure/

バージョン 3.3 で追加.

Pagure 通知を処理し、一致するコンポーネントを自動的に更新するための特別なフック。

参考

Pagure からの変更を自動的に受信

Pagure 統合の設定手順について

https://docs.pagure.org/pagure/usage/using_webhooks.html

Pagure WEB フックに関する一般的な情報

ENABLE_HOOKS

For enabling hooks for whole Weblate

POST /hooks/azure/

バージョン 3.8 で追加.

Special hook for handling Azure Repos notifications and automatically updating matching components.

参考

Automatically receiving changes from Azure Repos

For instruction on setting up Azure integration

https://docs.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks?view=azure-devops

Generic information about Azure Repos Web Hooks

ENABLE_HOOKS

For enabling hooks for whole Weblate

POST /hooks/gitea/

バージョン 3.9 で追加.

Special hook for handling Gitea Webhook notifications and automatically updating matching components.

参考

Automatically receiving changes from Gitea Repos

For instruction on setting up Gitea integration

https://docs.gitea.io/en-us/webhooks/

Generic information about Gitea Webhooks

ENABLE_HOOKS

For enabling hooks for whole Weblate

POST /hooks/gitee/

バージョン 3.9 で追加.

Special hook for handling Gitee Webhook notifications and automatically updating matching components.

参考

Automatically receiving changes from Gitee Repos

For instruction on setting up Gitee integration

https://gitee.com/help/categories/40

Generic information about Gitee Webhooks

ENABLE_HOOKS

For enabling hooks for whole Weblate

Exports

Weblate provides various exports to allow you to further process the data.

GET /exports/stats/(string: project)/(string: component)/

Query Parameters

• format (string) -- Output format: either json or csv

バージョン 2.6 で非推奨: Please use GET /api/components/(string:project)/(string:component)/statistics/ and GET /api/translations/(string:project)/(string:component)/(string:language)/statistics/ instead; it allows access to ACL controlled projects as well.

Retrieves statistics for given component in given format.

Example request:

GET /exports/stats/weblate/master/ HTTP/1.1
Host: example.com
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

[
    {
        "code": "cs",
        "failing": 0,
        "failing_percent": 0.0,
        "fuzzy": 0,
        "fuzzy_percent": 0.0,
        "last_author": "Michal Čihař",
        "last_change": "2012-03-28T15:07:38+00:00",
        "name": "Czech",
        "total": 436,
        "total_words": 15271,
        "translated": 436,
        "translated_percent": 100.0,
        "translated_words": 3201,
        "url": "http://hosted.weblate.org/engage/weblate/cs/",
        "url_translate": "http://hosted.weblate.org/projects/weblate/master/cs/"
    },
    {
        "code": "nl",
        "failing": 21,
        "failing_percent": 4.8,
        "fuzzy": 11,
        "fuzzy_percent": 2.5,
        "last_author": null,
        "last_change": null,
        "name": "Dutch",
        "total": 436,
        "total_words": 15271,
        "translated": 319,
        "translated_percent": 73.2,
        "translated_words": 3201,
        "url": "http://hosted.weblate.org/engage/weblate/nl/",
        "url_translate": "http://hosted.weblate.org/projects/weblate/master/nl/"
    },
    {
        "code": "el",
        "failing": 11,
        "failing_percent": 2.5,
        "fuzzy": 21,
        "fuzzy_percent": 4.8,
        "last_author": null,
        "last_change": null,
        "name": "Greek",
        "total": 436,
        "total_words": 15271,
        "translated": 312,
        "translated_percent": 71.6,
        "translated_words": 3201,
        "url": "http://hosted.weblate.org/engage/weblate/el/",
        "url_translate": "http://hosted.weblate.org/projects/weblate/master/el/"
    }
]

RSS フィード

Changes in translations are exported in RSS feeds.

GET /exports/rss/(string: project)/(string: component)/(string: language)/

Retrieves RSS feed with recent changes for a translation.

GET /exports/rss/(string: project)/(string: component)/

Retrieves RSS feed with recent changes for a component.

GET /exports/rss/(string: project)/

Retrieves RSS feed with recent changes for a project.

GET /exports/rss/language/(string: language)/

Retrieves RSS feed with recent changes for a language.

GET /exports/rss/

Retrieves RSS feed with recent changes for Weblate instance.

参考

RSS Wikipedia 参照

Weblate クライアント

バージョン 2.7 で追加: Weblate 2.7 以降、wlc ユーティリティにすべて対応しています。古いバージョンを使用している場合は、API との互換性に問題が発生することがあります。

導入

Weblate クライアントは個別に提供され、Python モジュールを含んでいます。以下のコマンドを使用するには、wlc をインストールする必要があります。

pip3 install wlc

Docker の使用

Weblate クライアントは Docker イメージでも動作します。

イメージは Docker Hub: https://hub.docker.com/r/weblate/wlc で公開しています

インストール:

docker pull weblate/wlc

Docker コンテナは Weblate のデフォルト設定を使用して、localhost にデプロイされた API に接続します。API URL と API_KEY は、Weblate が受け入れる引数で設定できます。

コンテナは次のコマンドの構文で起動する:

docker run --rm weblate/wlc [WLC_ARGS]

例:

docker run --rm weblate/wlc --url https://hosted.weblate.org/api/ list-projects

はじめに

wlc 設定は ~/.config/weblate に保存されます（他の場所については 設定ファイル for other locations を参照）。環境に合わせて作成してください:

[weblate]
url = https://hosted.weblate.org/api/

[keys]
https://hosted.weblate.org/api/ = APIKEY

そのあと、デフォルト サーバーでコマンドを呼び出せます。

wlc ls
wlc commit sandbox/hello-world

参考

設定ファイル

概要

wlc [arguments] <command> [options]

コマンドは、実際に実行が必要な操作を示しています。

解説

Weblate クライアントは Python ライブラリであり、API を使用して Weblate をリモートで管理するためのコマンドライン ユーティリティです。コマンドライン ユーティリティは、wlc として呼び出すことができ、wlc に内蔵しています。

引数

プログラムは、出力形式を定義する以下の引数、または使用する Weblate インスタンスを受け入れます。これらは、コマンドの前に入力が必要です。

--format {csv,json,text,html}

出力形式を指定する。

--url URL

API の URL を指定します。設定ファイル内の値を上書きします、参照 設定ファイル。URL の末尾は /api/ にします（例 https://hosted.weblate.org/api/。

--key KEY

使用する API ユーザー キーを指定します。設定ファイルの値を上書きします、参照 設定ファイル。キーは Weblate のプロファイルで確認できます。

--config PATH

設定ファイルのパスを上書きします、参照 設定ファイル。

--config-section SECTION

使用中の設定ファイル セクションを上書きします、参照 設定ファイル。

コマンド

次のコマンドを使用できます:

version

現在のバージョンを表示する。

list-languages

Weblate で使用している言語を一覧表示する。

list-projects

Weblate のプロジェクトを一覧表示する。

list-components

Weblate のコンポーネントを一覧表示する。

list-translations

Weblate の翻訳を一覧表示する。

show

Weblate オブジェクトを表示する（変換、コンポーネントまたはプロジェクト）。

ls

Weblate のオブジェクト（翻訳、コンポーネントまたはプロジェクト）を一覧表示する。

commit

Weblate オブジェクト（翻訳、コンポーネントまたはプロジェクト）で行われた変更をコミットする)。

pull

リモートリポジトリの変更を Weblate オブジェクト（翻訳、コンポーネント、またはプロジェクト）にプルする。

push

Weblate オブジェクトの変更をリモート リポジトリ（翻訳、コンポーネント、またはプロジェクト）にプッシュする。

reset

バージョン 0.7 で追加: wlc 0.7 から対応。

Weblate オブジェクトの変更をリセットして、リモート リポジトリ（翻訳、コンポーネント、またはプロジェクト）に一致させる。

cleanup

バージョン 0.9 で追加: wlc 0.9 から対応。

リモート リポジトリ（翻訳、コンポーネントまたはプロジェクト）に一致する Weblate オブジェクト内の記録されていない変更を削除する。

repo

指定した Weblate オブジェクト（翻訳、コンポーネントまたはプロジェクト）のリポジトリ状況を表示する。

statistics

指定した Weblate オブジェクト（翻訳、コンポーネント、またはプロジェクト）の詳細な統計情報を表示する。

lock-status

バージョン 0.5 で追加: wlc 0.5 から対応。

ロックの状況を表示する。

lock

バージョン 0.5 で追加: wlc 0.5 から対応。

Weblate での今後の翻訳からコンポーネントをロックする。

unlock

バージョン 0.5 で追加: wlc 0.5 から対応。

Weblate コンポーネントの翻訳のロックを解除する。

changes

バージョン 0.7 で追加: wlc 0.7 および Weblate 2.10 以降から対応。

指定したオブジェクトの変更を表示する。

download

バージョン 0.7 で追加: wlc 0.7 から対応。

翻訳ファイルをダウンロードする。

--convert

ファイル形式を変換する、ファイル形式を指定しない場合はサーバー上で変換は行われず、ファイルはそのままリポジトリにダウンロードされる。

--output

出力を保存するファイルを指定する。指定しない場合は、標準出力に出力される。

upload

バージョン 0.9 で追加: wlc 0.9 から対応。

翻訳ファイルをアップロードする。

--overwrite

アップロード時に既存の翻訳を上書きする。

--input

内容を読み込むファイル。指定しない場合は、stdin から読み込む。

ヒント

--help を付加すると、個々のコマンドの呼び出しに関するより詳細な情報を取得できる、例 wlc ls --help。

設定ファイル

.weblate、 .weblate.ini、 weblate.ini

バージョン 1.6 で変更: 拡張子が .ini のファイルにも対応する。

プロジェクト別の構成ファイル

C:\Users\NAME\AppData\weblate.ini

バージョン 1.6 で追加.

Windows のユーザー設定ファイル。

~/.config/weblate

ユーザー設定ファイル

/etc/xdg/weblate

システム全体の設定ファイル

このプログラムは XDG の仕様に準拠しているので、環境変数 XDG_CONFIG_HOME や XDG_CONFIG_DIRS を使って設定ファイルの配置を調整できます。Windows では、設定ファイルは APPDATA ディレクトリに保存することをお勧めします。

以下の設定は [weblate] セクションで設定できます（ --config-section でカスタマイズできます）:

key

Weblate に接続するための API キー。

url

API サーバの URL、デフォルトは http://127.0.0.1:8000/api/。

translation

デフォルトの翻訳へのパス - コンポーネントまたはプロジェクト。

設定ファイルは INI ファイルです、たとえば:

[weblate]
url = https://hosted.weblate.org/api/
key = APIKEY
translation = weblate/master

さらに、API キーは [keys] セクションに保存できる。

[keys]
https://hosted.weblate.org/api/ = APIKEY

これにより、VCS リポジトリー内の .weblate 設定を使用して、wlc がどのサーバーと通信すべきかを認識しながら、個人設定に鍵を保管することができます。

例

現在のプログラムのバージョンを表示する:

$ wlc version
version: 0.1

すべてのプロジェクトを一覧表示する:

$ wlc list-projects
name: Hello
slug: hello
url: http://example.com/api/projects/hello/
web: https://weblate.org/
web_url: http://example.com/projects/hello/

また、wlc で作業するプロジェクトを指定できる:

$ cat .weblate
[weblate]
url = https://hosted.weblate.org/api/
translation = weblate/master

$ wlc show
branch: master
file_format: po
source_language: en
filemask: weblate/locale/*/LC_MESSAGES/django.po
git_export: https://hosted.weblate.org/git/weblate/master/
license: GPL-3.0+
license_url: https://spdx.org/licenses/GPL-3.0+
name: master
new_base: weblate/locale/django.pot
project: weblate
repo: git://github.com/WeblateOrg/weblate.git
slug: master
template:
url: https://hosted.weblate.org/api/components/weblate/master/
vcs: git
web_url: https://hosted.weblate.org/projects/weblate/master/

この設定により、現在のプロジェクトの保留中の変更を簡単にコミットできる:

$ wlc commit

Weblate's Python API

導入

The Python API is shipped separately, you need to install the Weblate クライアント: (wlc) to have it.

pip install wlc

wlc

WeblateException

exception wlc.WeblateException

Base class for all exceptions.

Weblate

class wlc.Weblate(key='', url=None, config=None)

パラメータ

• key (str) -- User key

• url (str) -- API server URL, if not specified default is used

• config (wlc.config.WeblateConfig) -- Configuration object, overrides any other parameters.

Access class to the API, define API key and optionally API URL.

get(path)

パラメータ

path (str) -- Request path

戻り値の型

object

Performs a single API GET call.

post(path, **kwargs)

パラメータ

path (str) -- Request path

戻り値の型

object

Performs a single API GET call.

wlc.config

WeblateConfig

class wlc.config.WeblateConfig(section='wlc')

パラメータ

section (str) -- Configuration section to use

Configuration file parser following XDG specification.

load(path=None)

パラメータ

path (str) -- Path from which to load configuration.

Loads configuration from a file, if none is specified, it loads from the wlc configuration file (~/.config/wlc) placed in your XDG configuration path (/etc/xdg/wlc).

wlc.main

wlc.main.main(settings=None, stdout=None, args=None)

パラメータ

• settings (list) -- Settings to override as list of tuples

• stdout (object) -- stdout file object for printing output, uses sys.stdout as default

• args (list) -- Command-line arguments to process, uses sys.args as default

Main entry point for command-line interface.

@wlc.main.register_command(command)

Decorator to register Command class in main parser used by main().

Command

class wlc.main.Command(args, config, stdout=None)

Main class for invoking commands.

Configuration instructions

Installing Weblate

Installing using Docker

With dockerized Weblate deployment you can get your personal Weblate instance up and running in seconds. All of Weblate's dependencies are already included. PostgreSQL is set up as the default database.

Hardware requirements

Weblate should run on all contemporary hardware without problems, the following is the minimal configuration required to run Weblate on a single host (Weblate, database and webserver):

• 2 GB of RAM

• 2 CPU cores

• 1 GB of storage space

The more memory the better - it is used for caching on all levels (filesystem, database and Weblate).

Many concurrent users increases the amount of needed CPU cores. For hundreds of translation components at least 4 GB of RAM is recommended.

The typical database storage usage is around 300 MB per 1 million hosted words. Storage space needed for cloned repositories varies, but Weblate tries to keep their size minimal by doing shallow clones.

注釈

Actual requirements for your installation of Weblate vary heavily based on the size of the translations managed in it.

導入

The following examples assume you have a working Docker environment, with docker-compose installed. Please check the Docker documentation for instructions.

1. Clone the weblate-docker repo:

   git clone https://github.com/WeblateOrg/docker-compose.git weblate-docker
   cd weblate-docker
   

2. Create a docker-compose.override.yml file with your settings. See Docker environment variables for full list of environment variables.

   version: '3'
   services:
     weblate:
       ports:
         - 80:8080
       environment:
         WEBLATE_EMAIL_HOST: smtp.example.com
         WEBLATE_EMAIL_HOST_USER: user
         WEBLATE_EMAIL_HOST_PASSWORD: pass
         WEBLATE_SERVER_EMAIL: weblate@example.com
         WEBLATE_DEFAULT_FROM_EMAIL: weblate@example.com
         WEBLATE_SITE_DOMAIN: weblate.example.com
         WEBLATE_ADMIN_PASSWORD: password for the admin user
         WEBLATE_ADMIN_EMAIL: weblate.admin@example.com
   

   注釈

   If WEBLATE_ADMIN_PASSWORD is not set, the admin user is created with a random password shown on first startup.

   The provided example makes Weblate listen on port 80, edit the port mapping in the docker-compose.override.yml file to change it.

3. Start Weblate containers:

   docker-compose up
   

Enjoy your Weblate deployment, it's accessible on port 80 of the weblate container.

バージョン 2.15-2 で変更: The setup has changed recently, priorly there was separate web server container, since 2.15-2 the web server is embedded in the Weblate container.

バージョン 3.7.1-6 で変更: In July 2019 (starting with the 3.7.1-6 tag), the containers are not running as a root user. This has changed the exposed port from 80 to 8080.

参考

Invoking management commands

Docker container with HTTPS support

Please see 導入 for generic deployment instructions, this section only mentions differences compared to it.

Using own SSL certificates

バージョン 3.8-3 で追加.

In case you have own SSL certificate you want to use, simply place the files into the Weblate data volume (see Docker container volumes):

• ssl/fullchain.pem containing the certificate including any needed CA certificates

• ssl/privkey.pem containing the private key

Both of these files must be owned by the same user as the one starting the docker container and have file mask set to 600 (readable and writable only by the owning user).

Additionally, Weblate container will now accept SSL connections on port 4443, you will want to include the port forwarding for HTTPS in docker compose override:

version: '3'
services:
  weblate:
    ports:
      - 80:8080
      - 443:4443

If you already host other sites on the same server, it is likely ports 80 and 443 are used by a reverse proxy, such as NGINX. To pass the HTTPS connection from NGINX to the docker container, you can use the following configuration:

server {
    listen 443;
    listen [::]:443;

    server_name <SITE_URL>;
    ssl_certificate /etc/letsencrypt/live/<SITE>/fullchain.pem;
    ssl_certificate_key /etc/letsencrypt/live/<SITE>/privkey.pem;

    location / {
            proxy_set_header HOST $host;
            proxy_set_header X-Forwarded-Proto https;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header X-Forwarded-Host $server_name;
            proxy_pass https://127.0.0.1:<EXPOSED_DOCKER_PORT>;
    }
}

Replace <SITE_URL>, <SITE> and <EXPOSED_DOCKER_PORT> with actual values from your environment.

Automatic SSL certificates using Let’s Encrypt

In case you want to use Let’s Encrypt automatically generated SSL certificates on public installation, you need to add a reverse HTTPS proxy an additional Docker container, https-portal will be used for that. This is made use of in the docker-compose-https.yml file. Then create a docker-compose-https.override.yml file with your settings:

version: '3'
services:
  weblate:
    environment:
      WEBLATE_EMAIL_HOST: smtp.example.com
      WEBLATE_EMAIL_HOST_USER: user
      WEBLATE_EMAIL_HOST_PASSWORD: pass
      WEBLATE_SITE_DOMAIN: weblate.example.com
      WEBLATE_ADMIN_PASSWORD: password for admin user
  https-portal:
    environment:
      DOMAINS: 'weblate.example.com -> http://weblate:8080'

Whenever invoking docker-compose you need to pass both files to it, and then do:

docker-compose -f docker-compose-https.yml -f docker-compose-https.override.yml build
docker-compose -f docker-compose-https.yml -f docker-compose-https.override.yml up

Upgrading the Docker container

Usually it is good idea to only update the Weblate container and keep the PostgreSQL container at the version you have, as upgrading PostgreSQL is quite painful and in most cases does not bring many benefits.

You can do this by sticking with the existing docker-compose and just pull the latest images and then restart:

docker-compose stop
docker-compose pull
docker-compose up

The Weblate database should be automatically migrated on first startup, and there should be no need for additional manual actions.

注釈

Upgrades across 3.0 are not supported by Weblate. If you are on 2.x series and want to upgrade to 3.x, first upgrade to the latest 3.0.1-x (at time of writing this it is the 3.0.1-7) image, which will do the migration and then continue upgrading to newer versions.

You might also want to update the docker-compose repository, though it's not needed in most case. Please beware of PostgreSQL version changes in this case as it's not straightforward to upgrade the database, see GitHub issue for more info.

管理者サイン イン

After container setup, you can sign in as admin user with password provided in WEBLATE_ADMIN_PASSWORD, or a random password generated on first start if that was not set.

To reset admin password, restart the container with WEBLATE_ADMIN_PASSWORD set to new password.

参考

WEBLATE_ADMIN_PASSWORD、WEBLATE_ADMIN_NAME、WEBLATE_ADMIN_EMAIL

Docker environment variables

Many of Weblate's 設定 can be set in the Docker container using environment variables:

Generic settings

WEBLATE_DEBUG

Configures Django debug mode using DEBUG.

Example:

environment:
  WEBLATE_DEBUG: 1

参考

Disable debug mode.

WEBLATE_LOGLEVEL

Configures the logging verbosity.

WEBLATE_SITE_TITLE

Changes the site-title shown in the header of all pages.

WEBLATE_SITE_DOMAIN

サイトのドメインを設定します。

ヒント

In case it is not set, the first item from WEBLATE_ALLOWED_HOSTS is used.

参考

Set correct site domain、SITE_DOMAIN

WEBLATE_ADMIN_NAME

WEBLATE_ADMIN_EMAIL

Configures the site-admin's name and e-mail. It is used for both ADMINS setting and creating admin user (see WEBLATE_ADMIN_PASSWORD for more info on that).

Example:

environment:
  WEBLATE_ADMIN_NAME: Weblate admin
  WEBLATE_ADMIN_EMAIL: noreply@example.com

参考

管理者サイン イン、Properly configure admins、ADMINS

WEBLATE_ADMIN_PASSWORD

Sets the password for the admin user.

• If not set and admin user does not exist, it is created with a random password shown on first container startup.

• If not set and admin user exists, no action is performed.

• If set the admin user is adjusted on every container startup to match WEBLATE_ADMIN_PASSWORD, WEBLATE_ADMIN_NAME and WEBLATE_ADMIN_EMAIL.

警告

It might be a security risk to store password in the configuration file. Consider using this variable only for initial setup (or let Weblate generate random password on initial startup) or for password recovery.

参考

管理者サイン イン、WEBLATE_ADMIN_PASSWORD、WEBLATE_ADMIN_NAME、WEBLATE_ADMIN_EMAIL

WEBLATE_SERVER_EMAIL

WEBLATE_DEFAULT_FROM_EMAIL

Configures the address for outgoing e-mails.

参考

Configure e-mail sending

WEBLATE_ALLOWED_HOSTS

Configures allowed HTTP hostnames using ALLOWED_HOSTS.

Defaults to * which allows all hostnames.

Example:

environment:
  WEBLATE_ALLOWED_HOSTS: weblate.example.com,example.com

参考

ALLOWED_HOSTS、Allowed hosts setup、Set correct site domain

WEBLATE_REGISTRATION_OPEN

Configures whether registrations are open by toggling REGISTRATION_OPEN.

Example:

environment:
  WEBLATE_REGISTRATION_OPEN: 0

WEBLATE_REGISTRATION_ALLOW_BACKENDS

Configure which authentication methods can be used to create new account via REGISTRATION_ALLOW_BACKENDS.

Example:

environment:
  WEBLATE_REGISTRATION_OPEN: 0
  WEBLATE_REGISTRATION_ALLOW_BACKENDS: azuread-oauth2,azuread-tenant-oauth2

WEBLATE_TIME_ZONE

Configures the used time zone in Weblate, see TIME_ZONE.

注釈

To change the time zone of the Docker container itself, use the TZ environment variable.

Example:

environment:
  WEBLATE_TIME_ZONE: Europe/Prague

WEBLATE_ENABLE_HTTPS

Makes Weblate assume it is operated behind a reverse HTTPS proxy, it makes Weblate use HTTPS in e-mail and API links or set secure flags on cookies.

注釈

This does not make the Weblate container accept HTTPS connections, you need to configure that as well, see Docker container with HTTPS support for examples.

Example:

environment:
  WEBLATE_ENABLE_HTTPS: 1

参考

Set correct site domain

WEBLATE_IP_PROXY_HEADER

Lets Weblate fetch the IP address from any given HTTP header. Use this when using a reverse proxy in front of the Weblate container.

Enables IP_BEHIND_REVERSE_PROXY and sets IP_PROXY_HEADER.

注釈

The format must conform to Django's expectations. Django transforms raw HTTP header names as follows:

• converts all characters to uppercase

• replaces any hyphens with underscores

• prepends HTTP_ prefix

So X-Forwarded-For would be mapped to HTTP_X_FORWARDED_FOR.

Example:

environment:
  WEBLATE_IP_PROXY_HEADER: HTTP_X_FORWARDED_FOR

WEBLATE_SECURE_PROXY_SSL_HEADER

A tuple representing a HTTP header/value combination that signifies a request is secure. This is needed when Weblate is running behind a reverse proxy doing SSL termination which does not pass standard HTTPS headers.

Example:

environment:
  WEBLATE_SECURE_PROXY_SSL_HEADER: HTTP_X_FORWARDED_PROTO,https

参考

SECURE_PROXY_SSL_HEADER

WEBLATE_REQUIRE_LOGIN

Configures sign in required for the whole of the Weblate installation using LOGIN_REQUIRED_URLS.

Example:

environment:
  WEBLATE_REQUIRE_LOGIN: 1

WEBLATE_LOGIN_REQUIRED_URLS_EXCEPTIONS

WEBLATE_ADD_LOGIN_REQUIRED_URLS_EXCEPTIONS

WEBLATE_REMOVE_LOGIN_REQUIRED_URLS_EXCEPTIONS

Adds URL exceptions for sign in required for the whole Weblate installation using LOGIN_REQUIRED_URLS_EXCEPTIONS.

You can either replace whole settings, or modify default value using ADD and REMOVE variables.

WEBLATE_GOOGLE_ANALYTICS_ID

Configures ID for Google Analytics by changing GOOGLE_ANALYTICS_ID.

WEBLATE_GITHUB_USERNAME

Configures GitHub username for GitHub pull-requests by changing GITHUB_USERNAME.

参考

GitHub

WEBLATE_GITHUB_TOKEN

バージョン 4.3 で追加.

Configures GitHub personal access token for GitHub pull-requests via API by changing GITHUB_TOKEN.

参考

GitHub

WEBLATE_GITLAB_USERNAME

Configures GitLab username for GitLab merge-requests by changing GITLAB_USERNAME

参考

GitLab

WEBLATE_GITLAB_TOKEN

Configures GitLab personal access token for GitLab merge-requests via API by changing GITLAB_TOKEN

参考

GitLab

WEBLATE_PAGURE_USERNAME

PAGURE_USERNAME を変更して、Pagure merge-requests 用の Pagure ユーザー名を設定する

参考

Pagure

WEBLATE_PAGURE_TOKEN

PAGURE_TOKEN を変更して、API 経由の Pagure のマージ リクエストに対して、Pagure の個人用アクセス トークンを構成する

参考

Pagure

WEBLATE_SIMPLIFY_LANGUAGES

Configures the language simplification policy, see SIMPLIFY_LANGUAGES.

WEBLATE_DEFAULT_ACCESS_CONTROL

Configures the default アクセス制御 for new projects, see DEFAULT_ACCESS_CONTROL.

WEBLATE_DEFAULT_RESTRICTED_COMPONENT

Configures the default value for Restricted access for new components, see DEFAULT_RESTRICTED_COMPONENT.

WEBLATE_DEFAULT_TRANSLATION_PROPAGATION

Configures the default value for 翻訳の伝達を許可する for new components, see DEFAULT_TRANSLATION_PROPAGATION.

WEBLATE_DEFAULT_COMMITER_EMAIL

Configures DEFAULT_COMMITER_EMAIL.

WEBLATE_DEFAULT_COMMITER_NAME

Configures DEFAULT_COMMITER_NAME.

WEBLATE_AKISMET_API_KEY

Configures the Akismet API key, see AKISMET_API_KEY.

WEBLATE_GPG_IDENTITY

Configures GPG signing of commits, see WEBLATE_GPG_IDENTITY.

参考

Signing Git commits with GnuPG

WEBLATE_URL_PREFIX

Configures URL prefix where Weblate is running, see URL_PREFIX.

WEBLATE_SILENCED_SYSTEM_CHECKS

Configures checks which you do not want to be displayed, see SILENCED_SYSTEM_CHECKS.

WEBLATE_CSP_SCRIPT_SRC

WEBLATE_CSP_IMG_SRC

WEBLATE_CSP_CONNECT_SRC

WEBLATE_CSP_STYLE_SRC

WEBLATE_CSP_FONT_SRC

Allows to customize Content-Security-Policy HTTP header.

参考

Content security policy、CSP_SCRIPT_SRC、CSP_IMG_SRC、CSP_CONNECT_SRC、CSP_STYLE_SRC、CSP_FONT_SRC

WEBLATE_LICENSE_FILTER

LICENSE_FILTER の設定。

WEBLATE_HIDE_VERSION

HIDE_VERSION の設定。

WEBLATE_BASIC_LANGUAGES

BASIC_LANGUAGES の設定。

Machine translation settings

WEBLATE_MT_APERTIUM_APY

Enables Apertium machine translation and sets MT_APERTIUM_APY

WEBLATE_MT_AWS_REGION

WEBLATE_MT_AWS_ACCESS_KEY_ID

WEBLATE_MT_AWS_SECRET_ACCESS_KEY

Configures AWS machine translation.

environment:
  WEBLATE_MT_AWS_REGION: us-east-1
  WEBLATE_MT_AWS_ACCESS_KEY_ID: AKIAIOSFODNN7EXAMPLE
  WEBLATE_MT_AWS_SECRET_ACCESS_KEY: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

WEBLATE_MT_DEEPL_KEY

Enables DeepL machine translation and sets MT_DEEPL_KEY

WEBLATE_MT_DEEPL_API_VERSION

使用する DeepL API のバージョンを設定します、参照 MT_DEEPL_API_VERSION。

WEBLATE_MT_GOOGLE_KEY

Enables Google Translate and sets MT_GOOGLE_KEY

WEBLATE_MT_MICROSOFT_COGNITIVE_KEY

Enables Microsoft Cognitive Services Translator and sets MT_MICROSOFT_COGNITIVE_KEY

WEBLATE_MT_MICROSOFT_ENDPOINT_URL

Sets MT_MICROSOFT_ENDPOINT_URL, please note this is supposed to contain domain name only.

WEBLATE_MT_MICROSOFT_REGION

Sets MT_MICROSOFT_REGION

WEBLATE_MT_MICROSOFT_BASE_URL

Sets MT_MICROSOFT_BASE_URL

WEBLATE_MT_MODERNMT_KEY

Enables ModernMT and sets MT_MODERNMT_KEY.

WEBLATE_MT_MYMEMORY_ENABLED

Enables MyMemory machine translation and sets MT_MYMEMORY_EMAIL to WEBLATE_ADMIN_EMAIL.

Example:

environment:
  WEBLATE_MT_MYMEMORY_ENABLED: 1

WEBLATE_MT_GLOSBE_ENABLED

Enables Glosbe machine translation.

environment:
  WEBLATE_MT_GLOSBE_ENABLED: 1

WEBLATE_MT_MICROSOFT_TERMINOLOGY_ENABLED

Enables Microsoft Terminology Service machine translation.

environment:
  WEBLATE_MT_MICROSOFT_TERMINOLOGY_ENABLED: 1

WEBLATE_MT_SAP_BASE_URL

WEBLATE_MT_SAP_SANDBOX_APIKEY

WEBLATE_MT_SAP_USERNAME

WEBLATE_MT_SAP_PASSWORD

WEBLATE_MT_SAP_USE_MT

Configures SAP Translation Hub machine translation.

environment:
    WEBLATE_MT_SAP_BASE_URL: "https://example.hana.ondemand.com/translationhub/api/v1/"
    WEBLATE_MT_SAP_USERNAME: "user"
    WEBLATE_MT_SAP_PASSWORD: "password"
    WEBLATE_MT_SAP_USE_MT: 1

Authentication settings

LDAP

WEBLATE_AUTH_LDAP_SERVER_URI

WEBLATE_AUTH_LDAP_USER_DN_TEMPLATE

WEBLATE_AUTH_LDAP_USER_ATTR_MAP

WEBLATE_AUTH_LDAP_BIND_DN

WEBLATE_AUTH_LDAP_BIND_PASSWORD

WEBLATE_AUTH_LDAP_CONNECTION_OPTION_REFERRALS

WEBLATE_AUTH_LDAP_USER_SEARCH

WEBLATE_AUTH_LDAP_USER_SEARCH_FILTER

WEBLATE_AUTH_LDAP_USER_SEARCH_UNION

WEBLATE_AUTH_LDAP_USER_SEARCH_UNION_DELIMITER

LDAP authentication configuration.

Example for direct bind:

environment:
  WEBLATE_AUTH_LDAP_SERVER_URI: ldap://ldap.example.org
  WEBLATE_AUTH_LDAP_USER_DN_TEMPLATE: uid=%(user)s,ou=People,dc=example,dc=net
  # map weblate 'full_name' to ldap 'name' and weblate 'email' attribute to 'mail' ldap attribute.
  # another example that can be used with OpenLDAP: 'full_name:cn,email:mail'
  WEBLATE_AUTH_LDAP_USER_ATTR_MAP: full_name:name,email:mail

Example for search and bind:

environment:
  WEBLATE_AUTH_LDAP_SERVER_URI: ldap://ldap.example.org
  WEBLATE_AUTH_LDAP_BIND_DN: CN=ldap,CN=Users,DC=example,DC=com
  WEBLATE_AUTH_LDAP_BIND_PASSWORD: password
  WEBLATE_AUTH_LDAP_USER_ATTR_MAP: full_name:name,email:mail
  WEBLATE_AUTH_LDAP_USER_SEARCH: CN=Users,DC=example,DC=com

Example for union search and bind:

environment:
  WEBLATE_AUTH_LDAP_SERVER_URI: ldap://ldap.example.org
  WEBLATE_AUTH_LDAP_BIND_DN: CN=ldap,CN=Users,DC=example,DC=com
  WEBLATE_AUTH_LDAP_BIND_PASSWORD: password
  WEBLATE_AUTH_LDAP_USER_ATTR_MAP: full_name:name,email:mail
  WEBLATE_AUTH_LDAP_USER_SEARCH_UNION: ou=users,dc=example,dc=com|ou=otherusers,dc=example,dc=com

Example with search and bind against Active Directory:

environment:
  WEBLATE_AUTH_LDAP_BIND_DN: CN=ldap,CN=Users,DC=example,DC=com
  WEBLATE_AUTH_LDAP_BIND_PASSWORD: password
  WEBLATE_AUTH_LDAP_SERVER_URI: ldap://ldap.example.org
  WEBLATE_AUTH_LDAP_CONNECTION_OPTION_REFERRALS: 0
  WEBLATE_AUTH_LDAP_USER_ATTR_MAP: full_name:name,email:mail
  WEBLATE_AUTH_LDAP_USER_SEARCH: CN=Users,DC=example,DC=com
  WEBLATE_AUTH_LDAP_USER_SEARCH_FILTER: (sAMAccountName=%(user)s)

参考

LDAP authentication

GitHub

WEBLATE_SOCIAL_AUTH_GITHUB_KEY

WEBLATE_SOCIAL_AUTH_GITHUB_SECRET

Enables GitHub authentication.

Bitbucket

WEBLATE_SOCIAL_AUTH_BITBUCKET_KEY

WEBLATE_SOCIAL_AUTH_BITBUCKET_SECRET

Enables Bitbucket authentication.

Facebook

WEBLATE_SOCIAL_AUTH_FACEBOOK_KEY

WEBLATE_SOCIAL_AUTH_FACEBOOK_SECRET

Enables Facebook OAuth 2.

Google

WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_KEY

WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET

WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS

WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_EMAILS

Enables Google OAuth 2.

GitLab

WEBLATE_SOCIAL_AUTH_GITLAB_KEY

WEBLATE_SOCIAL_AUTH_GITLAB_SECRET

WEBLATE_SOCIAL_AUTH_GITLAB_API_URL

Enables GitLab OAuth 2.

Azure Active Directory

WEBLATE_SOCIAL_AUTH_AZUREAD_OAUTH2_KEY

WEBLATE_SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET

Enables Azure Active Directory authentication, see Microsoft Azure Active Directory.

Azure Active Directory with Tenant support

WEBLATE_SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_KEY

WEBLATE_SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_SECRET

WEBLATE_SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_TENANT_ID

Enables Azure Active Directory authentication with Tenant support, see Microsoft Azure Active Directory.

Keycloak

WEBLATE_SOCIAL_AUTH_KEYCLOAK_KEY

WEBLATE_SOCIAL_AUTH_KEYCLOAK_SECRET

WEBLATE_SOCIAL_AUTH_KEYCLOAK_PUBLIC_KEY

WEBLATE_SOCIAL_AUTH_KEYCLOAK_ALGORITHM

WEBLATE_SOCIAL_AUTH_KEYCLOAK_AUTHORIZATION_URL

WEBLATE_SOCIAL_AUTH_KEYCLOAK_ACCESS_TOKEN_URL

Enables Keycloak authentication, see documentation.

Linux vendors

You can enable authentication using Linux vendors authentication services by setting following variables to any value.

WEBLATE_SOCIAL_AUTH_FEDORA

WEBLATE_SOCIAL_AUTH_OPENSUSE

WEBLATE_SOCIAL_AUTH_UBUNTU

Slack

WEBLATE_SOCIAL_AUTH_SLACK_KEY

SOCIAL_AUTH_SLACK_SECRET

Enables Slack authentication, see Slack.

SAML

Self-signed SAML keys are automatically generated on first container startup. In case you want to use own keys, place the certificate and private key in /app/data/ssl/saml.crt and /app/data/ssl/saml.key.

WEBLATE_SAML_IDP_ENTITY_ID

WEBLATE_SAML_IDP_URL

WEBLATE_SAML_IDP_X509CERT

SAML Identity Provider settings, see SAML authentication.

Other authentication settings

WEBLATE_NO_EMAIL_AUTH

Disables e-mail authentication when set to any value.

PostgreSQL database setup

The database is created by docker-compose.yml, so these settings affect both Weblate and PostgreSQL containers.

参考

Database setup for Weblate

POSTGRES_PASSWORD

PostgreSQL password.

POSTGRES_USER

PostgreSQL username.

POSTGRES_DATABASE

PostgreSQL database name.

POSTGRES_HOST

PostgreSQL server hostname or IP address. Defaults to database.

POSTGRES_PORT

PostgreSQL server port. Defaults to none (uses the default value).

POSTGRES_SSL_MODE

Configure how PostgreSQL handles SSL in connection to the server, for possible choices see SSL Mode Descriptions

POSTGRES_ALTER_ROLE

Configures name of role to alter during migrations, see Configuring Weblate to use PostgreSQL.

Database backup settings

参考

Dumped data for backups

WEBLATE_DATABASE_BACKUP

Configures the daily database dump using DATABASE_BACKUP. Defaults to plain.

Caching server setup

Using Redis is strongly recommended by Weblate and you have to provide a Redis instance when running Weblate in Docker.

参考

Enable caching

REDIS_HOST

The Redis server hostname or IP address. Defaults to cache.

REDIS_PORT

The Redis server port. Defaults to 6379.

REDIS_DB

The Redis database number, defaults to 1.

REDIS_PASSWORD

The Redis server password, not used by default.

REDIS_TLS

Enables using SSL for Redis connection.

REDIS_VERIFY_SSL

Can be used to disable SSL certificate verification for Redis connection.

Email server setup

To make outgoing e-mail work, you need to provide a mail server.

Example TLS configuration:

environment:
    WEBLATE_EMAIL_HOST: smtp.example.com
    WEBLATE_EMAIL_HOST_USER: user
    WEBLATE_EMAIL_HOST_PASSWORD: pass

Example SSL configuration:

environment:
    WEBLATE_EMAIL_HOST: smtp.example.com
    WEBLATE_EMAIL_PORT: 465
    WEBLATE_EMAIL_HOST_USER: user
    WEBLATE_EMAIL_HOST_PASSWORD: pass
    WEBLATE_EMAIL_USE_TLS: 0
    WEBLATE_EMAIL_USE_SSL: 1

参考

Configuring outgoing e-mail

WEBLATE_EMAIL_HOST

Mail server hostname or IP address.

参考

WEBLATE_EMAIL_PORT、WEBLATE_EMAIL_USE_SSL、WEBLATE_EMAIL_USE_TLS、EMAIL_HOST

WEBLATE_EMAIL_PORT

Mail server port, defaults to 25.

参考

EMAIL_PORT

WEBLATE_EMAIL_HOST_USER

メール認証ユーザー。

参考

EMAIL_HOST_USER

WEBLATE_EMAIL_HOST_PASSWORD

メール認証のパスワード。

参考

EMAIL_HOST_PASSWORD

WEBLATE_EMAIL_USE_SSL

Whether to use an implicit TLS (secure) connection when talking to the SMTP server. In most e-mail documentation, this type of TLS connection is referred to as SSL. It is generally used on port 465. If you are experiencing problems, see the explicit TLS setting WEBLATE_EMAIL_USE_TLS.

参考

WEBLATE_EMAIL_PORT、WEBLATE_EMAIL_USE_TLS、EMAIL_USE_SSL

WEBLATE_EMAIL_USE_TLS

Whether to use a TLS (secure) connection when talking to the SMTP server. This is used for explicit TLS connections, generally on port 587 or 25. If you are experiencing connections that hang, see the implicit TLS setting WEBLATE_EMAIL_USE_SSL.

参考

WEBLATE_EMAIL_PORT、WEBLATE_EMAIL_USE_SSL、EMAIL_USE_TLS

WEBLATE_EMAIL_BACKEND

Configures Django back-end to use for sending e-mails.

参考

Configure e-mail sending、EMAIL_BACKEND

Error reporting

It is recommended to collect errors from the installation systematically, see Collecting error reports.

To enable support for Rollbar, set the following:

ROLLBAR_KEY

Your Rollbar post server access token.

ROLLBAR_ENVIRONMENT

Your Rollbar environment, defaults to production.

To enable support for Sentry, set following:

SENTRY_DSN

Your Sentry DSN.

SENTRY_ENVIRONMENT

Your Sentry Environment (optional).

CDN の現地化

WEBLATE_LOCALIZE_CDN_URL

WEBLATE_LOCALIZE_CDN_PATH

バージョン 4.2.1 で追加.

Configuration for JavaScript 現地語化 CDN.

The WEBLATE_LOCALIZE_CDN_PATH is path within the container. It should be stored on the persistent volume and not in the transient storage.

One of possibilities is storing that inside the Weblate data dir:

environment:
  WEBLATE_LOCALIZE_CDN_URL: https://cdn.example.com/
  WEBLATE_LOCALIZE_CDN_PATH: /app/data/l10n-cdn

注釈

You are responsible for setting up serving of the files generated by Weblate, it only does stores the files in configured location.

参考

Translating HTML and JavaScript using Weblate CDN、LOCALIZE_CDN_URL、LOCALIZE_CDN_PATH

Changing enabled apps, checks, addons or autofixes

バージョン 3.8-5 で追加.

The built-in configuration of enabled checks, addons or autofixes can be adjusted by the following variables:

WEBLATE_ADD_APPS

WEBLATE_REMOVE_APPS

WEBLATE_ADD_CHECK

WEBLATE_REMOVE_CHECK

WEBLATE_ADD_AUTOFIX

WEBLATE_REMOVE_AUTOFIX

WEBLATE_ADD_ADDONS

WEBLATE_REMOVE_ADDONS

Example:

environment:
  WEBLATE_REMOVE_AUTOFIX: weblate.trans.autofixes.whitespace.SameBookendingWhitespace
  WEBLATE_ADD_ADDONS: customize.addons.MyAddon,customize.addons.OtherAddon

参考

CHECK_LIST、AUTOFIX_LIST、WEBLATE_ADDONS、INSTALLED_APPS

コンテナの設定

CELERY_MAIN_OPTIONS

CELERY_NOTIFY_OPTIONS

CELERY_MEMORY_OPTIONS

CELERY_TRANSLATE_OPTIONS

CELERY_BACKUP_OPTIONS

CELERY_BEAT_OPTIONS

These variables allow you to adjust Celery worker options. It can be useful to adjust concurrency (--concurrency 16) or use different pool implementation (--pool=gevent).

By default, the number of concurrent workers matches the number of processors (except the backup worker, which is supposed to run only once).

Example:

environment:
  CELERY_MAIN_OPTIONS: --concurrency 16

参考

Celery worker options、Background tasks using Celery

UWSGI_WORKERS

Configure how many uWSGI workers should be executed.

It defaults to number of processors + 1.

Example:

environment:
  UWSGI_WORKERS: 32

In case you have a lot of CPU cores and hit out of memory issues, try reducing number of workers:

environment:
  UWSGI_WORKERS: 4
  CELERY_MAIN_OPTIONS: --concurrency 2
  CELERY_NOTIFY_OPTIONS: --concurrency 1
  CELERY_TRANSLATE_OPTIONS: --concurrency 1

Docker container volumes

There is single data volume exported by the Weblate container. The other service containers (PostgreSQL or Redis) have their data volumes as well, but those are not covered by this document.

The data volume is used to store Weblate persistent data such as cloned repositories or to customize Weblate installation.

The placement of the Docker volume on host system depends on your Docker configuration, but usually it is stored in /var/lib/docker/volumes/weblate-docker_weblate-data/_data/. In the container it is mounted as /app/data.

参考

Docker volumes documentation

Further configuration customization

You can further customize Weblate installation in the data volume, see Docker container volumes.

Custom configuration files

You can additionally override the configuration in /app/data/settings-override.py (see Docker container volumes). This is executed after all environment settings are loaded, so it gets completely set up, and can be used to customize anything.

Replacing logo and other static files

バージョン 3.8-5 で追加.

The static files coming with Weblate can be overridden by placing into /app/data/python/customize/static (see Docker container volumes). For example creating /app/data/python/customize/static/favicon.ico will replace the favicon.

ヒント

The files are copied to the corresponding location upon container startup, so a restart of Weblate is needed after changing the content of the volume.

Alternatively you can also include own module (see Customizing Weblate) and add it as separate volume to the Docker container, for example:

weblate:
  volumes:
    - weblate-data:/app/data
    - ./weblate_customization/weblate_customization:/app/data/python/weblate_customization
  environment:
    WEBLATE_ADD_APPS: weblate_customization

Adding own Python modules

バージョン 3.8-5 で追加.

You can place own Python modules in /app/data/python/ (see Docker container volumes) and they can be then loaded by Weblate, most likely by using Custom configuration files.

参考

Customizing Weblate

Select your machine - local or cloud providers

With Docker Machine you can create your Weblate deployment either on your local machine, or on any large number of cloud-based deployments on e.g. Amazon AWS, Greenhost, and many other providers.

Installing on Debian and Ubuntu

Hardware requirements

Weblate should run on all contemporary hardware without problems, the following is the minimal configuration required to run Weblate on a single host (Weblate, database and webserver):

• 2 GB of RAM

• 2 CPU cores

• 1 GB of storage space

The more memory the better - it is used for caching on all levels (filesystem, database and Weblate).

Many concurrent users increases the amount of needed CPU cores. For hundreds of translation components at least 4 GB of RAM is recommended.

The typical database storage usage is around 300 MB per 1 million hosted words. Storage space needed for cloned repositories varies, but Weblate tries to keep their size minimal by doing shallow clones.

注釈

Actual requirements for your installation of Weblate vary heavily based on the size of the translations managed in it.

導入

System requirements

Install the dependencies needed to build the Python modules (see Software requirements):

apt install \
   libxml2-dev libxslt-dev libfreetype6-dev libjpeg-dev libz-dev libyaml-dev \
   libcairo-dev gir1.2-pango-1.0 libgirepository1.0-dev libacl1-dev libssl-dev \
   build-essential python3-gdbm python3-dev python3-pip python3-virtualenv virtualenv git

Install wanted optional dependencies depending on features you intend to use (see Optional dependencies):

apt install tesseract-ocr libtesseract-dev libleptonica-dev

Optionally install software for running production server, see Running server, Database setup for Weblate, Background tasks using Celery. Depending on size of your installation you might want to run these components on dedicated servers.

The local installation instructions:

# Web server option 1: NGINX and uWSGI
apt install nginx uwsgi uwsgi-plugin-python3

# Web server option 2: Apache with ``mod_wsgi``
apt install apache2 libapache2-mod-wsgi

# Caching backend: Redis
apt install redis-server

# Database server: PostgreSQL
apt install postgresql postgresql-contrib

# SMTP server
apt install exim4

Python modules

ヒント

We're using virtualenv to install Weblate in a separate environment from your system. If you are not familiar with it, check virtualenv User Guide.

1. Create the virtualenv for Weblate:

   virtualenv --python=python3 ~/weblate-env
   

2. Activate the virtualenv for Weblate:

   . ~/weblate-env/bin/activate
   

3. Install Weblate including all dependencies:

   pip install Weblate
   

4. Install database driver:

   pip install psycopg2-binary
   

5. Install wanted optional dependencies depending on features you intend to use (some might require additional system libraries, check Optional dependencies):

   pip install ruamel.yaml aeidon boto3 zeep chardet tesserocr
   

Configuring Weblate

注釈

Following steps assume virtualenv used by Weblate is active (what can be done by . ~/weblate-env/bin/activate). In case this is not true, you will have to specify full path to weblate command as ~/weblate-env/bin/weblate.

1. Copy the file ~/weblate-env/lib/python3.7/site-packages/weblate/settings_example.py to ~/weblate-env/lib/python3.7/site-packages/weblate/settings.py.

2. Adjust the values in the new settings.py file to your liking. You can stick with shipped example for testing purposes, but you will want changes for production setup, see Adjusting configuration.

3. Create the database and its structure for Weblate (the example settings use PostgreSQL, check Database setup for Weblate for production ready setup):

   weblate migrate
   

4. Create the administrator user account and copy the password it outputs to the clipboard, and also save it for later use:

   weblate createadmin
   

5. Collect static files for web server (see Running server and Serving static files):

   weblate collectstatic
   

6. Compress JavaScript and CSS files (optional, see Compressing client assets):

   weblate compress
   

7. Start Celery workers. This is not necessary for development purposes, but strongly recommended otherwise. See Background tasks using Celery for more info:

   ~/weblate-env/lib/python3.7/site-packages/weblate/examples/celery start
   

8. Start the development server (see Running server for production setup):

   weblate runserver
   

After installation

Congratulations, your Weblate server is now running and you can start using it.

• You can now access Weblate on http://localhost:8000/.

• Login with admin credentials obtained during installation or register with new users.

• You can now run Weblate commands using weblate command when Weblate virtualenv is active, see Management commands.

• You can stop the test server with Ctrl+C.

Adding translation

1. Open the admin interface (http://localhost:8000/create/project/) and create the project you want to translate. See Project configuration for more details.

   All you need to specify here is the project name and its website.

2. Create a component which is the real object for translation - it points to the VCS repository, and selects which files to translate. See Component configuration for more details.

   The important fields here are: Component name, VCS repository address and mask for finding translatable files. Weblate supports a wide range of formats including gettext PO files, Android resource strings, iOS string properties, Java properties or Qt Linguist files, see Supported file formats for more details.

3. Once the above is completed (it can be lengthy process depending on the size of your VCS repository, and number of messages to translate), you can start translating.

Installing on SUSE and openSUSE

Hardware requirements

Weblate should run on all contemporary hardware without problems, the following is the minimal configuration required to run Weblate on a single host (Weblate, database and webserver):

• 2 GB of RAM

• 2 CPU cores

• 1 GB of storage space

The more memory the better - it is used for caching on all levels (filesystem, database and Weblate).

Many concurrent users increases the amount of needed CPU cores. For hundreds of translation components at least 4 GB of RAM is recommended.

The typical database storage usage is around 300 MB per 1 million hosted words. Storage space needed for cloned repositories varies, but Weblate tries to keep their size minimal by doing shallow clones.

注釈

Actual requirements for your installation of Weblate vary heavily based on the size of the translations managed in it.

導入

System requirements

Install the dependencies needed to build the Python modules (see Software requirements):

zypper install \
   libxslt-devel libxml2-devel freetype-devel libjpeg-devel zlib-devel libyaml-devel \
   cairo-devel typelib-1_0-Pango-1_0 gobject-introspection-devel libacl-devel \
   python3-pip python3-virtualenv python3-devel git

Install wanted optional dependencies depending on features you intend to use (see Optional dependencies):

zypper install tesseract-ocr tesseract-devel leptonica-devel

Optionally install software for running production server, see Running server, Database setup for Weblate, Background tasks using Celery. Depending on size of your installation you might want to run these components on dedicated servers.

The local installation instructions:

# Web server option 1: NGINX and uWSGI
zypper install nginx uwsgi uwsgi-plugin-python3

# Web server option 2: Apache with ``mod_wsgi``
zypper install apache2 apache2-mod_wsgi

# Caching backend: Redis
zypper install redis-server

# Database server: PostgreSQL
zypper install postgresql postgresql-contrib

# SMTP server
zypper install postfix

Python modules

ヒント

We're using virtualenv to install Weblate in a separate environment from your system. If you are not familiar with it, check virtualenv User Guide.

1. Create the virtualenv for Weblate:

   virtualenv --python=python3 ~/weblate-env
   

2. Activate the virtualenv for Weblate:

   . ~/weblate-env/bin/activate
   

3. Install Weblate including all dependencies:

   pip install Weblate
   

4. Install database driver:

   pip install psycopg2-binary
   

5. Install wanted optional dependencies depending on features you intend to use (some might require additional system libraries, check Optional dependencies):

   pip install ruamel.yaml aeidon boto3 zeep chardet tesserocr
   

Configuring Weblate

注釈

Following steps assume virtualenv used by Weblate is active (what can be done by . ~/weblate-env/bin/activate). In case this is not true, you will have to specify full path to weblate command as ~/weblate-env/bin/weblate.

1. Copy the file ~/weblate-env/lib/python3.7/site-packages/weblate/settings_example.py to ~/weblate-env/lib/python3.7/site-packages/weblate/settings.py.

2. Adjust the values in the new settings.py file to your liking. You can stick with shipped example for testing purposes, but you will want changes for production setup, see Adjusting configuration.

3. Create the database and its structure for Weblate (the example settings use PostgreSQL, check Database setup for Weblate for production ready setup):

   weblate migrate
   

4. Create the administrator user account and copy the password it outputs to the clipboard, and also save it for later use:

   weblate createadmin
   

5. Collect static files for web server (see Running server and Serving static files):

   weblate collectstatic
   

6. Compress JavaScript and CSS files (optional, see Compressing client assets):

   weblate compress
   

7. Start Celery workers. This is not necessary for development purposes, but strongly recommended otherwise. See Background tasks using Celery for more info:

   ~/weblate-env/lib/python3.7/site-packages/weblate/examples/celery start
   

8. Start the development server (see Running server for production setup):

   weblate runserver
   

After installation

Congratulations, your Weblate server is now running and you can start using it.

• You can now access Weblate on http://localhost:8000/.

• Login with admin credentials obtained during installation or register with new users.

• You can now run Weblate commands using weblate command when Weblate virtualenv is active, see Management commands.

• You can stop the test server with Ctrl+C.

Adding translation

1. Open the admin interface (http://localhost:8000/create/project/) and create the project you want to translate. See Project configuration for more details.

   All you need to specify here is the project name and its website.

2. Create a component which is the real object for translation - it points to the VCS repository, and selects which files to translate. See Component configuration for more details.

   The important fields here are: Component name, VCS repository address and mask for finding translatable files. Weblate supports a wide range of formats including gettext PO files, Android resource strings, iOS string properties, Java properties or Qt Linguist files, see Supported file formats for more details.

3. Once the above is completed (it can be lengthy process depending on the size of your VCS repository, and number of messages to translate), you can start translating.

Installing on RedHat, Fedora and CentOS

Hardware requirements

Weblate should run on all contemporary hardware without problems, the following is the minimal configuration required to run Weblate on a single host (Weblate, database and webserver):

• 2 GB of RAM

• 2 CPU cores

• 1 GB of storage space

The more memory the better - it is used for caching on all levels (filesystem, database and Weblate).

Many concurrent users increases the amount of needed CPU cores. For hundreds of translation components at least 4 GB of RAM is recommended.

The typical database storage usage is around 300 MB per 1 million hosted words. Storage space needed for cloned repositories varies, but Weblate tries to keep their size minimal by doing shallow clones.

注釈

Actual requirements for your installation of Weblate vary heavily based on the size of the translations managed in it.

導入

System requirements

Install the dependencies needed to build the Python modules (see Software requirements):

dnf install \
   libxslt-devel libxml2-devel freetype-devel libjpeg-devel zlib-devel libyaml-devel \
   cairo-devel pango-devel gobject-introspection-devel libacl-devel \
   python3-pip python3-virtualenv python3-devel git

Install wanted optional dependencies depending on features you intend to use (see Optional dependencies):

dnf install tesseract-langpack-eng tesseract-devel leptonica-devel

Optionally install software for running production server, see Running server, Database setup for Weblate, Background tasks using Celery. Depending on size of your installation you might want to run these components on dedicated servers.

The local installation instructions:

# Web server option 1: NGINX and uWSGI
dnf install nginx uwsgi uwsgi-plugin-python3

# Web server option 2: Apache with ``mod_wsgi``
dnf install apache2 apache2-mod_wsgi

# Caching backend: Redis
dnf install redis

# Database server: PostgreSQL
dnf install postgresql postgresql-contrib

# SMTP server
dnf install postfix

Python modules

ヒント

We're using virtualenv to install Weblate in a separate environment from your system. If you are not familiar with it, check virtualenv User Guide.

1. Create the virtualenv for Weblate:

   virtualenv --python=python3 ~/weblate-env
   

2. Activate the virtualenv for Weblate:

   . ~/weblate-env/bin/activate
   

3. Install Weblate including all dependencies:

   pip install Weblate
   

4. Install database driver:

   pip install psycopg2-binary
   

5. Install wanted optional dependencies depending on features you intend to use (some might require additional system libraries, check Optional dependencies):

   pip install ruamel.yaml aeidon boto3 zeep chardet tesserocr
   

Configuring Weblate

注釈

Following steps assume virtualenv used by Weblate is active (what can be done by . ~/weblate-env/bin/activate). In case this is not true, you will have to specify full path to weblate command as ~/weblate-env/bin/weblate.

1. Copy the file ~/weblate-env/lib/python3.7/site-packages/weblate/settings_example.py to ~/weblate-env/lib/python3.7/site-packages/weblate/settings.py.

2. Adjust the values in the new settings.py file to your liking. You can stick with shipped example for testing purposes, but you will want changes for production setup, see Adjusting configuration.

3. Create the database and its structure for Weblate (the example settings use PostgreSQL, check Database setup for Weblate for production ready setup):

   weblate migrate
   

4. Create the administrator user account and copy the password it outputs to the clipboard, and also save it for later use:

   weblate createadmin
   

5. Collect static files for web server (see Running server and Serving static files):

   weblate collectstatic
   

6. Compress JavaScript and CSS files (optional, see Compressing client assets):

   weblate compress
   

7. Start Celery workers. This is not necessary for development purposes, but strongly recommended otherwise. See Background tasks using Celery for more info:

   ~/weblate-env/lib/python3.7/site-packages/weblate/examples/celery start
   

8. Start the development server (see Running server for production setup):

   weblate runserver
   

After installation

Congratulations, your Weblate server is now running and you can start using it.

• You can now access Weblate on http://localhost:8000/.

• Login with admin credentials obtained during installation or register with new users.

• You can now run Weblate commands using weblate command when Weblate virtualenv is active, see Management commands.

• You can stop the test server with Ctrl+C.

Adding translation

1. Open the admin interface (http://localhost:8000/create/project/) and create the project you want to translate. See Project configuration for more details.

   All you need to specify here is the project name and its website.

2. Create a component which is the real object for translation - it points to the VCS repository, and selects which files to translate. See Component configuration for more details.

   The important fields here are: Component name, VCS repository address and mask for finding translatable files. Weblate supports a wide range of formats including gettext PO files, Android resource strings, iOS string properties, Java properties or Qt Linguist files, see Supported file formats for more details.

3. Once the above is completed (it can be lengthy process depending on the size of your VCS repository, and number of messages to translate), you can start translating.

Installing on macOS

Hardware requirements

Weblate should run on all contemporary hardware without problems, the following is the minimal configuration required to run Weblate on a single host (Weblate, database and webserver):

• 2 GB of RAM

• 2 CPU cores

• 1 GB of storage space

The more memory the better - it is used for caching on all levels (filesystem, database and Weblate).

Many concurrent users increases the amount of needed CPU cores. For hundreds of translation components at least 4 GB of RAM is recommended.

The typical database storage usage is around 300 MB per 1 million hosted words. Storage space needed for cloned repositories varies, but Weblate tries to keep their size minimal by doing shallow clones.

注釈

Actual requirements for your installation of Weblate vary heavily based on the size of the translations managed in it.

導入

System requirements

Install the dependencies needed to build the Python modules (see Software requirements):

brew install pango libjpeg python git libyaml gobject-introspection
pip3 install virtualenv

Make sure pip will be able to find the libffi version provided by homebrew — this will be needed during the installation build step.

export PKG_CONFIG_PATH="/usr/local/opt/libffi/lib/pkgconfig"

Install wanted optional dependencies depending on features you intend to use (see Optional dependencies):

brew install tesseract

Optionally install software for running production server, see Running server, Database setup for Weblate, Background tasks using Celery. Depending on size of your installation you might want to run these components on dedicated servers.

The local installation instructions:

# Web server option 1: NGINX and uWSGI
brew install nginx uwsgi

# Web server option 2: Apache with ``mod_wsgi``
brew install httpd

# Caching backend: Redis
brew install redis

# Database server: PostgreSQL
brew install postgresql

Python modules

ヒント

We're using virtualenv to install Weblate in a separate environment from your system. If you are not familiar with it, check virtualenv User Guide.

1. Create the virtualenv for Weblate:

   virtualenv --python=python3 ~/weblate-env
   

2. Activate the virtualenv for Weblate:

   . ~/weblate-env/bin/activate
   

3. Install Weblate including all dependencies:

   pip install Weblate
   

4. Install database driver:

   pip install psycopg2-binary
   

5. Install wanted optional dependencies depending on features you intend to use (some might require additional system libraries, check Optional dependencies):

   pip install ruamel.yaml aeidon boto3 zeep chardet tesserocr
   

Configuring Weblate

注釈

Following steps assume virtualenv used by Weblate is active (what can be done by . ~/weblate-env/bin/activate). In case this is not true, you will have to specify full path to weblate command as ~/weblate-env/bin/weblate.

1. Copy the file ~/weblate-env/lib/python3.7/site-packages/weblate/settings_example.py to ~/weblate-env/lib/python3.7/site-packages/weblate/settings.py.

2. Adjust the values in the new settings.py file to your liking. You can stick with shipped example for testing purposes, but you will want changes for production setup, see Adjusting configuration.

3. Create the database and its structure for Weblate (the example settings use PostgreSQL, check Database setup for Weblate for production ready setup):

   weblate migrate
   

4. Create the administrator user account and copy the password it outputs to the clipboard, and also save it for later use:

   weblate createadmin
   

5. Collect static files for web server (see Running server and Serving static files):

   weblate collectstatic
   

6. Compress JavaScript and CSS files (optional, see Compressing client assets):

   weblate compress
   

7. Start Celery workers. This is not necessary for development purposes, but strongly recommended otherwise. See Background tasks using Celery for more info:

   ~/weblate-env/lib/python3.7/site-packages/weblate/examples/celery start
   

8. Start the development server (see Running server for production setup):

   weblate runserver
   

After installation

Congratulations, your Weblate server is now running and you can start using it.

• You can now access Weblate on http://localhost:8000/.

• Login with admin credentials obtained during installation or register with new users.

• You can now run Weblate commands using weblate command when Weblate virtualenv is active, see Management commands.

• You can stop the test server with Ctrl+C.

Adding translation

1. Open the admin interface (http://localhost:8000/create/project/) and create the project you want to translate. See Project configuration for more details.

   All you need to specify here is the project name and its website.

2. Create a component which is the real object for translation - it points to the VCS repository, and selects which files to translate. See Component configuration for more details.

   The important fields here are: Component name, VCS repository address and mask for finding translatable files. Weblate supports a wide range of formats including gettext PO files, Android resource strings, iOS string properties, Java properties or Qt Linguist files, see Supported file formats for more details.

3. Once the above is completed (it can be lengthy process depending on the size of your VCS repository, and number of messages to translate), you can start translating.

Installing from sources

1. Please follow the installation instructions for your system first:

   • Installing on Debian and Ubuntu

   • Installing on SUSE and openSUSE

   • Installing on RedHat, Fedora and CentOS

2. Grab the latest Weblate sources using Git (or download a tarball and unpack that):

   git clone https://github.com/WeblateOrg/weblate.git weblate-src
   

   Alternatively you can use released archives. You can download them from our website <https://weblate.org/>. Those downloads are cryptographically signed, please see Verifying release signatures.

3. Install current Weblate code into the virtualenv:

   . ~/weblate-env/bin/activate
   pip install -e weblate-src
   

4. Copy weblate/settings_example.py to weblate/settings.py.

5. Adjust the values in the new settings.py file to your liking. You can stick with shipped example for testing purposes, but you will want changes for production setup, see Adjusting configuration.

6. Create the database used by Weblate, see Database setup for Weblate.

7. Build Django tables, static files and initial data (see Filling up the database and Serving static files):

   weblate migrate
   weblate collectstatic
   weblate compress
   weblate compilemessages
   

   注釈

   This step should be repeated whenever you update the repository.

Installing on OpenShift

With the OpenShift Weblate template you can get your personal Weblate instance up and running in seconds. All of Weblate’s dependencies are already included. PostgreSQL is set up as the default database and persistent volume claims are used.

You can find the template at <https://github.com/WeblateOrg/openshift/>.

導入

The following examples assume you have a working OpenShift v3.x environment, with oc client tool installed. Please check the OpenShift documentation for instructions.

Web Console

Copy the raw content from template.yml and import them into your project, then use the Create button in the OpenShift web console to create your application. The web console will prompt you for the values for all of the parameters used by the template.

CLI

To upload the Weblate template to your current project’s template library, pass the template.yml file with the following command:

$ oc create -f https://raw.githubusercontent.com/WeblateOrg/openshift/main/template.yml \
   -n <PROJECT>

The template is now available for selection using the web console or the CLI.

Parameters

The parameters that you can override are listed in the parameters section of the template. You can list them with the CLI by using the following command and specifying the file to be used:

$ oc process --parameters -f https://raw.githubusercontent.com/WeblateOrg/openshift/main/template.yml

# If the template is already uploaded
$ oc process --parameters -n <PROJECT> weblate

プロビジョニング

You can also use the CLI to process templates and use the configuration that is generated to create objects immediately.

$ oc process -f https://raw.githubusercontent.com/WeblateOrg/openshift/main/template.yml \
    -p APPLICATION_NAME=weblate \
    -p WEBLATE_VERSION=4.3.1-1 \
    -p WEBLATE_SITE_DOMAIN=weblate.app-openshift.example.com \
    -p POSTGRESQL_IMAGE=docker-registry.default.svc:5000/openshift/postgresql:9.6 \
    -p REDIS_IMAGE=docker-registry.default.svc:5000/openshift/redis:3.2 \
    | oc create -f

The Weblate instance should be available after successful migration and deployment at the specified WEBLATE_SITE_DOMAIN parameter.

After container setup, you can sign in as admin user with password provided in WEBLATE_ADMIN_PASSWORD, or a random password generated on first start if that was not set.

To reset admin password, restart the container with WEBLATE_ADMIN_PASSWORD set to new password in the respective Secret.

削除方法

$ oc delete all -l app=<APPLICATION_NAME>
$ oc delete configmap -l app= <APPLICATION_NAME>
$ oc delete secret -l app=<APPLICATION_NAME>
# ATTTENTION! The following command is only optional and will permanently delete all of your data.
$ oc delete pvc -l app=<APPLICATION_NAME>

$ oc delete all -l app=weblate \
    && oc delete secret -l app=weblate \
    && oc delete configmap -l app=weblate \
    && oc delete pvc -l app=weblate

設定

By processing the template a respective ConfigMap will be created and which can be used to customize the Weblate image. The ConfigMap is directly mounted as environment variables and triggers a new deployment every time it is changed. For further configuration options, see Docker environment variables for full list of environment variables.

Installing on Kubernetes

注釈

This guide is looking for contributors experienced with Kubernetes to cover the setup in more details.

With the Kubernetes Helm chart you can get your personal Weblate instance up and running in seconds. All of Weblate’s dependencies are already included. PostgreSQL is set up as the default database and persistent volume claims are used.

You can find the chart at <https://github.com/WeblateOrg/helm/> and it can be displayed at <https://artifacthub.io/packages/helm/weblate/weblate>.

導入

helm repo add weblate https://helm.weblate.org
helm install my-release weblate/weblate

Depending on your setup and experience, choose an appropriate installation method for you:

• Installing using Docker, recommended for production setups.

• Virtualenv installation, recommended for production setups:

  • Installing on Debian and Ubuntu

  • Installing on SUSE and openSUSE

  • Installing on RedHat, Fedora and CentOS

  • Installing on macOS

• Installing from sources, recommended for development.

• Installing on OpenShift

• Installing on Kubernetes

Software requirements

Operating system

Weblate is known to work on Linux, FreeBSD and macOS. Other Unix like systems will most likely work too.

Weblate is not supported on Windows. But it may still work and patches are happily accepted.

Other services

Weblate is using other services for its operation. You will need at least following services running:

• PostgreSQL database server, see Database setup for Weblate.

• Redis server for cache and tasks queue, see Background tasks using Celery.

• SMTP server for outgoing e-mail, see Configuring outgoing e-mail.

Python dependencies

Weblate is written in Python and supports Python 3.6 or newer. You can install dependencies using pip or from your distribution packages, full list is available in requirements.txt.

Most notable dependencies:

Django

https://www.djangoproject.com/

Celery

https://docs.celeryproject.org/

Translate Toolkit

https://toolkit.translatehouse.org/

translation-finder

https://github.com/WeblateOrg/translation-finder

Python Social Auth

https://python-social-auth.readthedocs.io/

Django REST Framework

https://www.django-rest-framework.org/

Optional dependencies

Following modules are necessary for some Weblate features. You can find all of them in requirements-optional.txt.

Mercurial (optional for Mercurial repositories support)

https://www.mercurial-scm.org/

phply (optional for PHP support)

https://github.com/viraptor/phply

tesserocr (optional for screenshots OCR)

https://github.com/sirfz/tesserocr

akismet (optional for suggestion spam protection)

https://github.com/ubernostrum/akismet

ruamel.yaml (optional for YAML files)

https://pypi.org/project/ruamel.yaml/

Zeep (optional for Microsoft Terminology Service)

https://docs.python-zeep.org/

aeidon (optional for Subtitle files)

https://pypi.org/project/aeidon/

Database backend dependencies

Weblate supports PostgreSQL, MySQL and MariaDB, see Database setup for Weblate and backends documentation for more details.

Other system requirements

The following dependencies have to be installed on the system:

Git

https://git-scm.com/

Pango, Cairo and related header files and gir introspection data

https://cairographics.org/、https://pango.gnome.org/、参照 Pango and Cairo

git-review (optional for Gerrit support)

https://pypi.org/project/git-review/

git-svn (optional for Subversion support)

https://git-scm.com/docs/git-svn

tesseract and its data (optional for screenshots OCR)

https://github.com/tesseract-ocr/tesseract

licensee (optional for detecting license when creating component)

https://github.com/licensee/licensee

Build-time dependencies

To build some of the Python dependencies you might need to install their dependencies. This depends on how you install them, so please consult individual packages for documentation. You won't need those if using prebuilt Wheels while installing using pip or when you use distribution packages.

Pango and Cairo

バージョン 3.7 で変更.

Weblate uses Pango and Cairo for rendering bitmap widgets (see Promoting the translation) and rendering checks (see フォントの管理). To properly install Python bindings for those you need to install system libraries first - you need both Cairo and Pango, which in turn need GLib. All those should be installed with development files and GObject introspection data.

Verifying release signatures

Weblate release are cryptographically signed by the releasing developer. Currently this is Michal Čihař. Fingerprint of his PGP key is:

63CB 1DF1 EF12 CF2A C0EE 5A32 9C27 B313 42B7 511D

and you can get more identification information from <https://keybase.io/nijel>.

You should verify that the signature matches the archive you have downloaded. This way you can be sure that you are using the same code that was released. You should also verify the date of the signature to make sure that you downloaded the latest version.

Each archive is accompanied with .asc files which contain the PGP signature for it. Once you have both of them in the same folder, you can verify the signature:

$ gpg --verify Weblate-3.5.tar.xz.asc
gpg: assuming signed data in 'Weblate-3.5.tar.xz'
gpg: Signature made Ne 3. března 2019, 16:43:15 CET
gpg:                using RSA key 87E673AF83F6C3A0C344C8C3F4AA229D4D58C245
gpg: Can't check signature: public key not found

As you can see GPG complains that it does not know the public key. At this point you should do one of the following steps:

• Use wkd to download the key:

$ gpg --auto-key-locate wkd --locate-keys michal@cihar.com
pub   rsa4096 2009-06-17 [SC]
      63CB1DF1EF12CF2AC0EE5A329C27B31342B7511D
uid           [ultimate] Michal Čihař <michal@cihar.com>
uid           [ultimate] Michal Čihař <nijel@debian.org>
uid           [ultimate] [jpeg image of size 8848]
uid           [ultimate] Michal Čihař (Braiins) <michal.cihar@braiins.cz>
sub   rsa4096 2009-06-17 [E]
sub   rsa4096 2015-09-09 [S]

• Download the keyring from Michal's server, then import it with:

$ gpg --import wmxth3chu9jfxdxywj1skpmhsj311mzm

• Download and import the key from one of the key servers:

$ gpg --keyserver hkp://pgp.mit.edu --recv-keys 87E673AF83F6C3A0C344C8C3F4AA229D4D58C245
gpg: key 9C27B31342B7511D: "Michal Čihař <michal@cihar.com>" imported
gpg: Total number processed: 1
gpg:              unchanged: 1

This will improve the situation a bit - at this point you can verify that the signature from the given key is correct but you still can not trust the name used in the key:

$ gpg --verify Weblate-3.5.tar.xz.asc
gpg: assuming signed data in 'Weblate-3.5.tar.xz'
gpg: Signature made Ne 3. března 2019, 16:43:15 CET
gpg:                using RSA key 87E673AF83F6C3A0C344C8C3F4AA229D4D58C245
gpg: Good signature from "Michal Čihař <michal@cihar.com>" [ultimate]
gpg:                 aka "Michal Čihař <nijel@debian.org>" [ultimate]
gpg:                 aka "[jpeg image of size 8848]" [ultimate]
gpg:                 aka "Michal Čihař (Braiins) <michal.cihar@braiins.cz>" [ultimate]
gpg: WARNING: This key is not certified with a trusted signature!
gpg:          There is no indication that the signature belongs to the owner.
Primary key fingerprint: 63CB 1DF1 EF12 CF2A C0EE  5A32 9C27 B313 42B7 511D

The problem here is that anybody could issue the key with this name. You need to ensure that the key is actually owned by the mentioned person. The GNU Privacy Handbook covers this topic in the chapter Validating other keys on your public keyring. The most reliable method is to meet the developer in person and exchange key fingerprints, however you can also rely on the web of trust. This way you can trust the key transitively though signatures of others, who have met the developer in person.

Once the key is trusted, the warning will not occur:

$ gpg --verify Weblate-3.5.tar.xz.asc
gpg: assuming signed data in 'Weblate-3.5.tar.xz'
gpg: Signature made Sun Mar  3 16:43:15 2019 CET
gpg:                using RSA key 87E673AF83F6C3A0C344C8C3F4AA229D4D58C245
gpg: Good signature from "Michal Čihař <michal@cihar.com>" [ultimate]
gpg:                 aka "Michal Čihař <nijel@debian.org>" [ultimate]
gpg:                 aka "[jpeg image of size 8848]" [ultimate]
gpg:                 aka "Michal Čihař (Braiins) <michal.cihar@braiins.cz>" [ultimate]

Should the signature be invalid (the archive has been changed), you would get a clear error regardless of the fact that the key is trusted or not:

$ gpg --verify Weblate-3.5.tar.xz.asc
gpg: Signature made Sun Mar  3 16:43:15 2019 CET
gpg:                using RSA key 87E673AF83F6C3A0C344C8C3F4AA229D4D58C245
gpg: BAD signature from "Michal Čihař <michal@cihar.com>" [ultimate]

Filesystem permissions

The Weblate process needs to be able to read and write to the directory where it keeps data - DATA_DIR. All files within this directory should be owned and writable by the user running Weblate.

The default configuration places them in the same tree as the Weblate sources, however you might prefer to move these to a better location such as: /var/lib/weblate.

Weblate tries to create these directories automatically, but it will fail when it does not have permissions to do so.

You should also take care when running Management commands, as they should be ran under the same user as Weblate itself is running, otherwise permissions on some files might be wrong.

In the Docker container, all files in the /app/data volume have to be owned by weblate user inside the container (UID 1000).

参考

Serving static files

Database setup for Weblate

It is recommended to run Weblate with a PostgreSQL database server.

参考

Use a powerful database engine、Databases、Migrating from other databases to PostgreSQL

PostgreSQL

PostgreSQL is usually the best choice for Django-based sites. It's the reference database used for implementing Django database layer.

注釈

Weblate uses trigram extension which has to be installed separately in some cases. Look for postgresql-contrib or a similarly named package.

参考

PostgreSQL notes

Creating a database in PostgreSQL

It is usually a good idea to run Weblate in a separate database, and separate user account:

# If PostgreSQL was not installed before, set the main password
sudo -u postgres psql postgres -c "\password postgres"

# Create a database user called "weblate"
sudo -u postgres createuser --superuser --pwprompt weblate

# Create the database "weblate" owned by "weblate"
sudo -u postgres createdb -O weblate weblate

ヒント

If you don't want to make the Weblate user a superuser in PostgreSQL, you can omit that. In that case you will have to perform some of the migration steps manually as a PostgreSQL superuser in schema Weblate will use:

CREATE EXTENSION IF NOT EXISTS pg_trgm WITH SCHEMA weblate;

Configuring Weblate to use PostgreSQL

The settings.py snippet for PostgreSQL:

DATABASES = {
    "default": {
        # Database engine
        "ENGINE": "django.db.backends.postgresql",
        # Database name
        "NAME": "weblate",
        # Database user
        "USER": "weblate",
        # Name of role to alter to set parameters in PostgreSQL,
        # use in case role name is different than user used for authentication.
        # "ALTER_ROLE": "weblate",
        # Database password
        "PASSWORD": "password",
        # Set to empty string for localhost
        "HOST": "database.example.com",
        # Set to empty string for default
        "PORT": "",
    }
}

The database migration performs ALTER ROLE on database role used by Weblate. In most cases the name of the role matches username. In more complex setups the role name is different than username and you will get error about non-existing role during the database migration (psycopg2.errors.UndefinedObject: role "weblate@hostname" does not exist). This is known to happen with Azure Database for PostgreSQL, but it's not limited to this evironment. Please set ALTER_ROLE to change name of the role Weblate should alter during the database migration.

MySQL and MariaDB

ヒント

Some Weblate features will perform better with PostgreSQL. This includes searching and translation memory, which both utilize full-text features in the database and PostgreSQL implementation is superior.

Weblate can be also used with MySQL or MariaDB, please see MySQL notes and MariaDB notes for caveats using Django with those. Because of the limitations it is recommended to use PostgreSQL for new installations.

Weblate requires MySQL at least 5.7.8 or MariaDB at least 10.2.7.

Following configuration is recommended for Weblate:

• Use the utf8mb4 charset to allow representation of higher Unicode planes (for example emojis).

• Configure the server with Innodb_large_prefix to allow longer indices on text fields.

• Set the isolation level to READ COMMITTED.

• The SQL mode should be set to STRICT_TRANS_TABLES.

ヒント

In case you are getting #1071 - Specified key was too long; max key length is 767 bytes error, please set Innodb_large_prefix as described above.

Other configurations

Configuring outgoing e-mail

Weblate sends out e-mails on various occasions - for account activation and on various notifications configured by users. For this it needs access to an SMTP server.

The mail server setup is configured using these settings: EMAIL_HOST, EMAIL_HOST_PASSWORD, EMAIL_USE_TLS, EMAIL_USE_TLS, EMAIL_HOST_USER and EMAIL_PORT. Their names are quite self-explanatory, but you can find more info in the Django documentation.

ヒント

In case you get error about not supported authentication (for example SMTP AUTH extension not supported by server), it is most likely caused by using insecure connection and server refuses to authenticate this way. Try enabling EMAIL_USE_TLS in such case.

注釈

You can verify whether outgoing e-mail is working correctly by using the sendtestemail management command (see Invoking management commands for instructions on how to invoke it in different environments).

参考

Email server setup for configuring outgoing e-mail in Docker container.

Running behind reverse proxy

Several features in Weblate rely on being able to get client IP address. This includes レート制限, Spam protection or 監査ログ.

In default configuration Weblate parses IP address from REMOTE_ADDR which is set by the WSGI handler.

In case you are running a reverse proxy, this field will most likely contain its address. You need to configure Weblate to trust additional HTTP headers and parse the IP address from these. This can not be enabled by default as it would allow IP address spoofing for installations not using a reverse proxy. Enabling IP_BEHIND_REVERSE_PROXY might be enough for the most usual setups, but you might need to adjust IP_PROXY_HEADER and IP_PROXY_OFFSET as well.

参考

Spam protection、レート制限、監査ログ、IP_BEHIND_REVERSE_PROXY、IP_PROXY_HEADER、IP_PROXY_OFFSET、SECURE_PROXY_SSL_HEADER

HTTP proxy

Weblate does execute VCS commands and those accept proxy configuration from environment. The recommended approach is to define proxy settings in settings.py:

import os

os.environ["http_proxy"] = "http://proxy.example.com:8080"
os.environ["HTTPS_PROXY"] = "http://proxy.example.com:8080"

参考

Proxy Environment Variables

Adjusting configuration

参考

サンプル設定

Copy weblate/settings_example.py to weblate/settings.py and adjust it to match your setup. You will probably want to adjust the following options:

ADMINS

List of site administrators to receive notifications when something goes wrong, for example notifications on failed merges, or Django errors.

参考

ADMINS

ALLOWED_HOSTS

You need to set this to list the hosts your site is supposed to serve. For example:

ALLOWED_HOSTS = ["demo.weblate.org"]

Alternatively you can include wildcard:

ALLOWED_HOSTS = ["*"]

参考

ALLOWED_HOSTS、WEBLATE_ALLOWED_HOSTS、Allowed hosts setup

SESSION_ENGINE

Configure how your sessions will be stored. In case you keep the default database backend engine, you should schedule: weblate clearsessions to remove stale session data from the database.

If you are using Redis as cache (see Enable caching) it is recommended to use it for sessions as well:

SESSION_ENGINE = "django.contrib.sessions.backends.cache"

参考

Configuring the session engine、SESSION_ENGINE

DATABASES

Connectivity to database server, please check Django's documentation for more details.

参考

Database setup for Weblate、DATABASES、Databases

DEBUG

Disable this for any production server. With debug mode enabled, Django will show backtraces in case of error to users, when you disable it, errors will be sent per e-mail to ADMINS (see above).

Debug mode also slows down Weblate, as Django stores much more info internally in this case.

参考

DEBUG

DEFAULT_FROM_EMAIL

E-mail sender address for outgoing e-mail, for example registration e-mails.

参考

DEFAULT_FROM_EMAIL

SECRET_KEY

Key used by Django to sign some info in cookies, see Django secret key for more info.

参考

SECRET_KEY

SERVER_EMAIL

E-mail used as sender address for sending e-mails to the administrator, for example notifications on failed merges.

参考

SERVER_EMAIL

Filling up the database

After your configuration is ready, you can run weblate migrate to create the database structure. Now you should be able to create translation projects using the admin interface.

In case you want to run an installation non interactively, you can use weblate migrate --noinput, and then create an admin user using createadmin command.

Once you are done, you should also check the Performance report in the admin interface, which will give you hints of potential non optimal configuration on your site.

参考

設定、アクセス制御

Production setup

For a production setup you should carry out adjustments described in the following sections. The most critical settings will trigger a warning, which is indicated by an exclamation mark in the top bar if signed in as a superuser:

It is also recommended to inspect checks triggered by Django (though you might not need to fix all of them):

weblate check --deploy

参考

Deployment checklist

Disable debug mode

Disable Django's debug mode (DEBUG) by:

DEBUG = False

With debug mode on, Django stores all executed queries and shows users backtraces of errors, which is not desired in a production setup.

参考

Adjusting configuration

Properly configure admins

Set the correct admin addresses to the ADMINS setting to defining who will receive e-mails in case something goes wrong on the server, for example:

ADMINS = (("Your Name", "your_email@example.com"),)

参考

Adjusting configuration

Set correct site domain

Adjust site name and domain in the admin interface, otherwise links in RSS or registration e-mails will not work. This is configured using SITE_DOMAIN which should contain site domain name.

バージョン 4.2 で変更: Prior to the 4.2 release the Django sites framework was used instead, please see The “sites” framework.

参考

Allowed hosts setup、Correctly configure HTTPS、 SITE_DOMAIN、WEBLATE_SITE_DOMAIN、ENABLE_HTTPS

Correctly configure HTTPS

It is strongly recommended to run Weblate using the encrypted HTTPS protocol. After enabling it, you should set ENABLE_HTTPS in the settings:

ENABLE_HTTPS = True

ヒント

You might want to set up HSTS as well, see SSL/HTTPS for more details.

参考

ENABLE_HTTPS、Allowed hosts setup、Set correct site domain

Set properly SECURE_HSTS_SECONDS

If your site is served over SSL, you have to consider setting a value for SECURE_HSTS_SECONDS in the settings.py to enable HTTP Strict Transport Security. By default it's set to 0 as shown below.

SECURE_HSTS_SECONDS = 0

If set to a non-zero integer value, the django.middleware.security.SecurityMiddleware sets the HTTP Strict Transport Security header on all responses that do not already have it.

警告

Setting this incorrectly can irreversibly (for some time) break your site. Read the HTTP Strict Transport Security documentation first.

Use a powerful database engine

Please use PostgreSQL for a production environment, see Database setup for Weblate for more info.

参考

Database setup for Weblate、Migrating from other databases to PostgreSQL、Adjusting configuration, Databases

Enable caching

If possible, use Redis from Django by adjusting the CACHES configuration variable, for example:

CACHES = {
    "default": {
        "BACKEND": "django_redis.cache.RedisCache",
        "LOCATION": "redis://127.0.0.1:6379/0",
        # If redis is running on same host as Weblate, you might
        # want to use unix sockets instead:
        # 'LOCATION': 'unix:///var/run/redis/redis.sock?db=0',
        "OPTIONS": {
            "CLIENT_CLASS": "django_redis.client.DefaultClient",
            "PARSER_CLASS": "redis.connection.HiredisParser",
        },
    }
}

参考

アバターのキャッシュ、Django’s cache framework

アバターのキャッシュ

In addition to caching of Django, Weblate performs caching of avatars. It is recommended to use a separate, file-backed cache for this purpose:

CACHES = {
    "default": {
        # Default caching backend setup, see above
        "BACKEND": "django_redis.cache.RedisCache",
        "LOCATION": "unix:///var/run/redis/redis.sock?db=0",
        "OPTIONS": {
            "CLIENT_CLASS": "django_redis.client.DefaultClient",
            "PARSER_CLASS": "redis.connection.HiredisParser",
        },
    },
    "avatar": {
        "BACKEND": "django.core.cache.backends.filebased.FileBasedCache",
        "LOCATION": os.path.join(DATA_DIR, "avatar-cache"),
        "TIMEOUT": 604800,
        "OPTIONS": {
            "MAX_ENTRIES": 1000,
        },
    },
}

参考

ENABLE_AVATARS、AVATAR_URL_PREFIX、Avatars、Enable caching、Django’s cache framework

Configure e-mail sending

Weblate needs to send out e-mails on several occasions, and these e-mails should have a correct sender address, please configure SERVER_EMAIL and DEFAULT_FROM_EMAIL to match your environment, for example:

SERVER_EMAIL = "admin@example.org"
DEFAULT_FROM_EMAIL = "weblate@example.org"

注釈

To disable sending e-mails by Weblate set EMAIL_BACKEND to django.core.mail.backends.dummy.EmailBackend.

This will disable all e-mail delivery including registration or password reset e-mails.

参考

Adjusting configuration、Configuring outgoing e-mail、EMAIL_BACKEND、DEFAULT_FROM_EMAIL、SERVER_EMAIL

Allowed hosts setup

Django requires ALLOWED_HOSTS to hold a list of domain names your site is allowed to serve, leaving it empty will block any requests.

In case this is not configured to match your HTTP server, you will get errors like Invalid HTTP_HOST header: '1.1.1.1'. You may need to add '1.1.1.1' to ALLOWED_HOSTS.

ヒント

On Docker container, this is available as WEBLATE_ALLOWED_HOSTS.

参考

ALLOWED_HOSTS、WEBLATE_ALLOWED_HOSTS、Set correct site domain

Django secret key

The SECRET_KEY setting is used by Django to sign cookies, and you should really generate your own value rather than using the one from the example setup.

You can generate a new key using weblate/examples/generate-secret-key shipped with Weblate.

参考

SECRET_KEY

Home directory

バージョン 2.1 で変更: This is no longer required, Weblate now stores all its data in DATA_DIR.

The home directory for the user running Weblate should exist and be writable by this user. This is especially needed if you want to use SSH to access private repositories, but Git might need to access this directory as well (depending on the Git version you use).

You can change the directory used by Weblate in settings.py, for example to set it to configuration directory under the Weblate tree:

os.environ["HOME"] = os.path.join(BASE_DIR, "configuration")

注釈

On Linux, and other UNIX like systems, the path to user's home directory is defined in /etc/passwd. Many distributions default to a non-writable directory for users used for serving web content (such as apache, www-data or wwwrun), so you either have to run Weblate under a different user, or change this setting.

参考

リポジトリへの接続

Template loading

It is recommended to use a cached template loader for Django. It caches parsed templates and avoids the need to do parsing with every single request. You can configure it using the following snippet (the loaders setting is important here):

TEMPLATES = [
    {
        "BACKEND": "django.template.backends.django.DjangoTemplates",
        "DIRS": [
            os.path.join(BASE_DIR, "templates"),
        ],
        "OPTIONS": {
            "context_processors": [
                "django.contrib.auth.context_processors.auth",
                "django.template.context_processors.debug",
                "django.template.context_processors.i18n",
                "django.template.context_processors.request",
                "django.template.context_processors.csrf",
                "django.contrib.messages.context_processors.messages",
                "weblate.trans.context_processors.weblate_context",
            ],
            "loaders": [
                (
                    "django.template.loaders.cached.Loader",
                    [
                        "django.template.loaders.filesystem.Loader",
                        "django.template.loaders.app_directories.Loader",
                    ],
                ),
            ],
        },
    },
]

参考

django.template.loaders.cached.Loader

Running maintenance tasks

For optimal performance, it is good idea to run some maintenance tasks in the background. This is now automatically done by Background tasks using Celery and covers following tasks:

• Configuration health check (hourly).

• Committing pending changes (hourly), see Lazy commits and commit_pending.

• Updating component alerts (daily).

• Update remote branches (nightly), see AUTO_UPDATE.

• Translation memory backup to JSON (daily), see dump_memory.

• Fulltext and database maintenance tasks (daily and weekly tasks), see cleanuptrans.

バージョン 3.2 で変更: Since version 3.2, the default way of executing these tasks is using Celery and Weblate already comes with proper configuration, see Background tasks using Celery.

System locales and encoding

The system locales should be configured to UTF-8 capable ones. On most Linux distributions this is the default setting. In case it is not the case on your system, please change locales to UTF-8 variant.

For example by editing /etc/default/locale and setting there LANG="C.UTF-8".

In some cases the individual services have separate configuration for locales. For example when using Apache you might want to set it in /etc/apache2/envvars:

export LANG='en_US.UTF-8'
export LC_ALL='en_US.UTF-8'

Using custom certificate authority

Weblate does verify SSL certificates during HTTP requests. In case you are using custom certificate authority which is not trusted in default bundles, you will have to add its certificate as trusted.

The preferred approach is to do this at system level, please check your distro documentation for more details (for example on debian this can be done by placing the CA certificate into /usr/local/share/ca-certificates/ and running update-ca-certificates).

Once this is done, system tools will trust the certificate and this includes Git.

For Python code, you will need to configure requests to use system CA bundle instead of the one shipped with it. This can be achieved by placing following snippet to settings.py (the path is Debian specific):

import os

os.environ["REQUESTS_CA_BUNDLE"] = "/etc/ssl/certs/ca-certificates.crt"

Compressing client assets

Weblate comes with a bunch of JavaScript and CSS files. For performance reasons it is good to compress them before sending to a client. In default configuration this is done on the fly at cost of little overhead. On big installations, it is recommended to enable offline compression mode. This needs to be done in the configuration and the compression has to be triggered on every Weblate upgrade.

The configuration switch is simple by enabling django.conf.settings.COMPRESS_OFFLINE and configuring django.conf.settings.COMPRESS_OFFLINE_CONTEXT (the latter is already included in the example configuration):

COMPRESS_OFFLINE = True

On each deploy you need to compress the files to match current version:

weblate compress

ヒント

The official Docker image has this feature already enabled.

参考

Common Deployment Scenarios、Serving static files

Running server

You will need several services to run Weblate, the recommended setup consists of:

• Database server (see Database setup for Weblate)

• Cache server (see Enable caching)

• Frontend web server for static files and SSL termination (see Serving static files)

• Wsgi server for dynamic content (see Sample configuration for NGINX and uWSGI)

• Celery for executing background tasks (see Background tasks using Celery)

注釈

There are some dependencies between the services, for example cache and database should be running when starting up Celery or uwsgi processes.

In most cases, you will run all services on single (virtual) server, but in case your installation is heavy loaded, you can split up the services. The only limitation on this is that Celery and Wsgi servers need access to DATA_DIR.

Running web server

Running Weblate is not different from running any other Django based program. Django is usually executed as uWSGI or fcgi (see examples for different webservers below).

For testing purposes, you can use the built-in web server in Django:

weblate runserver

警告

DO NOT USE THIS SERVER IN A PRODUCTION SETTING. It has not gone through security audits or performance tests. See also Django documentation on runserver.

ヒント

The Django built-in server serves static files only with DEBUG enabled as it is intended for development only. For production use, please see wsgi setups in Sample configuration for NGINX and uWSGI, Sample configuration for Apache, Sample configuration for Apache and Gunicorn, and Serving static files.

Serving static files

バージョン 2.4 で変更: Prior to version 2.4, Weblate didn't properly use the Django static files framework and the setup was more complex.

Django needs to collect its static files in a single directory. To do so, execute weblate collectstatic --noinput. This will copy the static files into a directory specified by the STATIC_ROOT setting (this defaults to a static directory inside DATA_DIR).

It is recommended to serve static files directly from your web server, you should use that for the following paths:

/static/

Serves static files for Weblate and the admin interface (from defined by STATIC_ROOT).

/media/

Used for user media uploads (e.g. screenshots).

/favicon.ico

Should be rewritten to rewrite a rule to serve /static/favicon.ico.

参考

Compressing client assets、Deploying Django、Deploying static files

Content security policy

The default Weblate configuration enables weblate.middleware.SecurityMiddleware middleware which sets security related HTTP headers like Content-Security-Policy or X-XSS-Protection. These are by default set up to work with Weblate and its configuration, but this might need customization for your environment.

参考

CSP_SCRIPT_SRC、CSP_IMG_SRC、CSP_CONNECT_SRC、CSP_STYLE_SRC、CSP_FONT_SRC

Sample configuration for NGINX and uWSGI

To run production webserver, use the wsgi wrapper installed with Weblate (in virtual env case it is installed as ~/weblate-env/lib/python3.7/site-packages/weblate/wsgi.py). Don't forget to set the Python search path to your virtualenv as well (for example using virtualenv = /home/user/weblate-env in uWSGI).

The following configuration runs Weblate as uWSGI under the NGINX webserver.

Configuration for NGINX (also available as weblate/examples/weblate.nginx.conf):

# This example assumes Weblate is installed in virtualenv in /home/weblate/weblate-env
# and DATA_DIR is set to /home/weblate/data, please adjust paths to match your setup.
server {
    listen 80;
    server_name weblate;
    # Not used
    root /var/www/html;

    location ~ ^/favicon.ico$ {
        # DATA_DIR/static/favicon.ico
        alias /home/weblate/data/static/favicon.ico;
        expires 30d;
    }

    location /static/ {
        # DATA_DIR/static/
        alias /home/weblate/data/static/;
        expires 30d;
    }

    location /media/ {
        # DATA_DIR/media/
        alias /home/weblate/data/media/;
        expires 30d;
    }

    location / {
        include uwsgi_params;
        # Needed for long running operations in admin interface
        uwsgi_read_timeout 3600;
        # Adjust based to uwsgi configuration:
        uwsgi_pass unix:///run/uwsgi/app/weblate/socket;
        # uwsgi_pass 127.0.0.1:8080;
    }
}

Configuration for uWSGI (also available as weblate/examples/weblate.uwsgi.ini):

# This example assumes Weblate is installed in virtualenv in /home/weblate/weblate-env
# and DATA_DIR is set to /home/weblate/data, please adjust paths to match your setup.
[uwsgi]
plugins       = python3
master        = true
protocol      = uwsgi
socket        = 127.0.0.1:8080
wsgi-file     = /home/weblate/weblate-env/lib/python3.7/site-packages/weblate/wsgi.py

# Add path to Weblate checkout if you did not install
# Weblate by pip
# python-path   = /path/to/weblate

# In case you're using virtualenv uncomment this:
virtualenv = /home/weblate/weblate-env

# Needed for OAuth/OpenID
buffer-size   = 8192

# Reload when consuming too much of memory
reload-on-rss = 250

# Increase number of workers for heavily loaded sites
workers       = 8

# Enable threads for Sentry error submission
enable-threads = true

# Child processes do not need file descriptors
close-on-exec = true

# Avoid default 0000 umask
umask = 0022

# Run as weblate user
uid = weblate
gid = weblate

# Enable harakiri mode (kill requests after some time)
# harakiri = 3600
# harakiri-verbose = true

# Enable uWSGI stats server
# stats = :1717
# stats-http = true

# Do not log some errors caused by client disconnects
ignore-sigpipe = true
ignore-write-errors = true
disable-write-exception = true

参考

How to use Django with uWSGI

Sample configuration for Apache

It is recommended to use prefork MPM when using WSGI with Weblate.

The following configuration runs Weblate as WSGI, you need to have enabled mod_wsgi (available as weblate/examples/apache.conf):

#
# VirtualHost for Weblate
#
# This example assumes Weblate is installed in virtualenv in /home/weblate/weblate-env
# and DATA_DIR is set to /home/weblate/data, please adjust paths to match your setup.
#
<VirtualHost *:80>
    ServerAdmin admin@weblate.example.org
    ServerName weblate.example.org

    # DATA_DIR/static/favicon.ico
    Alias /favicon.ico /home/weblate/data/static/favicon.ico

    # DATA_DIR/static/
    Alias /static/ /home/weblate/data/static/
    <Directory /home/weblate/data/static/>
        Require all granted
    </Directory>

    # DATA_DIR/media/
    Alias /media/ /home/weblate/data/media/
    <Directory /home/weblate/data/media/>
        Require all granted
    </Directory>

    # Path to your Weblate virtualenv
    WSGIDaemonProcess weblate python-home=/home/weblate/weblate-env
    WSGIProcessGroup weblate
    WSGIApplicationGroup %{GLOBAL}

    WSGIScriptAlias / /home/weblate/weblate-env/lib/python3.7/site-packages/weblate/wsgi.py process-group=weblate request-timeout=600
    WSGIPassAuthorization On

    <Directory /home/weblate/weblate-env/lib/python3.7/site-packages/weblate/>
        <Files wsgi.py>
        Require all granted
        </Files>
    </Directory>

</VirtualHost>

注釈

Weblate requires Python 3, so please make sure you are running Python 3 variant of the modwsgi. Usually it is available as a separate package, for example libapache2-mod-wsgi-py3.

参考

System locales and encoding、How to use Django with Apache and mod_wsgi

Sample configuration for Apache and Gunicorn

The following configuration runs Weblate in Gunicorn and Apache 2.4 (available as weblate/examples/apache.gunicorn.conf):

#
# VirtualHost for Weblate using gunicorn on localhost:8000
#
# This example assumes Weblate is installed in virtualenv in /home/weblate/weblate-env
# and DATA_DIR is set to /home/weblate/data, please adjust paths to match your setup.
#
<VirtualHost *:443>
    ServerAdmin admin@weblate.example.org
    ServerName weblate.example.org

    # DATA_DIR/static/favicon.ico
    Alias /favicon.ico /home/weblate/data/static/favicon.ico

    # DATA_DIR/static/
    Alias /static/ /home/weblate/data/static/
    <Directory /home/weblate/data/static/>
        Require all granted
    </Directory>

    # DATA_DIR/media/
    Alias /media/ /home/weblate/data/media/
    <Directory /home/weblate/data/media/>
        Require all granted
    </Directory>

    SSLEngine on
    SSLCertificateFile /etc/apache2/ssl/https_cert.cert
    SSLCertificateKeyFile /etc/apache2/ssl/https_key.pem
    SSLProxyEngine On

    ProxyPass /favicon.ico !
    ProxyPass /static/ !
    ProxyPass /media/ !

    ProxyPass / http://localhost:8000/
    ProxyPassReverse / http://localhost:8000/
    ProxyPreserveHost On
</VirtualHost>

参考

How to use Django with Gunicorn

Running Weblate under path

バージョン 1.3 で変更: This is supported since Weblate 1.3.

It is recommended to use prefork MPM when using WSGI with Weblate.

A sample Apache configuration to serve Weblate under /weblate. Again using mod_wsgi (also available as weblate/examples/apache-path.conf):

#
# VirtualHost for Weblate, running under /weblate path
#
# This example assumes Weblate is installed in virtualenv in /home/weblate/weblate-env
# and DATA_DIR is set to /home/weblate/data, please adjust paths to match your setup.
#
<VirtualHost *:80>
    ServerAdmin admin@weblate.example.org
    ServerName weblate.example.org

    # DATA_DIR/static/favicon.ico
    Alias /weblate/favicon.ico /home/weblate/data/static/favicon.ico

    # DATA_DIR/static/
    Alias /weblate/static/ /home/weblate/data/static/
    <Directory /home/weblate/data/static/>
        Require all granted
    </Directory>

    # DATA_DIR/media/
    Alias /weblate/media/ /home/weblate/data/media/
    <Directory /home/weblate/data/media/>
        Require all granted
    </Directory>

    # Path to your Weblate virtualenv
    WSGIDaemonProcess weblate python-home=/home/weblate/weblate-env
    WSGIProcessGroup weblate
    WSGIApplicationGroup %{GLOBAL}

    WSGIScriptAlias /weblate /home/weblate/weblate-env/lib/python3.7/site-packages/weblate/wsgi.py process-group=weblate request-timeout=600
    WSGIPassAuthorization On

    <Directory /home/weblate/weblate-env/lib/python3.7/site-packages/weblate/>
        <Files wsgi.py>
        Require all granted
        </Files>
    </Directory>

</VirtualHost>

Additionally, you will have to adjust weblate/settings.py:

URL_PREFIX = "/weblate"

Background tasks using Celery

バージョン 3.2 で追加.

Weblate uses Celery to process background tasks. The example settings come with eager configuration, which does process all tasks in place, but you want to change this to something more reasonable for a production setup.

A typical setup using Redis as a backend looks like this:

CELERY_TASK_ALWAYS_EAGER = False
CELERY_BROKER_URL = "redis://localhost:6379"
CELERY_RESULT_BACKEND = CELERY_BROKER_URL

You should also start the Celery worker to process the tasks and start scheduled tasks, this can be done directly on the command line (which is mostly useful when debugging or developing):

./weblate/examples/celery start
./weblate/examples/celery stop

Running Celery as system service

Most likely you will want to run Celery as a daemon and that is covered by Daemonization. For the most common Linux setup using systemd, you can use the example files shipped in the examples folder listed below.

Systemd unit to be placed as /etc/systemd/system/celery-weblate.service:

[Unit]
Description=Celery Service (Weblate)
After=network.target

[Service]
Type=forking
User=weblate
Group=weblate
EnvironmentFile=/etc/default/celery-weblate
WorkingDirectory=/home/weblate
RuntimeDirectory=celery
RuntimeDirectoryPreserve=restart
LogsDirectory=celery
ExecStart=/bin/sh -c '${CELERY_BIN} multi start ${CELERYD_NODES} \
  -A ${CELERY_APP} --pidfile=${CELERYD_PID_FILE} \
  --logfile=${CELERYD_LOG_FILE} --loglevel=${CELERYD_LOG_LEVEL} ${CELERYD_OPTS}'
ExecStop=/bin/sh -c '${CELERY_BIN} multi stopwait ${CELERYD_NODES} \
  --pidfile=${CELERYD_PID_FILE}'
ExecReload=/bin/sh -c '${CELERY_BIN} multi restart ${CELERYD_NODES} \
  -A ${CELERY_APP} --pidfile=${CELERYD_PID_FILE} \
  --logfile=${CELERYD_LOG_FILE} --loglevel=${CELERYD_LOG_LEVEL} ${CELERYD_OPTS}'

[Install]
WantedBy=multi-user.target

Environment configuration to be placed as /etc/default/celery-weblate:

# Name of nodes to start
CELERYD_NODES="celery notify memory backup translate"

# Absolute or relative path to the 'celery' command:
CELERY_BIN="/home/weblate/weblate-env/bin/celery"

# App instance to use
# comment out this line if you don't use an app
CELERY_APP="weblate.utils"

# Extra command-line arguments to the worker,
# increase concurency if you get weblate.E019
CELERYD_OPTS="--beat:celery --queues:celery=celery --prefetch-multiplier:celery=4 \
    --queues:notify=notify --prefetch-multiplier:notify=10 \
    --queues:memory=memory --prefetch-multiplier:memory=10 \
    --queues:translate=translate --prefetch-multiplier:translate=4 \
    --concurrency:backup=1 --queues:backup=backup  --prefetch-multiplier:backup=2"

# Logging configuration
# - %n will be replaced with the first part of the nodename.
# - %I will be replaced with the current child process index
#   and is important when using the prefork pool to avoid race conditions.
CELERYD_PID_FILE="/var/run/celery/weblate-%n.pid"
CELERYD_LOG_FILE="/var/log/celery/weblate-%n%I.log"
CELERYD_LOG_LEVEL="INFO"

# Internal Weblate variable to indicate we're running inside Celery
CELERY_WORKER_RUNNING="1"

Logrotate configuration to be placed as /etc/logrotate.d/celery:

/var/log/celery/*.log {
        weekly
        missingok
        rotate 12
        compress
        notifempty
}

注釈

The Celery process has to be executed under the same user as Weblate and the WSGI process, otherwise files in the DATA_DIR will be stored with mixed ownership, leading to runtime issues.

Periodic tasks using Celery beat

Weblate comes with built-in setup for scheduled tasks. You can however define additional tasks in settings.py, for example see Lazy commits.

The tasks are supposed to be executed by Celery beats daemon. In case it is not working properly, it might not be running or its database was corrupted. Check the Celery startup logs in such case to figure out root cause.

Monitoring Celery status

You can use celery_queues to see current length of Celery task queues. In case the queue will get too long, you will also get configuration error in the admin interface.

警告

The Celery errors are by default only logged into Celery log and are not visible to user. In case you want to have overview on such failures, it is recommended to configure Collecting error reports.

参考

Configuration and defaults、Workers Guide、Daemonization、Monitoring and Management Guide、celery_queues

Monitoring Weblate

Weblate provides the /healthz/ URL to be used in simple health checks, for example using Kubernetes.

Collecting error reports

Weblate, as any other software, can fail. In order to collect useful failure states we recommend to use third party services to collect such information. This is especially useful in case of failing Celery tasks, which would otherwise only report error to the logs and you won't get notified on them. Weblate has support for the following services:

Sentry

Weblate has built-in support for Sentry. To use it, it's enough to set SENTRY_DSN in the settings.py:

SENTRY_DSN = "https://id@your.sentry.example.com/"

Rollbar

Weblate has built-in support for Rollbar. To use it, it's enough to follow instructions for Rollbar notifier for Python.

In short, you need to adjust settings.py:

# Add rollbar as last middleware:
MIDDLEWARE = [
    # … other middleware classes …
    "rollbar.contrib.django.middleware.RollbarNotifierMiddleware",
]

# Configure client access
ROLLBAR = {
    "access_token": "POST_SERVER_ITEM_ACCESS_TOKEN",
    "client_token": "POST_CLIENT_ITEM_ACCESS_TOKEN",
    "environment": "development" if DEBUG else "production",
    "branch": "master",
    "root": "/absolute/path/to/code/root",
}

Everything else is integrated automatically, you will now collect both server and client side errors.

Migrating Weblate to another server

Migrating Weblate to another server should be pretty easy, however it stores data in few locations which you should migrate carefully. The best approach is to stop Weblate for the migration.

Migrating database

Depending on your database backend, you might have several options to migrate the database. The most straightforward one is to dump the database on one server and import it on the new one. Alternatively you can use replication in case your database supports it.

The best approach is to use database native tools, as they are usually the most effective (e.g. mysqldump or pg_dump). If you want to migrate between different databases, the only option might be to use Django management to dump and import the database:

# Export current data
weblate dumpdata > /tmp/weblate.dump
# Import dump
weblate loaddata /tmp/weblate.dump

Migrating VCS repositories

The VCS repositories stored under DATA_DIR need to be migrated as well. You can simply copy them or use rsync to do the migration more effectively.

Other notes

Don't forget to move other services Weblate might have been using like Redis, Cron jobs or custom authentication backends.

Weblate deployments

Weblate can be easily installed in your cloud. Please find detailed guide for your platform:

• Installing using Docker

• Installing on OpenShift

• Installing on Kubernetes

Helm Chart

You can install Weblate on Kubernetes using Helm. See <https://github.com/WeblateOrg/helm/tree/master/charts/weblate> for the detailed instructions.

Bitnami Weblate stack

Bitnami provides a Weblate stack for many platforms at <https://bitnami.com/stack/weblate>. The setup will be adjusted during installation, see <https://bitnami.com/stack/weblate/README.txt> for more documentation.

Weblate in YunoHost

The self-hosting project YunoHost provides a package for Weblate. Once you have your YunoHost installation, you may install Weblate as any other application. It will provide you with a fully working stack with backup and restoration, but you may still have to edit your settings file for specific usages.

You may use your administration interface, or this button (it will bring you to your server):

It also is possible to use the commandline interface:

yunohost app install https://github.com/YunoHost-Apps/weblate_ynh

Upgrading Weblate

Docker image upgrades

The official Docker image (see Installing using Docker) has all upgrade steps integrated. There are no manual step besides pulling latest version.

Generic upgrade instructions

Before upgrading, please check the current Software requirements as they might have changed. Once all requirements are installed or updated, please adjust your settings.py to match changes in the configuration (consult settings_example.py for correct values).

Always check Version specific instructions before upgrade. In case you are skipping some versions, please follow instructions for all versions you are skipping in the upgrade. Sometimes it's better to upgrade to some intermediate version to ensure a smooth migration. Upgrading across multiple releases should work, but is not as well tested as single version upgrades.

注釈

It is recommended to perform a full database backup prior to upgrade so that you can roll back the database in case upgrade fails, see Backing up and moving Weblate.

1. Stop wsgi and Celery processes. The upgrade can perform incompatible changes in the database, so it is always safer to avoid old processes running while upgrading.

2. Upgrade Weblate code.

   For pip installs it can be achieved by:

   pip install -U Weblate
   

   With Git checkout you need to fetch new source code and update your installation:

   cd weblate-src
   git pull
   # Update Weblate inside your virtualenv
   . ~/weblate-env/bin/pip install -e .
   # Install dependencies directly when not using virtualenv
   pip install --upgrade -r requirements.txt
   

3. Upgrade configuration file, refer to settings_example.py or Version specific instructions for needed steps.

4. Upgrade database structure:

   weblate migrate --noinput
   

5. Collect updated static files (see Running server and Serving static files):

   weblate collectstatic --noinput
   

6. Compress JavaScript and CSS files (optional, see Compressing client assets):

   weblate compress
   

7. If you are running version from Git, you should also regenerate locale files every time you are upgrading. You can do this by invoking:

   weblate compilemessages
   

8. Verify that your setup is sane (see also Production setup):

   weblate check --deploy
   

9. Restart celery worker (see Background tasks using Celery).

Version specific instructions

Upgrade from 2.x

If you are upgrading from 2.x release, always first upgrade to 3.0.1 and then continue upgrading in the 3.x series. Upgrades skipping this step are not supported and will break.

参考

Upgrade from 2.20 to 3.0 in Weblate 3.0 documentation

Upgrade from 3.x

If you are upgrading from 3.x release, always first upgrade to 4.0.4 or 4.1.1 and then continue upgrading in the 4.x series. Upgrades skipping this step are not supported and will break.

参考

Upgrade from 3.11 to 4.0 in Weblate 4.0 documentation

Upgrade from 4.0 to 4.1

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

• There are several changes in settings_example.py, most notable middleware changes, please adjust your settings accordingly.

• There are new file formats, you might want to include them in case you modified the WEBLATE_FORMATS.

• There are new quality checks, you might want to include them in case you modified the CHECK_LIST.

• DEFAULT_THROTTLE_CLASSES の設定を変更し、API でレート制限のレポート作成を可能とした。

• There are some new and updated requirements.

• There is a change in INSTALLED_APPS.

• The DeepL machine translation now defaults to v2 API, you might need to adjust MT_DEEPL_API_VERSION in case your current DeepL subscription does not support that.

参考

Generic upgrade instructions

Upgrade from 4.1 to 4.2

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

• Upgrade from 3.x releases is not longer supported, please upgrade to 4.0 or 4.1 first.

• There are some new and updated requirements.

• There are several changes in settings_example.py, most notable new middleware and changed application ordering.

• The keys for JSON based formats no longer include leading dot. The strings are adjusted during the database migration, but external components might need adjustment in case you rely on keys in exports or API.

• The Celery configuration was changed to no longer use memory queue. Please adjust your startup scripts and CELERY_TASK_ROUTES setting.

• The Weblate domain is now configured in the settings, see SITE_DOMAIN (or WEBLATE_SITE_DOMAIN). You will have to configure it before running Weblate.

• The username and email fields on user database now should be case insensitive unique. It was mistakenly not enforced with PostgreSQL.

参考

Generic upgrade instructions

Upgrade from 4.2 to 4.3

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

• There are some changes in quality checks, you might want to include them in case you modified the CHECK_LIST.

• The source language attribute was moved from project to a component what is exposed in the API. You will need to update Weblate クライアント in case you are using it.

• The database migration to 4.3 might take long depending on number of strings you are translating (expect around one hour of migration time per 100,000 source strings).

• There is a change in INSTALLED_APPS.

• There is a new setting SESSION_COOKIE_AGE_AUTHENTICATED which complements SESSION_COOKIE_AGE.

• In case you were using hub or lab to integrate with GitHub or GitLab, you will need to reconfigure this, see GITHUB_CREDENTIALS and GITLAB_CREDENTIALS.

• Changed in 4.3.1: The Celery configuration was changed to add memory queue. Please adjust your startup scripts and CELERY_TASK_ROUTES setting.

• Changed in 4.3.2: The post_update method of addons now takes extra skip_push parameter.

参考

Generic upgrade instructions

Upgrade from 4.3 to 4.4

Please follow Generic upgrade instructions in order to perform update.

Notable configuration or dependencies changes:

• There is a change in INSTALLED_APPS.

• Django 3.1 is now required.

• In case you are using MySQL or MariaDB, the minimal required versions have increased, see MySQL and MariaDB.

参考

Generic upgrade instructions

Upgrading from Python 2 to Python 3

Weblate no longer supports Python older than 3.5. In case you are still running on older version, please perform migration to Python 3 first on existing version and upgrade later. See Upgrading from Python 2 to Python 3 in the Weblate 3.11.1 documentation.

Migrating from other databases to PostgreSQL

If you are running Weblate on other dabatase than PostgreSQL, you should migrate to PostgreSQL as that will be the only supported database backend in the 4.0 release. The following steps will guide you in migrating your data between the databases. Please remember to stop both web and Celery servers prior to the migration, otherwise you might end up with inconsistent data.

Creating a database in PostgreSQL

It is usually a good idea to run Weblate in a separate database, and separate user account:

# If PostgreSQL was not installed before, set the main password
sudo -u postgres psql postgres -c "\password postgres"

# Create a database user called "weblate"
sudo -u postgres createuser -D -P weblate

# Create the database "weblate" owned by "weblate"
sudo -u postgres createdb -O weblate weblate

Migrating using Django JSON dumps

The simplest approach for migration is to utilize Django JSON dumps. This works well for smaller installations. On bigger sites you might want to use pgloader instead, see Migrating to PostgreSQL using pgloader.

1. Add PostgreSQL as additional database connection to the settings.py:

DATABASES = {
    "default": {
        # Database engine
        "ENGINE": "django.db.backends.mysql",
        # Database name
        "NAME": "weblate",
        # Database user
        "USER": "weblate",
        # Database password
        "PASSWORD": "password",
        # Set to empty string for localhost
        "HOST": "database.example.com",
        # Set to empty string for default
        "PORT": "",
        # Additional database options
        "OPTIONS": {
            # In case of using an older MySQL server, which has MyISAM as a default storage
            # 'init_command': 'SET storage_engine=INNODB',
            # Uncomment for MySQL older than 5.7:
            # 'init_command': "SET sql_mode='STRICT_TRANS_TABLES'",
            # If your server supports it, see the Unicode issues above
            "charset": "utf8mb4",
            # Change connection timeout in case you get MySQL gone away error:
            "connect_timeout": 28800,
        },
    },
    "postgresql": {
        # Database engine
        "ENGINE": "django.db.backends.postgresql",
        # Database name
        "NAME": "weblate",
        # Database user
        "USER": "weblate",
        # Database password
        "PASSWORD": "password",
        # Set to empty string for localhost
        "HOST": "database.example.com",
        # Set to empty string for default
        "PORT": "",
    },
}

2. Run migrations and drop any data inserted into the tables:

weblate migrate --database=postgresql
weblate sqlflush --database=postgresql | weblate dbshell --database=postgresql

3. Dump legacy database and import to PostgreSQL

weblate dumpdata --all --output weblate.json
weblate loaddata weblate.json --database=postgresql

4. Adjust DATABASES to use just PostgreSQL database as default, remove legacy connection.

Weblate should be now ready to run from the PostgreSQL database.

Migrating to PostgreSQL using pgloader

The pgloader is a generic migration tool to migrate data to PostgreSQL. You can use it to migrate Weblate database.

1. Adjust your settings.py to use PostgreSQL as a database.

2. Migrate the schema in the PostgreSQL database:

   weblate migrate
   weblate sqlflush | weblate dbshell
   

3. Run the pgloader to transfer the data. The following script can be used to migrate the database, but you might want to learn more about pgloader to understand what it does and tweak it to match your setup:

   LOAD DATABASE
        FROM      mysql://weblate:password@localhost/weblate
        INTO postgresql://weblate:password@localhost/weblate
   
   WITH include no drop, truncate, create no tables, create no indexes, no foreign keys, disable triggers, reset sequences, data only
   
   ALTER SCHEMA 'weblate' RENAME TO 'public'
   ;
   

Migrating from Pootle

As Weblate was originally written as replacement from Pootle, it is supported to migrate user accounts from Pootle. You can dump the users from Pootle and import them using importusers.

Backing up and moving Weblate

Automated backup using BorgBackup

バージョン 3.9 で追加.

Weblate has built-in support for creating service backups using BorgBackup. Borg creates space-effective encrypted backups which can be safely stored in the cloud. The backups can be controlled in the management interface on the Backups tab.

警告

Only PostgreSQL database is included in the automated backups. Other database engines have to be backed up manually. You are recommended to migrate to PostgreSQL, see Database setup for Weblate and Migrating from other databases to PostgreSQL.

The backups using Borg are incremental and Weblate is configured to keep following backups:

• 14 daily backups

• 8 weekly backups

• 6 monthly backups

Borg encryption key

BorgBackup creates encrypted backups and without a passphrase you will not be able to restore the backup. The passphrase is generated when adding new backup service and you should copy it and keep it in a secure place.

In case you are using Weblate provisioned backup storage, please backup your private SSH key as well — it is used to access your backups.

参考

borg init

Weblate provisioned backup storage

The easiest approach to backup your Weblate instance is to purchase backup service at weblate.org. The process of activating can be performed in few steps:

1. Purchase backup service on https://weblate.org/support/#backup.

2. Enter obtained key in the management interface, see Integrating support.

3. Weblate will connect to the cloud service and obtain access information for the backups.

4. Turn on the new backup configuration on the Backups tab.

5. Backup Borg credentials in order to be able to restore the backups, see Borg encryption key.

ヒント

The manual step of turning on is there for your safety. Without your consent no data is sent to the backup repository obtained through the registration process.

Using custom backup storage

You can also use your own storage for the backups. SSH can be used to store backups on the remote destination, the target server needs to have BorgBackup installed.

参考

General in the Borg documentation

Local filesystem

It is recommended to specify absolute path for the local backup, for example /path/to/backup. The directory has to be writable by user running Weblate (see Filesystem permissions). In case it doesn't exist, Weblate will attempt to create it, but it needs permissions to do so.

ヒント

When running Weblate in Docker, please make sure that the backup location is exposed as a volume from the Weblate container. Otherwise the backups would be discarded by Docker on container restart.

One option is to place backups in existing volume. For example choose /app/data/borgbackup. This is existing volume in the container.

You can also add new container for the backups in the Docker compose file and use for example /borgbackup:

services:
  weblate:
    volumes:
      - /home/weblate/data:/app/data
      - /home/weblate/borgbackup:/borgbackup

The directory where backups will be stored have to be owned by UID 1000, otherwise Weblate will not be able to write the backups there.

リモート バックアップ

Remote backups using SSH are supported. The SSH server needs to have BorgBackup installed. Weblate connects to the server using SSH key, please make sure the Weblate SSH key is accepted by the server (see Weblate SSH キー).

ヒント

Weblate provisioned backup storage provides you automated remote backups.

Restoring from BorgBackup

1. Restore access to your backup repository and prepare your backup passphrase.

2. List backup existing on the server using borg list REPOSITORY.

3. Restore the desired backup to current directory using borg extract REPOSITORY::ARCHIVE.

4. Restore the database from the SQL dump placed in the backup directory in the Weblate data dir (see Dumped data for backups).

5. Copy Weblate configuration (backups/settings.py, see Dumped data for backups) to the correct location, see Adjusting configuration.

6. Copy the whole restored data dir to location configured by DATA_DIR.

The Borg session might look like:

$ borg list /tmp/xxx
Enter passphrase for key /tmp/xxx:
2019-09-26T14:56:08                  Thu, 2019-09-26 14:56:08 [de0e0f13643635d5090e9896bdaceb92a023050749ad3f3350e788f1a65576a5]
$ borg extract /tmp/xxx::2019-09-26T14:56:08
Enter passphrase for key /tmp/xxx:

参考

borg list、borg extract

Manual backup

Depending on what you want to save, back up the type data Weblate stores in each respective place.

ヒント

In case you are doing manual backups, you might want to silent Weblate warning about lack of backups by adding weblate.I028 to SILENCED_SYSTEM_CHECKS in settings.py or WEBLATE_SILENCED_SYSTEM_CHECKS for Docker.

SILENCED_SYSTEM_CHECKS.append("weblate.I028")

Database

The actual storage location depends on your database setup.

The database is the most important storage. Set up regular backups of your database, without it all your translation setup will be gone.

Native database backup

The recommended approach is to do dump of the database using database native tools such as pg_dump or mysqldump. It usually performs better than Django backup and restores complete tables with all data.

You can restore this backup in newer Weblate release, it will perform any necessary migrations when running in migrate. Please consult Upgrading Weblate on more detailed information how to perform upgrade between versions.

Django database backup

Alternatively you can backup database using Django's dumpdata command. That way the backup is database agnostic and can be used in case you want to change database backend.

Prior to restoring you need to be running exactly same Weblate version as was used when doing backups. This is necessary as the database structure does change between releases and you would end up corrupting the data in some way. After installing the same version, run all database migrations using migrate.

Once this is done, some entries will be already created in the database and you will have them in the database backup as well. The recommended approach is to delete such entries manually using management shell (see Invoking management commands):

weblate shell
>>> from weblate.auth.models import User
>>> User.objects.get(username='anonymous').delete()

ファイル

If you have enough backup space, simply backup the whole DATA_DIR. This is safe bet even if it includes some files you don't want. The following sections describe in detail what you should back up and what you can skip.

Dumped data for backups

Stored in DATA_DIR /backups.

Weblate dumps various data here, and you can include these files for more complete backups. The files are updated daily (requires a running Celery beats server, see Background tasks using Celery). Currently, this includes:

• Weblate settings as settings.py (there is also expanded version in settings-expanded.py).

• PostgreSQL database backup as database.sql.

The database backups are by default saved as plain text, but they can also be compressed or entirely skipped by using DATABASE_BACKUP.

Version control repositories

Stored in DATA_DIR /vcs.

The version control repositories contain a copy of your upstream repositories with Weblate changes. If you have push on commit enabled for all your translation components, all Weblate changes are included upstream and you do not have to backup the repositories on the Weblate side. They can be cloned again from the upstream locations with no data loss.

SSH and GPG keys

Stored in DATA_DIR /ssh and DATA_DIR /home.

If you are using SSH or GPG keys generated by Weblate, you should back up these locations, otherwise you will lose the private keys and you will have to regenerate new ones.

User uploaded files

Stored in DATA_DIR /media.

You should back up user uploaded files (e.g. Visual context for strings).

Celery tasks

The Celery tasks queue might contain some info, but is usually not needed for a backup. At most you will lose updates that have not yet been processed to translation memory. It is recommended to perform the fulltext or repository updates upon restoring anyhow, so there is no problem in losing these.

参考

Background tasks using Celery

Command line for manual backup

Using a cron job, you can set up a bash command to be executed on a daily basis, for instance:

$ XZ_OPT="-9" tar -Jcf ~/backup/weblate-backup-$(date -u +%Y-%m-%d_%H%M%S).xz backups vcs ssh home media fonts secret

The string between quotes after XZ_OPT allows you to choose your xz options, for instance the amount of memory used for compression; see https://linux.die.net/man/1/xz

You can adjust the list of folders and files to your needs. For instance, to avoid saving the translation memory (in backups folder), you could use:

$ XZ_OPT="-9" tar -Jcf ~/backup/weblate-backup-$(date -u +%Y-%m-%d_%H%M%S).xz backups/database.sql backups/settings.py vcs ssh home media fonts secret

Restoring manual backup

1. Restore all data you have backed up.

2. Update all repositories using updategit.

   weblate updategit --all
   

Moving a Weblate installation

Relocate your installation to a different system by following the backup and restore instructions above.

参考

Upgrading from Python 2 to Python 3、Migrating from other databases to PostgreSQL

認証

ユーザー登録

The default setup for Weblate is to use python-social-auth, a form on the website to handle registration of new users. After confirming their e-mail a new user can contribute or authenticate by using one of the third party services.

You can also turn off registration of new users using REGISTRATION_OPEN.

The authentication attempts are subject to レート制限.

Authentication backends

The built-in solution of Django is used for authentication, including various social options to do so. Using it means you can import the user database of other Django-based projects (see Migrating from Pootle).

Django can additionally be set up to authenticate against other means too.

参考

Authentication settings describes how to configure authentication in the official Docker image.

Social authentication

Thanks to Welcome to Python Social Auth’s documentation!, Weblate support authentication using many third party services such as GitLab, Ubuntu, Fedora, etc.

Please check their documentation for generic configuration instructions in Django Framework.

注釈

By default, Weblate relies on third-party authentication services to provide a validated e-mail address. If some of the services you want to use don't support this, please enforce e-mail validation on the Weblate side by configuring FORCE_EMAIL_VALIDATION for them. For example:

SOCIAL_AUTH_OPENSUSE_FORCE_EMAIL_VALIDATION = True

参考

Pipeline

Enabling individual backends is quite easy, it's just a matter of adding an entry to the AUTHENTICATION_BACKENDS setting and possibly adding keys needed for a given authentication method. Please note that some backends do not provide user e-mail by default, you have to request it explicitly, otherwise Weblate will not be able to properly credit contributions users make.

参考

Python Social Auth backend

OpenID authentication

For OpenID-based services it's usually just a matter of enabling them. The following section enables OpenID authentication for OpenSUSE, Fedora and Ubuntu:

# Authentication configuration
AUTHENTICATION_BACKENDS = (
    "social_core.backends.email.EmailAuth",
    "social_core.backends.suse.OpenSUSEOpenId",
    "social_core.backends.ubuntu.UbuntuOpenId",
    "social_core.backends.fedora.FedoraOpenId",
    "weblate.accounts.auth.WeblateUserBackend",
)

参考

OpenID

GitHub authentication

You need to register an application on GitHub and then tell Weblate all its secrets:

# Authentication configuration
AUTHENTICATION_BACKENDS = (
    "social_core.backends.github.GithubOAuth2",
    "social_core.backends.email.EmailAuth",
    "weblate.accounts.auth.WeblateUserBackend",
)

# Social auth backends setup
SOCIAL_AUTH_GITHUB_KEY = "GitHub Client ID"
SOCIAL_AUTH_GITHUB_SECRET = "GitHub Client Secret"
SOCIAL_AUTH_GITHUB_SCOPE = ["user:email"]

The GitHub should be configured to have callback URL as https://example.com/accounts/complete/github/.

注釈

Weblate provided callback URL during the authentication includes configured domain. In case you get errors about URL mismatch, you might want to fix this, see Set correct site domain.

参考

GitHub

Bitbucket authentication

You need to register an application on Bitbucket and then tell Weblate all its secrets:

# Authentication configuration
AUTHENTICATION_BACKENDS = (
    "social_core.backends.bitbucket.BitbucketOAuth",
    "social_core.backends.email.EmailAuth",
    "weblate.accounts.auth.WeblateUserBackend",
)

# Social auth backends setup
SOCIAL_AUTH_BITBUCKET_KEY = "Bitbucket Client ID"
SOCIAL_AUTH_BITBUCKET_SECRET = "Bitbucket Client Secret"
SOCIAL_AUTH_BITBUCKET_VERIFIED_EMAILS_ONLY = True

注釈

Weblate provided callback URL during the authentication includes configured domain. In case you get errors about URL mismatch, you might want to fix this, see Set correct site domain.

参考

Bitbucket

Google OAuth 2

To use Google OAuth 2, you need to register an application on <https://console.developers.google.com/> and enable the Google+ API.

The redirect URL is https://WEBLATE SERVER/accounts/complete/google-oauth2/

# Authentication configuration
AUTHENTICATION_BACKENDS = (
    "social_core.backends.google.GoogleOAuth2",
    "social_core.backends.email.EmailAuth",
    "weblate.accounts.auth.WeblateUserBackend",
)

# Social auth backends setup
SOCIAL_AUTH_GOOGLE_OAUTH2_KEY = "Client ID"
SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET = "Client secret"

注釈

Weblate provided callback URL during the authentication includes configured domain. In case you get errors about URL mismatch, you might want to fix this, see Set correct site domain.

参考

Google

Facebook OAuth 2

As per usual with OAuth 2 services, you need to register your application with Facebook. Once this is done, you can set up Weblate to use it:

The redirect URL is https://WEBLATE SERVER/accounts/complete/facebook/

# Authentication configuration
AUTHENTICATION_BACKENDS = (
    "social_core.backends.facebook.FacebookOAuth2",
    "social_core.backends.email.EmailAuth",
    "weblate.accounts.auth.WeblateUserBackend",
)

# Social auth backends setup
SOCIAL_AUTH_FACEBOOK_KEY = "key"
SOCIAL_AUTH_FACEBOOK_SECRET = "secret"
SOCIAL_AUTH_FACEBOOK_SCOPE = ["email", "public_profile"]

注釈

Weblate provided callback URL during the authentication includes configured domain. In case you get errors about URL mismatch, you might want to fix this, see Set correct site domain.

参考

Facebook

GitLab OAuth 2

For using GitLab OAuth 2, you need to register an application on <https://gitlab.com/profile/applications>.

The redirect URL is https://WEBLATE SERVER/accounts/complete/gitlab/ and ensure you mark the read_user scope.

# Authentication configuration
AUTHENTICATION_BACKENDS = (
    "social_core.backends.gitlab.GitLabOAuth2",
    "social_core.backends.email.EmailAuth",
    "weblate.accounts.auth.WeblateUserBackend",
)

# Social auth backends setup
SOCIAL_AUTH_GITLAB_KEY = "Application ID"
SOCIAL_AUTH_GITLAB_SECRET = "Secret"
SOCIAL_AUTH_GITLAB_SCOPE = ["read_user"]

# If you are using your own GitLab
# SOCIAL_AUTH_GITLAB_API_URL = 'https://gitlab.example.com/'

注釈

Weblate provided callback URL during the authentication includes configured domain. In case you get errors about URL mismatch, you might want to fix this, see Set correct site domain.

参考

GitLab

Microsoft Azure Active Directory

Weblate can be configured to use common or specific tenants for authentication.

The redirect URL is https://WEBLATE SERVER/accounts/complete/azuread-oauth2/ for common and https://WEBLATE SERVER/accounts/complete/azuread-tenant-oauth2/ for tenant-specific authentication.

# Azure AD common

# Authentication configuration
AUTHENTICATION_BACKENDS = (
    "social_core.backends.azuread.AzureADOAuth2",
    "social_core.backends.email.EmailAuth",
    "weblate.accounts.auth.WeblateUserBackend",
)

# OAuth2 keys
SOCIAL_AUTH_AZUREAD_OAUTH2_KEY = ""
SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET = ""

# Azure AD Tenant

# Authentication configuration
AUTHENTICATION_BACKENDS = (
    "social_core.backends.azuread_tenant.AzureADTenantOAuth2",
    "social_core.backends.email.EmailAuth",
    "weblate.accounts.auth.WeblateUserBackend",
)

# OAuth2 keys
SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_KEY = ""
SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_SECRET = ""
# Tenant ID
SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_TENANT_ID = ""

注釈

Weblate provided callback URL during the authentication includes configured domain. In case you get errors about URL mismatch, you might want to fix this, see Set correct site domain.

参考

Microsoft Azure Active Directory

Slack

For using Slack OAuth 2, you need to register an application on <https://api.slack.com/apps>.

The redirect URL is https://WEBLATE SERVER/accounts/complete/slack/.

# Authentication configuration
AUTHENTICATION_BACKENDS = (
    "social_core.backends.slack.SlackOAuth2",
    "social_core.backends.email.EmailAuth",
    "weblate.accounts.auth.WeblateUserBackend",
)

# Social auth backends setup
SOCIAL_AUTH_SLACK_KEY = ""
SOCIAL_AUTH_SLACK_SECRET = ""

注釈

Weblate provided callback URL during the authentication includes configured domain. In case you get errors about URL mismatch, you might want to fix this, see Set correct site domain.

参考

Slack

Turning off password authentication

E-mail and password authentication can be turned off by removing social_core.backends.email.EmailAuth from AUTHENTICATION_BACKENDS. Always keep weblate.accounts.auth.WeblateUserBackend there, it is needed for core Weblate functionality.

ちなみに

You can still use password authentication for the admin interface, for users you manually create there. Just navigate to /admin/.

For example authentication using only the openSUSE Open ID provider can be achieved using the following:

# Authentication configuration
AUTHENTICATION_BACKENDS = (
    "social_core.backends.suse.OpenSUSEOpenId",
    "weblate.accounts.auth.WeblateUserBackend",
)

Password authentication

The default settings.py comes with a reasonable set of AUTH_PASSWORD_VALIDATORS:

• Passwords can't be too similar to your other personal info.

• Passwords must contain at least 10 characters.

• Passwords can't be a commonly used password.

• Passwords can't be entirely numeric.

• Passwords can't consist of a single character or only whitespace.

• Passwords can't match a password you have used in the past.

You can customize this setting to match your password policy.

Additionally you can also install django-zxcvbn-password which gives quite realistic estimates of password difficulty and allows rejecting passwords below a certain threshold.

SAML authentication

バージョン 4.1.1 で追加.

Please follow the Python Social Auth instructions for configuration. Notable differences:

• Weblate supports single IDP which has to be called weblate in SOCIAL_AUTH_SAML_ENABLED_IDPS.

• The SAML XML metadata URL is /accounts/metadata/saml/.

• Following settings are automatically filled in: SOCIAL_AUTH_SAML_SP_ENTITY_ID, SOCIAL_AUTH_SAML_TECHNICAL_CONTACT, SOCIAL_AUTH_SAML_SUPPORT_CONTACT

Example configuration:

# Authentication configuration
AUTHENTICATION_BACKENDS = (
    "social_core.backends.email.EmailAuth",
    "social_core.backends.saml.SAMLAuth",
    "weblate.accounts.auth.WeblateUserBackend",
)

# Social auth backends setup
SOCIAL_AUTH_SAML_SP_PUBLIC_CERT = "-----BEGIN CERTIFICATE-----"
SOCIAL_AUTH_SAML_SP_PRIVATE_KEY = "-----BEGIN PRIVATE KEY-----"
SOCIAL_AUTH_SAML_ENABLED_IDPS = {
    "weblate": {
        "entity_id": "https://idp.testshib.org/idp/shibboleth",
        "url": "https://idp.testshib.org/idp/profile/SAML2/Redirect/SSO",
        "x509cert": "MIIEDjCCAvagAwIBAgIBADA ... 8Bbnl+ev0peYzxFyF5sQA==",
        "attr_name": "full_name",
        "attr_username": "username",
        "attr_email": "email",
    }
}

参考

Configuring SAML in Docker、SAML

LDAP authentication

LDAP authentication can be best achieved using the django-auth-ldap package. You can install it via usual means:

# Using PyPI
pip install django-auth-ldap>=1.3.0

# Using apt-get
apt-get install python-django-auth-ldap

警告

With django-auth-ldap older than 1.3.0 the 自動的なグループの割り当て will not work properly for newly created users.

注釈

There are some incompatibilities in the Python LDAP 3.1.0 module, which might prevent you from using that version. If you get error AttributeError: 'module' object has no attribute '_trace_level', downgrading python-ldap to 3.0.0 might help.

Once you have the package installed, you can hook it into the Django authentication:

# Add LDAP backed, keep Django one if you want to be able to sign in
# even without LDAP for admin account
AUTHENTICATION_BACKENDS = (
    "django_auth_ldap.backend.LDAPBackend",
    "weblate.accounts.auth.WeblateUserBackend",
)

# LDAP server address
AUTH_LDAP_SERVER_URI = "ldaps://ldap.example.net"

# DN to use for authentication
AUTH_LDAP_USER_DN_TEMPLATE = "cn=%(user)s,o=Example"
# Depending on your LDAP server, you might use a different DN
# like:
# AUTH_LDAP_USER_DN_TEMPLATE = 'ou=users,dc=example,dc=com'

# List of attributes to import from LDAP upon sign in
# Weblate stores full name of the user in the full_name attribute
AUTH_LDAP_USER_ATTR_MAP = {
    "full_name": "name",
    # Use the following if your LDAP server does not have full name
    # Weblate will merge them later
    # 'first_name': 'givenName',
    # 'last_name': 'sn',
    # Email is required for Weblate (used in VCS commits)
    "email": "mail",
}

# Hide the registration form
REGISTRATION_OPEN = False

注釈

You should remove 'social_core.backends.email.EmailAuth' from the AUTHENTICATION_BACKENDS setting, otherwise users will be able to set their password in Weblate, and authenticate using that. Keeping 'weblate.accounts.auth.WeblateUserBackend' is still needed in order to make permissions and facilitate anonymous users. It will also allow you to sign in using a local admin account, if you have created it (e.g. by using createadmin).

Using bind password

If you can not use direct bind for authentication, you will need to use search, and provide a user to bind for the search. For example:

import ldap
from django_auth_ldap.config import LDAPSearch

AUTH_LDAP_BIND_DN = ""
AUTH_LDAP_BIND_PASSWORD = ""
AUTH_LDAP_USER_SEARCH = LDAPSearch(
    "ou=users,dc=example,dc=com", ldap.SCOPE_SUBTREE, "(uid=%(user)s)"
)

Active Directoryの統合

import ldap
from django_auth_ldap.config import LDAPSearch, NestedActiveDirectoryGroupType

AUTH_LDAP_BIND_DN = "CN=ldap,CN=Users,DC=example,DC=com"
AUTH_LDAP_BIND_PASSWORD = "password"

# User and group search objects and types
AUTH_LDAP_USER_SEARCH = LDAPSearch(
    "CN=Users,DC=example,DC=com", ldap.SCOPE_SUBTREE, "(sAMAccountName=%(user)s)"
)

# Make selected group a superuser in Weblate
AUTH_LDAP_USER_FLAGS_BY_GROUP = {
    # is_superuser means user has all permissions
    "is_superuser": "CN=weblate_AdminUsers,OU=Groups,DC=example,DC=com",
}

# Map groups from AD to Weblate
AUTH_LDAP_GROUP_SEARCH = LDAPSearch(
    "OU=Groups,DC=example,DC=com", ldap.SCOPE_SUBTREE, "(objectClass=group)"
)
AUTH_LDAP_GROUP_TYPE = NestedActiveDirectoryGroupType()
AUTH_LDAP_FIND_GROUP_PERMS = True

# Optionally enable group mirroring from LDAP to Weblate
# AUTH_LDAP_MIRROR_GROUPS = True

参考

Django Authentication Using LDAP、Authentication

CAS authentication

CAS authentication can be achieved using a package such as django-cas-ng.

Step one is disclosing the e-mail field of the user via CAS. This has to be configured on the CAS server itself, and requires you run at least CAS v2 since CAS v1 doesn't support attributes at all.

Step two is updating Weblate to use your CAS server and attributes.

To install django-cas-ng:

pip install django-cas-ng

Once you have the package installed you can hook it up to the Django authentication system by modifying the settings.py file:

# Add CAS backed, keep the Django one if you want to be able to sign in
# even without LDAP for the admin account
AUTHENTICATION_BACKENDS = (
    "django_cas_ng.backends.CASBackend",
    "weblate.accounts.auth.WeblateUserBackend",
)

# CAS server address
CAS_SERVER_URL = "https://cas.example.net/cas/"

# Add django_cas_ng somewhere in the list of INSTALLED_APPS
INSTALLED_APPS = (..., "django_cas_ng")

Finally, a signal can be used to map the e-mail field to the user object. For this to work you have to import the signal from the django-cas-ng package and connect your code with this signal. Doing this in settings file can cause problems, therefore it's suggested to put it:

• In your app config's django.apps.AppConfig.ready() method

• In the project's urls.py file (when no models exist)

from django_cas_ng.signals import cas_user_authenticated
from django.dispatch import receiver


@receiver(cas_user_authenticated)
def update_user_email_address(sender, user=None, attributes=None, **kwargs):
    # If your CAS server does not always include the email attribute
    # you can wrap the next two lines of code in a try/catch block.
    user.email = attributes["email"]
    user.save()

参考

Django CAS NG

Configuring third party Django authentication

Generally any Django authentication plugin should work with Weblate. Just follow the instructions for the plugin, just remember to keep the Weblate user backend installed.

参考

LDAP authentication、CAS authentication

Typically the installation will consist of adding an authentication backend to AUTHENTICATION_BACKENDS and installing an authentication app (if there is any) into INSTALLED_APPS:

AUTHENTICATION_BACKENDS = (
    # Add authentication backend here
    "weblate.accounts.auth.WeblateUserBackend",
)

INSTALLED_APPS += (
    # Install authentication app here
)

アクセス制御

バージョン 3.0 で変更: Weblate 3.0 より前の権限システムは Django をベースにしていましたが、現在は Weblate 用に独自に構築されています。古いバージョンを使用している場合は、そのバージョンのドキュメントを参照してください。

Weblate には、インスタンス全体または限定した範囲のユーザーに、アクセス権を割り当てるための詳細な権限システムを搭載しています。

グループとロールに基づくアクセス許可のシステム。ロールにアクセス権のセットを設定し、グループとユーザーと翻訳に割り当てます。詳細については ユーザー、ロール、グループ、およびアクセス権 を参照してください。

インストール後にデフォルトのグループが作成され、それを使用しインスタンス全体にユーザーの権限が割り当てられます（参照 デフォルトのグループとロール）。また、プロジェクトのアクセス制御 を有効にすると、特定の翻訳プロジェクトにユーザーが割り当てられます。さらに詳細な設定は カスタム アクセス制御 から設定します。

共通設定

Weblate の閉鎖

Weblate のインストールを完全に禁止するには、REQUIRE_LOGIN を使用してユーザーにサイン インを強制し、REGISTRATION_OPEN を使用して新規登録を防止できます。

サイト全体のアクセス権

インスタンス全体のアクセス権の管理するには、ユーザー （デフォルトでは 自動的なグループの割り当て を使用）、査読者 および 管理者 グループにユーザーを追加します。すべてのプロジェクトを 公開 に設定する（参照 プロジェクトのアクセス制御）。

プロジェクト単位のアクセス権

注釈

この機能は、ホスト型 Libre プランを実行しているプロジェクトでは使用できません。

プロジェクトを 保護 または プライベート に設定し、Weblate インターフェイスでプロジェクトごとにユーザーを管理します。

言語、コンポーネント、プロジェクトへのアクセス権の追加

注釈

この機能は、ホスト型 Libre プランを実行しているプロジェクトでは使用できません。

さらに、プロジェクト、コンポーネント、言語セットに基づいて、どのユーザーにもアクセス権を追加で設定できます。設定方法は、新しいグループ（例：Czech translators）を作成し、特定のリソースに対して設定します。割り当てたアクセス権は、選択したリソースのグループのメンバーに設定されます。

プロジェクトごとのアクセス権を使用している場合は、追加の設定をしなくても問題なく動作します。インスタンス全体のアクセス権については、Users グループからこれらのアクセス権を削除するか、すべてのユーザーをそのグループに自動的に割り当てるように変更するとよいでしょう（参照 自動的なグループの割り当て）。

参考

アクセス権の確認

プロジェクトのアクセス制御

注釈

ACL を有効にすると、すべてのユーザーは、アクセス権を追加しない限り、該当のプロジェクト内へのすべてのアクセスが禁止されます。

注釈

この機能は、ホスト型 Libre プランを実行しているプロジェクトでは使用できません。

個々のプロジェクトへのユーザーのアクセスを制限できます。この機能を有効にするには、各プロジェクトの設定で アクセス制御 を有効にします。これにより、このプロジェクトに複数のグループが自動的に作成されます、参照 定義済みのグループ。

アクセス制御 には次の選択肢があります:

公開

一般公開し、翻訳可能にする

保護

公開しているが、選択したユーザーのみ翻訳可能

プライベート

選択したユーザーのみ表示および翻訳可能

カスタム

Weblate はユーザーを管理しません、参照 カスタム アクセス制御。

このプロジェクトへのアクセスを許可するには、Django 管理画面で、特定のユーザーまたはユーザー グループに権限を直接追加するか、プロジェクト ページのユーザー管理で権限の追加が必要です、解説は プロジェクトごとのアクセス制御の管理。

注釈

ACL が有効でも、入手できるプロジェクトに関する概要情報:

• すべてのプロジェクトの数を含む、インスタンス全体の統計。

• すべてのプロジェクトの数を含む、インスタンス全体の言語の概要。

自動的なグループの割り当て

Weblate を設定すると、ユーザーのメール アドレスに基づいてユーザーをグループに自動的に追加できます。この自動割当は、アカウントの作成時にのみ実行されます。

これは、各グループの Django 管理インターフェイスで設定できます（ 認証 セクション）。

注釈

ユーザー グループと 閲覧者 グループの自動グループ割り当ては、移行時に常に Weblate によって作成されます。無効する場合は、正規表現を ^$ に設定するだけで、一致しなくなります。

ユーザー、ロール、グループ、およびアクセス権

認証モデルを構成している複数のオブジェクト:

アクセス権

Weblate が定義済みの個別のアクセス権。個別にアクセス権の割り当てはできません。これは、ロールの割り当てを通じてのみ設定できます。

ロール

ロールには、アクセス権のセットを定義します。これにより、このセットを複数の場所で再利用でき、管理が容易になります。

ユーザー

ユーザーは複数のグループのメンバーに参加できます。

グループ

グループは、役割、ユーザー、認証オブジェクト（プロジェクト、言語、コンポーネント リストのセット）を関連付けます。

アクセス権の確認

指定した操作が実行できるかどうか、毎回アクセス権を範囲に応じて検査します、確認の順番は次のとおりです:

1. コンポーネント リスト のグループは、コンポーネントまたはプロジェクト（プロジェクト レベルでのアクセスとして）と照合されます。

2. コンポーネント のグループは、コンポーネントまたはプロジェクト（プロジェクト レベルでのアクセスとして）と照合されます。

3. プロジェクト のグループは、プロジェクトと照合されます。

ご覧のように、コンポーネントへのアクセスを許可すると、そのコンポーネントを含むプロジェクトへのアクセスも自動的に許可されます。

注釈

最初の規則のみが適用されます。したがって、コンポーネント リスト、コンポーネント、プロジェクト をすべて設定すると、コンポーネント リスト のみが適用されます。

翻訳のアクセス権を確認する場合は、さらに次の手順を実行します:

4. Group Languages are matched against accessed translations, it it ignored for component or project level access.

ヒント

言語の選択 または プロジェクトの選択 を使用して、すべての言語またはプロジェクトを自動的に登録できます。

プロジェクトへのアクセスの確認

ユーザーは、プロジェクトまたはプロジェクト内のコンポーネントにリンクされたグループの登録者であることが必要です。登録者であるだけで十分で、プロジェクトに参加するための特定なアクセル権は必要ありません（これはデフォルトの 閲覧者 グループで使用します、参照 デフォルトのグループとロール）。

コンポーネントへのアクセスの確認

ユーザーは、参加しているプロジェクトにアクセスできれば、コンポーネントへ無制限にアクセスできます。Restricted access を有効にすると、コンポーネントへのアクセスには、コンポーネント（またはコンポーネント リストを含む）へのアクセス権の設定が必要となります。

ユーザーとグループの管理

すべてのユーザーおよびグループは、Django 管理画面から管理できます、/admin/ URL から利用可能。

プロジェクトごとのアクセス制御の管理

注釈

この機能は ACL 制御のプロジェクトでのみ動作します、参照 プロジェクトのアクセス制御。

プロジェクトへのアクセスの管理 権限（参照 アクセス制御）を持つユーザーは、プロジェクト ページでアクセス制御が有効になっているプロジェクト内のユーザーも管理できます。このインタフェースでは、次のことができます：

• 既存のユーザーをプロジェクトに追加

• 新しいユーザーをプロジェクトに招待

• ユーザーのアクセス権の変更

• ユーザーへのアクセスの取り消し

バージョン 3.11 で追加.

• ユーザーにメールの招待状を再送信して、以前に送信した招待状を無効にする

ユーザー管理は、プロジェクトの 管理 から設定:

参考

プロジェクトのアクセス制御

定義済みのグループ

Weblate には、事前に複数のグループがプロジェクトに定義されているので、そこからユーザーを割り当てることができます。

Administration

プロジェクトで有効なすべてのアクセス権がある。

Glossary

用語集を管理できる（エントリの追加または削除、またはアップロード）。

Languages

翻訳言語を管理できる（翻訳の追加または削除）。

Screenshots

スクリーンショットを管理できる（追加または削除、原文への関連付け）。

Sources

原文を Monolingual components と原文情報で編集できる。

Translate

プロジェクトを翻訳し、オフラインで作成した翻訳をアップロードできる。

VCS

VCS を管理し、エクスポートしたリポジトリにアクセスできる。

Review

査読中に翻訳を承認できる。

Billing

請求情報にアクセスできる（参照 請求）。

カスタム アクセス制御

アクセス制御 として カスタム を選択すると、Weblate は特定のプロジェクトのアクセス管理を停止し、すべてのユーザーとグループを Django 管理インターフェースを使って管理できます。これを使用すると、より複雑なアクセス制御を定義したり、単一の Weblate インスタンス内のすべてのプロジェクトに対して共有アクセス ポリシーを設定できます。デフォルトですべてのプロジェクトに対してこのオプションを有効にする場合は、DEFAULT_ACCESS_CONTROL を設定してください。

警告

これを有効にすると、Weblate はこのプロジェクト用に作成したすべての プロジェクトのアクセス制御 を削除します。この操作をインスタンスからの管理者権限なしで実行すると、プロジェクトを管理するためのアクセス権を即座に失います。

デフォルトのグループとロール

These roles and groups are created upon installation. The built-in roles are always kept up to date by the database migration on upgrade and any custom changes will be lost. In case you want to define own set of permissions, please define a new role for that.

特権の一覧

請求（参照 請求）

請求情報の表示 [Administration, Billing]

変更

変更のダウンロード [Administration]

コメント

コメントの投稿 [Administration, Edit source, Power user, Review strings, Translate]

コメントの削除 [Administration]

コンポーネント

コンポーネント設定の編集 [Administration]

コンポーネントのロック、翻訳の防止 [Administration]

用語集

用語集へ用語の追加 [Administration, Manage glossary, Power user]

用語集の用語の編集 [Administration, Manage glossary, Power user]

用語集の用語の削除 [Administration, Manage glossary, Power user]

用語集へ用語のアップロード [Administration, Manage glossary, Power user]

自動提案

自動提案の使用 [Administration, Power user]

プロジェクト

プロジェクト設定の編集 [Administration]

プロジェクトのアクセス管理s [Administration]

レポート

レポートのダウンロード [Administration]

スクリーンショット

スクリーンショットの追加 [Administration, Manage screenshots]

スクリーンショットの編集 [Administration, Manage screenshots]

スクリーンショットの削除 [Administration, Manage screenshots]

原文

原文情報の編集 [Administration, Edit source]

文字列

新しい原文の追加 [Administration]

不合格となった検査の除外 [Administration, Edit source, Power user, Review strings, Translate]

文字列の編集 [Administration, Edit source, Power user, Review strings, Translate]

文字列の査読 [Administration, Review strings]

提案が適用された文字列の編集 [Administration, Review strings]

原文の編集 [Administration, Edit source, Power user]

提案

提案の適用 [Administration, Edit source, Power user, Review strings, Translate]

提案の追加 [Add suggestion, Administration, Edit source, Power user, Review strings, Translate]

提案の削除 [Administration]

提案に投票 [Administration, Edit source, Power user, Review strings, Translate]

翻訳

新しい翻訳の開始 [Administration, Manage languages, Power user]

自動翻訳の実行 [Administration, Manage languages]

翻訳済み文字列の削除 [Administration, Manage languages]

新しい言語での翻訳の開始 [Administration, Manage languages]

アップロード

アップロードする翻訳者の登録 [Administration]

既存の文字列をアップロードして上書き [Administration, Edit source, Power user, Review strings, Translate]

翻訳のアップロード [Administration, Edit source, Power user, Review strings, Translate]

VCS

内部リポジトリへのアクセス [Access repository, Administration, Manage repository, Power user]

内部リポジトリへの変更点のコミット [Administration, Manage repository]

内部リポジトリからの変更点のプッシュ [Administration, Manage repository]

内部リポジトリの変更点のリセット [Administration, Manage repository]

upstream リポジトリの場所の表示 [Access repository, Administration, Manage repository, Power user]

内部リポジトリの更新 [Administration, Manage repository]

サイト全体の特権

管理画面の使用

新しいプロジェクトの追加

言語定義の追加

言語定義の管理

グループの管理

ユーザーの管理

ロールの管理

お知らせの管理

翻訳メモリの管理

コンポーネント リストの管理

注釈

サイト全体の特権は、デフォルトのロールには与えられません。これらは強力で、スーパー ユーザーの状態に非常に近く、ほとんどの場合、インストール済みの Weblate のすべてのプロジェクトに影響します。

グループ一覧

インストール時（または setupgroups の実行後 ）に、以下のグループが作成され、自由に変更できます。ただし、移行によって、削除または名前の変更を行うと、移行によって再作成されます。

ゲスト

非認証ユーザーのアクセス権を定義する。

このグループには匿名ユーザーのみ含む（参照 ANONYMOUS_USER_NAME）。

このグループからロールを削除して、非認証ユーザーの権限を制限できる。

デフォルトのロール: Add suggestion、 Access repository

閲覧者

このロールにより、すべてのユーザーが公開プロジェクトを参照できる。デフォルトでは、すべてのユーザーがこのグループのメンバーである。

デフォルトでは、 自動的なグループの割り当て によってすべてのユーザーがこのグループに割り当てられます。

デフォルトのロール: none

ユーザー

すべてのユーザーのデフォルトのグループ。

デフォルトでは、すべてのユーザーがこのグループのメンバーである 自動的なグループの割り当て を使用する。

デフォルトのロール: Power user

査読者

査読者用のグループ（参照 翻訳ワークフロー）。

デフォルトのロール: Review strings

管理者

管理者用のグループ。

デフォルトのロール: Administration

警告

定義済みの Weblate グループとユーザーを削除しないでください。削除すると、予期しない問題が発生することがあります。これらの機能を使用しない場合は、すべての権限を削除してください。

翻訳プロジェクト

Translation organization

Weblate organizes translatable VCS content of project/components into a tree-like structure.

• The bottom level object is Project configuration, which should hold all translations belonging together (for example translation of an application in several versions and/or accompanying documentation).

• On the level above, Component configuration, which is actually the component to translate, you define the VCS repository to use, and the mask of files to translate.

• Above Component configuration there are individual translations, handled automatically by Weblate as translation files (which match the mask defined in Component configuration) appear in the VCS repository.

Weblate supports a wide range of translation formats (both bilingual and monolingual ones) supported by Translate Toolkit, see Supported file formats.

注釈

You can share cloned VCS repositories using Weblate の内部 URL. Using this feature is highly recommended when you have many components sharing the same VCS. It improves performance and decreases required disk space.

Adding translation projects and components

バージョン 3.2 で変更: An interface for adding projects and components is included, and you no longer have to use The Django admin interface.

バージョン 3.4 で変更: The process of adding components is now multi staged, with automated discovery of most parameters.

Based on your permissions, new translation projects and components can be created. It is always permitted for users with the Add new projects permission, and if your instance uses billing (e.g. like https://hosted.weblate.org/ see 請求), you can also create those based on your plans allowance from the user account that manages billing.

You can view your current billing plan on a separate page:

The project creation can be initiated from there, or using the menu in the navigation bar, filling in basic info about the translation project to complete addition of it:

After creating the project, you are taken directly to the project page:

Creating a new translation component can be initiated via a single click there. The process of creating a component is multi-staged and automatically detects most translation parameters. There are several approaches to creating component:

バージョン管理から

Creates component from remote version control repository.

既存のコンポーネントから

Creates additional component to existing one by choosing different files.

追加ブランチ

Creates additional component to existing one, just for different branch.

翻訳ファイルのアップロード

Upload translation files to Weblate in case you do not have version control or do not want to integrate it with Weblate. You can later update the content using the web interface or API.

ドキュメントの翻訳

Upload single document and translate that.

ゼロから始める

Create blank translation project and add strings manually.

Once you have existing translation components, you can also easily add new ones for additional files or branches using same repository.

First you need to fill in name and repository location:

On the next page, you are presented with a list of discovered translatable resources:

As a last step, you review the translation component info and fill in optional details:

参考

The Django admin interface、Project configuration、Component configuration

Project configuration

Create a translation project and then add a new component for translation in it. The project is like a shelf, in which real translations are stacked. All components in the same project share suggestions and their dictionary; the translations are also automatically propagated through all components in a single project (unless turned off in the component configuration), see Memory Management.

参考

Integrating with Weblate

These basic attributes set up and inform translators of a project:

プロジェクト名

Verbose project name, used to display the project name.

Project slug

Project name suitable for URLs.

プロジェクトの Web サイト

URL where translators can find more info about the project.

メーリングリスト

Mailing list where translators can discuss or comment translations.

翻訳についての説明

URL to more site with more detailed instructions for translators.

Set Language-Team header

Whether Weblate should manage the Language-Team header (this is a GNU gettext only feature right now).

共有翻訳メモリを使用する

Whether to use shared translation memory, see 共有翻訳メモリ for more details.

共有翻訳メモリに貢献する

Whether to contribute to shared translation memory, see 共有翻訳メモリ for more details.

アクセス制御

Configure per project access control, see プロジェクトのアクセス制御 for more details.

Default value can be changed by DEFAULT_ACCESS_CONTROL.

査読の有効化

Enable review workflow for translations, see 専任の査読者.

原文の査読の有効化

Enable review workflow for source strings, see 原文の査読.

フックの有効化

Whether unauthenticated 通知フック are to be used for this repository.

参考

中間言語ファイル、原文の品質ゲートウェイ、Bilingual and monolingual formats、Language definitions

言語の別名

Define language codes mapping when importing translations into Weblate. Use this when language codes are inconsistent in your repositories and you want to get a consistent view in Weblate or in case you want to use non-standard naming of your translation files.

The typical use case might be mapping American English to English: en_US:en

Multiple mappings to be separated by comma: en_GB:en,en_US:en

Using non standard code: ia_FOO:ia

ヒント

The language codes are mapped when matching the translation files and the matches are case sensitive, so make sure you use the source language codes in same form as used in the filenames.

参考

Parsing language codes

Component configuration

A component is a grouping of something for translation. You enter a VCS repository location and file mask for which files you want translated, and Weblate automatically fetches from this VCS, and finds all matching translatable files.

参考

Integrating with Weblate

You can find some examples of typical configurations in the Supported file formats.

注釈

It is recommended to keep translation components to a reasonable size - split the translation by anything that makes sense in your case (individual apps or addons, book chapters or websites).

Weblate easily handles translations with 10000s of strings, but it is harder to split work and coordinate among translators with such large translation components.

Should the language definition for a translation be missing, an empty definition is created and named as "cs_CZ (generated)". You should adjust the definition and report this back to the Weblate authors, so that the missing languages can be included in next release.

The component contains all important parameters for working with the VCS, and for getting translations out of it:

コンポーネント名

Verbose component name, used to display the component name.

Component slug

Component name suitable for URLs.

Component project

Project configuration where the component belongs.

バージョン管理システム

VCS to use, see バージョン管理の統合 for details.

ソースコードのリポジトリ

VCS repository used to pull changes.

参考

See リポジトリへの接続 for more details on specifying URLs.

ヒント

This can either be a real VCS URL or weblate://project/component indicating that the repository should be shared with another component. See Weblate の内部 URL for more details.

リポジトリの送信先 URL

Repository URL used for pushing. This setting is used only for Git and Mercurial and push support is turned off for these when this is empty.

参考

See リポジトリへの接続 for more details on how to specify a repository URL and Pushing changes from Weblate for more details on pushing changes from Weblate.

リポジトリ ブラウザー

URL of repository browser used to display source files (location of used messages). When empty, no such links will be generated. You can use Template markup.

For example on GitHub, use something like: https://github.com/WeblateOrg/hello/blob/{{branch}}/{{filename}}#L{{line}}

In case your paths are relative to different folder, you might want to strip leading directory by parentdir filter (see Template markup): https://github.com/WeblateOrg/hello/blob/{{branch}}/{{filename|parentdir}}#L{{line}}

エクスポートされたリポジトリ URL

URL where changes made by Weblate are exported. This is important when Web サービスを連携して翻訳 is not used, or when there is a need to manually merge changes. You can use Git exporter to automate this for Git repositories.

リポジトリブランチ

Which branch to checkout from the VCS, and where to look for translations.

ブランチに push

Branch for pushing changes, leave empty to use リポジトリブランチ.

注釈

This is currently only supported for Git, GitLab and GitHub, it is ignored for other VCS integrations.

File mask

Mask of files to translate, including path. It should include one "*" replacing language code (see Language definitions for info on how this is processed). In case your repository contains more than one translation file (e.g. more gettext domains), you need to create a component for each of them.

For example po/*.po or locale/*/LC_MESSAGES/django.po.

In case your filename contains special characters such as [, ], these need to be escaped as [[] or []].

参考

Bilingual and monolingual formats、What does mean "There are more files for the single language (en)"?

単一言語のベース言語ファイル

Base file containing string definitions for Monolingual components.

参考

Bilingual and monolingual formats、What does mean "There are more files for the single language (en)"?

基本ファイルの編集

Whether to allow editing the base file for Monolingual components.

中間言語ファイル

Intermediate language file for Monolingual components. In most cases this is a translation file provided by developers and is used when creating actual source strings.

When set, the source translation is based on this file, but all others are based on 単一言語のベース言語ファイル. In case the string is not translated in source translation, translating to other languages is prohibited. This provides 原文の品質ゲートウェイ.

参考

原文の品質ゲートウェイ、Bilingual and monolingual formats、What does mean "There are more files for the single language (en)"?

新しい翻訳のテンプレート

Base file used to generate new translations, e.g. .pot file with gettext.

ヒント

In many monolingual formats Weblate starts with blank file by default. Use this in case you want to have all strings present with empty value when creating new translation.

参考

Adding new translations、新しい翻訳の追加、Bilingual and monolingual formats、What does mean "There are more files for the single language (en)"?

ファイル形式

Translation file format, see also Supported file formats.

原文ミスの報告先アドレス

Email address used for reporting upstream bugs. This address will also receive notification about any source string comments made in Weblate.

翻訳の伝達を許可する

You can turn off propagation of translations to this component from other components within same project. This really depends on what you are translating, sometimes it's desirable to have make use of a translation more than once.

It's usually a good idea to turn this off for monolingual translations, unless you are using the same IDs across the whole project.

Default value can be changed by DEFAULT_TRANSLATION_PROPAGATION.

提案の有効化

Whether translation suggestions are accepted for this component.

提案への投票

Turns on vote casting for suggestions, see 提案への投票.

提案の自動採用

Automatically accept voted suggestions, see 提案への投票.

翻訳フラグ

品質検査やその他の Weblate の動作のカスタマイズ、参照 動作のカスタマイズ。

検査の強制

List of checks which can not be ignored, see 検査の強制.

翻訳のライセンス

License of the translation (does not need to be the same as the source code license).

貢献者同意条項

ユーザーがこのコンポーネントを翻訳する前に必要な同意書。

新しい翻訳の追加

How to handle requests for creation of new languages. Available options:

保守担当者に連絡

User can select desired language and the project maintainers will receive a notification about this. It is up to them to add (or not) the language to the repository.

翻訳案内の URL を指定

User is presented a link to page which describes process of starting new translations. Use this in case more formal process is desired (for example forming a team of people before starting actual translation).

新しい言語ファイルの作成

User can select language and Weblate automatically creates the file for it and translation can begin.

新しい翻訳の追加を無効にする

There will be no option for user to start new translation.

参考

Adding new translations.

言語コード スタイル

Weblate が自動生成する翻訳のファイル名の言語コードをカスタマイズします。

参考

Adding new translations、言語コード、Parsing language codes

マージスタイル

You can configure how updates from the upstream repository are handled. This might not be supported for some VCSs. See Merge or rebase for more details.

Default value can be changed by DEFAULT_MERGE_STYLE.

Commit, add, delete, merge and addon messages

Message used when committing a translation, see Template markup.

デフォルト値の変更は次の方法 DEFAULT_ADD_MESSAGE、DEFAULT_ADDON_MESSAGE、DEFAULT_COMMIT_MESSAGE、DEFAULT_DELETE_MESSAGE、DEFAULT_MERGE_MESSAGE。

コミッタの名前

Name of the committer used for Weblate commits, the author will always be the real translator. On some VCSs this might be not supported.

Default value can be changed by DEFAULT_COMMITER_NAME.

コミッタのメールアドレス

Email of committer used for Weblate commits, the author will always be the real translator. On some VCSs this might be not supported. The default value can be changed in DEFAULT_COMMITER_EMAIL.

コミット時にプッシュする

Whether committed changes should be automatically pushed to the upstream repository. When enabled, the push is initiated once Weblate commits changes to its internal repository (see Lazy commits). To actually enable pushing Repository push URL has to be configured as well.

コミットするまでの経過時間

Sets how old changes (in hours) are to get before they are committed by background task or commit_pending management command. All changes in a component are committed once there is at least one older than this period.

Default value can be changed by COMMIT_PENDING_HOURS.

エラー時にロック

Enables locking the component on repository error (failed pull, push or merge). Locking in this situation avoids adding another conflict which would have to be resolved manually.

The component will be automatically unlocked once there are no repository errors left.

原文の言語

Language used for source strings. Change this if you are translating from something else than English.

ヒント

In case you are translating bilingual files from English, but want to be able to do fixes in the English translation as well, you might want to choose English (Developer) as a source language to avoid conflict between name of the source language and existing translation.

For monolingual translations, you can use intermediate translation in this case, see 中間言語ファイル.

言語フィルタ

Regular expression used to filter the translation when scanning for filemask. This can be used to limit the list of languages managed by Weblate.

注釈

You need to list language codes as they appear in the filename.

Some examples of filtering:

Filter description	正規表現
Selected languages only	^(cs|de|es)$
Exclude languages	^(?!(it|fr)$).+$
Filter two letter codes only	^..$
Exclude non language files	^(?!(blank)$).+$
Include all files (default)	^[^.]+$

バリアント正規表現

Regular expression used to determine the variants of a string, see String variants.

注釈

Most of the fields can be edited by project owners or managers, in the Weblate interface.

参考

Does Weblate support other VCSes than Git and Mercurial?、Translation component alerts

優先順位

翻訳者に対しては、高い優先順位を設定したコンポーネントを先に提示します。

Restricted access

By default the component is visible to anybody who has access to the project, even if the person can not perform any changes in the component. This makes it easier to keep translation consistency within the project.

Enable this in case you want to grant access to this component explicitly - the project level permissions will not apply and you will have to specify component or component list level permission in order to grant access.

Default value can be changed by DEFAULT_RESTRICTED_COMPONENT.

ヒント

This applies to project managers as well - please make sure you will not loose access to the component after toggling the status.

Template markup

Weblate uses simple markup language in several places where text rendering is needed. It is based on The Django template language, so it can be quite powerful.

Currently it is used in:

• Commit message formatting, see Component configuration

• Several addons

  • コンポーネントの検出

  • 統計データの生成

  • Executing scripts from addon

There following variables are available in the component templates:

{{ language_code }}

言語コード

{{ language_name }}

言語名

{{ component_name }}

コンポーネント名

{{ component_slug }}

Component slug

{{ project_name }}

プロジェクト名

{{ project_slug }}

Project slug

{{ url }}

Translation URL

{{ filename }}

翻訳ファイル名

{{ stats }}

Translation stats, this has further attributes, examples below.

{{ stats.all }}

Total strings count

{{ stats.fuzzy }}

Count of strings needing review

{{ stats.fuzzy_percent }}

Percent of strings needing review

{{ stats.translated }}

Translated strings count

{{ stats.translated_percent }}

Translated strings percent

{{ stats.allchecks }}

Number of strings with failing checks

{{ stats.allchecks_percent }}

Percent of strings with failing checks

{{ author }}

Author of current commit, available only in the commit scope.

{{ addon_name }}

Name of currently executed addon, available only in the addon commit message.

The following variables are available in the repository browser or editor templates:

{{branch}}

current branch

{{line}}

line in file

{{filename}}

filename, you can also strip leading parts using the parentdir filter, for example {{filename|parentdir}}

You can combine them with filters:

{{ component|title }}

You can use conditions:

{% if stats.translated_percent > 80 %}Well translated!{% endif %}

There is additional tag available for replacing characters:

{% replace component "-" " " %}

You can combine it with filters:

{% replace component|capfirst "-" " " %}

There are also additional filter to manipulate with filenames:

Directory of a file: {{ filename|dirname }}
File without extension: {{ filename|stripext }}
File in parent dir: {{ filename|parentdir }}
It can be used multiple times:  {{ filename|parentdir|parentdir }}

...and other Django template features.

Importing speed

Fetching VCS repository and importing translations to Weblate can be a lengthy process, depending on size of your translations. Here are some tips:

Optimize configuration

The default configuration is useful for testing and debugging Weblate, while for a production setup, you should do some adjustments. Many of them have quite a big impact on performance. Please check Production setup for more details, especially:

• Configure Celery for executing background tasks (see Background tasks using Celery)

• Enable caching

• Use a powerful database engine

• Disable debug mode

Check resource limits

If you are importing huge translations or repositories, you might be hit by resource limitations of your server.

• Check the amount of free memory, having translation files cached by the operating system will greatly improve performance.

• Disk operations might be bottleneck if there is a lot of strings to process—the disk is pushed by both Weblate and the database.

• Additional CPU cores might help improve performance of background tasks (see Background tasks using Celery).

Disable unneeded checks

Some quality checks can be quite expensive, and if not needed, can save you some time during import if omitted. See CHECK_LIST for info on configuration.

Automatic creation of components

In case your project has dozen of translation files (e.g. for different gettext domains, or parts of Android apps), you might want to import them automatically. This can either be achieved from the command line by using import_project or import_json, or by installing the コンポーネントの検出 addon.

To use the addon, you first need to create a component for one translation file (choose the one that is the least likely to be renamed or removed in future), and install the addon on this component.

For the management commands, you need to create a project which will contain all components and then run import_project or import_json.

参考

Management commands、コンポーネントの検出

Language definitions

To present different translations properly, info about language name, text direction, plural definitions and language code is needed.

Parsing language codes

While parsing translations, Weblate attempts to map language code (usually the ISO 639-1 one) to any existing language object.

You can further adjust this mapping at project level by 言語の別名.

If no exact match can be found, an attempt will be made to best fit it into an existing language (e.g. ignoring the default country code for a given language—choosing cs instead of cs_CZ).

Should that also fail, a new language definition will be created using the defaults (left to right text direction, one plural). The automatically created language with code xx_XX will be named as xx_XX (generated). You might want to change this in the admin interface later, (see Changing language definitions) and report it to the issue tracker (see Weblate に貢献), so that the proper definition can be added to the upcoming Weblate release.

ヒント

In case you see something unwanted as a language, you might want to adjust 言語フィルタ to ignore such file when parsing translations.

参考

言語コード、Adding new translations

Changing language definitions

You can change language definitions in the languages interface (/languages/ URL).

While editing, make sure all fields are correct (especially plurals and text direction), otherwise translators will be unable to properly edit those translations.

内蔵の言語設定

Definitions for more than 550 languages are included in Weblate and the list is extended in every release. Whenever Weblate is upgraded (more specifically whenever weblate migrate is executed, see Generic upgrade instructions) the database of languages is updated to include all language definitions shipped in Weblate.

This feature can be disable using UPDATE_LANGUAGES. You can also enforce updating the database to match Weblate built-in data using setuplang.

あいまいな言語コードとマクロ言語

In many cases it is not a good idea to use macro language code for a translation. The typical problematic case might be Kurdish language, which might be written in Arabic or Latin script, depending on actual variant. To get correct behavior in Weblate, it is recommended to use individual language codes only and avoid macro languages.

参考

Macrolanguages definition, List of macrolanguages

Language definitions

Each language consists of following fields:

言語コード

Code identifying the language. Weblate prefers two letter codes as defined by ISO 639-1, but uses ISO 639-2 or ISO 639-3 codes for languages that do not have two letter code. It can also support extended codes as defined by BCP 47.

参考

Parsing language codes、Adding new translations

言語名

Visible name of the language. The language names included in Weblate are also being localized depending on user interface language.

テキストの方向

Determines whether language is written right to left or left to right. This property is autodetected correctly for most of the languages.

Plural number

Number of plurals used in the language.

複数形判別式

Gettext compatible plural formula used to determine which plural form is used for given count.

参考

複数形, GNU gettext utilities: Plural forms, Language Plural Rules by the Unicode Consortium

Adding new translations

バージョン 2.18 で変更: In versions prior to 2.18 the behaviour of adding new translations was file format specific.

Weblate can automatically start new translation for all of the file formats.

Some formats expect to start with an empty file and only translated strings to be included (for example Android string resources), while others expect to have all keys present (for example GNU gettext). In some situations this really doesn't depend on the format, but rather on the framework you use to handle the translation (for example with JSON files).

When you specify 新しい翻訳のテンプレート in Component configuration, Weblate will use this file to start new translations. Any exiting translations will be removed from the file when doing so.

When 新しい翻訳のテンプレート is empty and the file format supports it, an empty file is created where new strings will be added once they are translated.

The 言語コード スタイル allows you to customize language code used in generated filenames:

ファイル形式から導き出されるデフォルト

Dependent on file format, for most of them POSIX is used.

下線を区切り文字とする POSIX 形式

Typically used by gettext and related tools, produces language codes like pt_BR.

国コードを含む、下線を区切り文字とする POSIX 形式

POSIX style language code including the country code even when not necessary (for example cs_CZ).

ハイフンを区切り文字とする BCP 形式

Typically used on web platforms, produces language codes like pt-BR.

国コードを含む、ハイフンを区切り文字とする BCP 形式

BCP style language code including the country code even when not necessary (for example cs-CZ).

Android 形式

Only used in Android apps, produces language codes like pt-rBR.

Java 形式

Used by Java—mostly BCP with legacy codes for Chinese.

Additionally, any mappings defined in 言語の別名 are applied in reverse.

注釈

Weblate recognizes any of these when parsing translation files, the above settings only influences how new files are created.

参考

言語コード、Parsing language codes

Web サービスを連携して翻訳

There is infrastructure in place so that your translation closely follows development. This way translators can work on translations the entire time, instead of working through huge amount of new text just prior to release.

参考

Integrating with Weblate describes basic ways to integrate your development with Weblate.

This is the process:

1. Developers make changes and push them to the VCS repository.

2. Optionally the translation files are updated (this depends on the file format, see Why does Weblate still show old translation strings when I've updated the template?).

3. Weblate pulls changes from the VCS repository, see Updating repositories.

4. Once Weblate detects changes in translations, translators are notified based on their subscription settings.

5. Translators submit translations using the Weblate web interface, or upload offline changes.

6. Once the translators are finished, Weblate commits the changes to the local repository (see Lazy commits) and pushes them back if it has permissions to do so (see Pushing changes from Weblate).

Updating repositories

You should set up some way of updating backend repositories from their source.

• Use 通知フック to integrate with most of common code hosting services

• Manually trigger update either in the repository management or using API or Weblate クライアント

• Enable AUTO_UPDATE to automatically update all components on your Weblate instance

• Execute updategit (with selection of project or --all to update all)

Whenever Weblate updates the repository, the post-update addons will be triggered, see アドオン.

Avoiding merge conflicts

The merge conflicts from Weblate arise when same file was changed both in Weblate and outside it. There are two approaches to deal with that - avoid edits outside Weblate or integrate Weblate into your updating process, so that it flushes changes prior to updating the files outside Weblate.

The first approach is easy with monolingual files - you can add new strings within Weblate and leave whole editing of the files there. For bilingual files, there is usually some kind of message extraction process to generate translatable files from the source code. In some cases this can be split into two parts - one for the extraction generates template (for example gettext POT is generated using xgettext) and then further process merges it into actual translations (the gettext PO files are updated using msgmerge). You can perform the second step within Weblate and it will make sure that all pending changes are included prior to this operation.

The second approach can be achieved by using API to force Weblate to push all pending changes and lock the translation while you are doing changes on your side.

The script for doing updates can look like this:

# Lock Weblate translation
wlc lock
# Push changes from Weblate to upstream repository
wlc push
# Pull changes from upstream repository to your local copy
git pull
# Update translation files, this example is for Django
./manage.py makemessages --keep-pot -a
git commit -m 'Locale updates' -- locale
# Push changes to upstream repository
git push
# Tell Weblate to pull changes (not needed if Weblate follows your repo
# automatically)
wlc pull
# Unlock translations
wlc unlock

If you have multiple components sharing same repository, you need to lock them all separately:

wlc lock foo/bar
wlc lock foo/baz
wlc lock foo/baj

注釈

The example uses Weblate クライアント, which needs configuration (API keys) to be able to control Weblate remotely. You can also achieve this using any HTTP client instead of wlc, e.g. curl, see API.

Automatically receiving changes from GitHub

Weblate comes with native support for GitHub.

If you are using Hosted Weblate, the recommended approach is to install the Weblate app, that way you will get the correct setup without having to set much up. It can also be used for pushing changes back.

To receive notifications on every push to a GitHub repository, add the Weblate Webhook in the repository settings (Webhooks) as shown on the image below:

For the payload URL, append /hooks/github/ to your Weblate URL, for example for the Hosted Weblate service, this is https://hosted.weblate.org/hooks/github/.

You can leave other values at default settings (Weblate can handle both content types and consumes just the push event).

参考

POST /hooks/github/、Hosted Weblate からリポジトリへの接続

Automatically receiving changes from Bitbucket

Weblate has support for Bitbucket webhooks, add a webhook which triggers upon repository push, with destination to /hooks/bitbucket/ URL on your Weblate installation (for example https://hosted.weblate.org/hooks/bitbucket/).

参考

POST /hooks/bitbucket/、Hosted Weblate からリポジトリへの接続

Automatically receiving changes from GitLab

Weblate has support for GitLab hooks, add a project webhook with destination to /hooks/gitlab/ URL on your Weblate installation (for example https://hosted.weblate.org/hooks/gitlab/).

参考

POST /hooks/gitlab/、Hosted Weblate からリポジトリへの接続

Pagure からの変更を自動的に受信

バージョン 3.3 で追加.

Weblate は、Pagure フックに対応しているので、あなたの Weblate のインストール上の /hooks/pagure/ URL に宛先を持つ WEB フックを追加します（例えば https://hosted.weblate.org/hooks/pagure/）。これは、次の手順で行う Project options の中の Activate Web-hooks:

参考

POST /hooks/pagure/、Hosted Weblate からリポジトリへの接続

Automatically receiving changes from Azure Repos

バージョン 3.8 で追加.

Weblate has support for Azure Repos web hooks, add a webhook for Code pushed event with destination to /hooks/azure/ URL on your Weblate installation (for example https://hosted.weblate.org/hooks/azure/). This can be done in Service hooks under Project settings.

参考

Web hooks in Azure DevOps manual 、POST /hooks/azure/、Hosted Weblate からリポジトリへの接続

Automatically receiving changes from Gitea Repos

バージョン 3.9 で追加.

Weblate has support for Gitea webhooks, add a Gitea Webhook for Push events event with destination to /hooks/gitea/ URL on your Weblate installation (for example https://hosted.weblate.org/hooks/gitea/). This can be done in Webhooks under repository Settings.

参考

Webhooks in Gitea manual 、POST /hooks/gitea/、Hosted Weblate からリポジトリへの接続

Automatically receiving changes from Gitee Repos

バージョン 3.9 で追加.

Weblate has support for Gitee webhooks, add a WebHook for Push event with destination to /hooks/gitee/ URL on your Weblate installation (for example https://hosted.weblate.org/hooks/gitee/). This can be done in WebHooks under repository Management.

参考

Webhooks in Gitee manual 、POST /hooks/gitee/、Hosted Weblate からリポジトリへの接続

Automatically updating repositories nightly

Weblate automatically fetches remote repositories nightly to improve performance when merging changes later. You can optionally turn this into doing nightly merges as well, by enabling AUTO_UPDATE.

Pushing changes from Weblate

Each translation component can have a push URL set up (see リポジトリの送信先 URL), and in that case Weblate will be able to push change to the remote repository. Weblate can be also be configured to automatically push changes on every commit (this is default, see コミット時にプッシュする). If you do not want changes to be pushed automatically, you can do that manually under Repository maintenance or using API via wlc push.

The push options differ based on the バージョン管理の統合 used, more details are found in that chapter.

Weblate による直接プッシュが不要な場合は、GitHub、GitLab、 Pagure のプル リクエストまたは Gerrit 査読に対応しています。これを有効にするには、Component configuration で バージョン管理システム として GitHub、GitLab、Gerrit または Pagure を選択します。

Overall, following options are available with Git, GitHub and GitLab:

Desired setup	バージョン管理システム	リポジトリの送信先 URL	ブランチに push
No push	Git	empty	empty
Push directly	Git	SSH URL	empty
別のブランチに push	Git	SSH URL	Branch name
GitHub pull request from fork	GitHub	empty	empty
GitHub pull request from branch	GitHub	SSH URL 1	Branch name
GitLab merge request from fork	GitLab	empty	empty
GitLab merge request from branch	GitLab	SSH URL 1	Branch name
フォークからの Pagure マージ リクエスト	Pagure	empty	empty
ブランチからの Pagure マージ リクエスト	Pagure	SSH URL 1	Branch name

1(1,2,3)

Can be empty in case ソースコードのリポジトリ supports pushing.

注釈

You can also enable automatic pushing of changes after Weblate commits, this can be done in コミット時にプッシュする.

参考

See リポジトリへの接続 for setting up SSH keys, and Lazy commits for info about when Weblate decides to commit changes.

Protected branches

If you are using Weblate on protected branch, you can configure it to use pull requests and perform actual review on the translations (what might be problematic for languages you do not know). An alternative approach is to waive this limitation for the Weblate push user.

For example on GitHub this can be done in the repository configuration:

Merge or rebase

By default, Weblate merges the upstream repository into its own. This is the safest way in case you also access the underlying repository by other means. In case you don't need this, you can enable rebasing of changes on upstream, which will produce a history with fewer merge commits.

注釈

Rebasing can cause you trouble in case of complicated merges, so carefully consider whether or not you want to enable them.

Interacting with others

Weblate makes it easy to interact with others using its API.

参考

API

Lazy commits

The behaviour of Weblate is to group commits from the same author into one commit if possible. This greatly reduces the number of commits, however you might need to explicitly tell it to do the commits in case you want to get the VCS repository in sync, e.g. for merge (this is by default allowed for the Managers group, see アクセス制御).

The changes in this mode are committed once any of the following conditions are fulfilled:

• Somebody else changes an already changed string.

• A merge from upstream occurs.

• An explicit commit is requested.

• Change is older than period defined as コミットするまでの経過時間 on Component configuration.

ヒント

Commits are created for every component. So in case you have many components you will still see lot of commits. You might utilize Git コミットをスカッシュ addon in that case.

If you want to commit changes more frequently and without checking of age, you can schedule a regular task to perform a commit:

CELERY_BEAT_SCHEDULE = {
    # Unconditionally commit all changes every 2 minutes
    "commit": {
        "task": "weblate.trans.tasks.commit_pending",
        # Ommiting hours will honor per component settings,
        # otherwise components with no changes older than this
        # won't be committed
        "kwargs": {"hours": 0},
        # How frequently to execute the job in seconds
        "schedule": 120,
    }
}

Processing repository with scripts

The way to customize how Weblate interacts with the repository is アドオン. Consult Executing scripts from addon for info on how to execute external scripts through addons.

Keeping translations same across components

Once you have multiple translation components, you might want to ensure that the same strings have same translation. This can be achieved at several levels.

Translation propagation

With translation propagation enabled (what is the default, see Component configuration), all new translations are automatically done in all components with matching strings. Such translations are properly credited to currently translating user in all components.

注釈

The translation propagation requires the key to be match for monolingual translation formats, so keep that in mind when creating translation keys.

Consistency check

The 一貫性の欠如 check fires whenever the strings are different. You can utilize this to review such differences manually and choose the right translation.

自動翻訳

Automatic translation based on different components can be way to synchronize the translations across components. You can either trigger it manually (see 自動翻訳) or make it run automatically on repository update using addon (see 自動翻訳).

Licensing translations

You can specify which license translations are contributed under. This is especially important to do if translations are open to the public, to stipulate what they can be used for.

You should specify Component configuration license info. You should avoid requiring a contributor license agreement, though it is possible.

License info

Upon specifying license info (license name and URL), this info is shown in the translation info section of the respective Component configuration.

Usually this is best place to post licensing info if no explicit consent is required. If your project or translation is not libre you most probably need prior consent.

貢献者同意条項

If you specify a contributor license agreement, only users who have agreed to it will be able to contribute. This is a clearly visible step when accessing the translation:

The entered text is formatted into paragraphs and external links can be included. HTML markup can not be used.

User licenses

Any user can review all translation licenses of all public projects on the instance from their profile:

翻訳の処理

提案への投票

Everyone can add suggestions by default, to be accepted by signed in users. Suggestion voting can be used to make use of a string when more than one signed-in user agrees, by setting up the Component configuration configuration with Suggestion voting to turn on voting, and Autoaccept suggestions to set a threshold for accepted suggestions (this includes a vote from the user making the suggestion if it is cast).

注釈

Once automatic acceptance is set up, normal users lose the privilege to directly save translations or accept suggestions. This can be overridden with the Edit string when suggestions are enforced privilege (see アクセス制御).

You can combine these with アクセス制御 into one of the following setups:

• Users suggest and vote for suggestions and a limited group controls what is accepted. - Turn on voting. - Turn off automatic acceptance. - Don't let users save translations.

• Users suggest and vote for suggestions with automatic acceptance once the defined number of them agree. - Turn on voting. - Set the desired number of votes for automatic acceptance.

• Optional voting for suggestions. (Can optionally be used by users when they are unsure about a translation by making multiple suggestions.) - Only turn on voting.

Additional info on source strings

Enhance the translation process with info available in the translation files. This includes explanation, string priority, check flags, or providing visual context. All these features can be set while editing additional string info:

Access this directly from the translation interface by clicking the "Edit" icon next to Screenshot context or Flags.

Strings prioritization

バージョン 2.0 で追加.

String priority can be changed to offer higher priority strings for translation earlier by using the priority flag.

ヒント

This can be used to order the flow of translation in a logical manner.

参考

品質検査

翻訳フラグ

バージョン 2.4 で追加.

バージョン 3.3 で変更: Previously called Quality checks flags, it no longer configures only checks.

The default set of translation flags is determined by the translation Component configuration and the translation file. However, you might want to use it to customize this per source string.

参考

品質検査

説明

バージョン 4.1 で変更: In previous version this has been called extra context.

Use the explanation to clarify scope or usage of the translation. You can use Markdown to include links and other markup.

Visual context for strings

バージョン 2.9 で追加.

You can upload a screenshot showing a given source string in use within your program. This helps translators understand where it is used, and how it should be translated.

The uploaded screenshot is shown in the translation context sidebar:

In addition to Additional info on source strings, screenshots have a separate management interface under the Tools menu. Upload screenshots, assign them to source strings manually, or use optical character recognition to do so.

Once a screenshot is uploaded, this interface handles management and source string association:

検査と修正

自動修正のカスタマイズ

標準の自動修正に、独自の修正も追加できます。AUTOFIX_LIST 内に記述します。

自動修正は強力ですが、翻訳を破壊することもあります; 　記述するときには注意が必要です。

例えば、次の自動修正は、翻訳内のすべての文字列 foo を bar に置き換えます:

#
# Copyright © 2012 - 2020 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <https://weblate.org/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#

from django.utils.translation import gettext_lazy as _

from weblate.trans.autofixes.base import AutoFix


class ReplaceFooWithBar(AutoFix):
    """Replace foo with bar."""

    name = _("Foobar")

    def fix_single_target(self, target, source, unit):
        if "foo" in target:
            return target.replace("foo", "bar"), True
        return target, False

独自の自動修正を組み込むには、AUTOFIX_LIST 内で Python クラスへの完全修飾パスを指定します、参照 品質検査、アドオン、自動修正のカスタマイズ。

動作のカスタマイズ

Weblate の動作（主に検査）は、原文（原文の査読、参照 Additional info on source strings）、または Component configuration （ 翻訳フラグ）で微調整できます。ファイル フォーマットの中には、フラグを直接フォーマットで指定できるものもあります（参照 Supported file formats）。

フラグはカンマで、パラメーターはコロンで区切ります。引用符を使用して、文字列に空白または特殊文字を含めることができます。例えば:

placeholders:"special:value":"other value", regex:.*

現在、使用可能なフラグの一覧:

rst-text

テキストを reStructuredText 文書として扱う、関連項目 未翻訳の翻訳文。

md-text

テキストを Markdown 文書として扱う。

dos-eol

UNIX の代わりに DOS の改行コードを使用する（\n の代わりに \r\n）。

url

文字列は URL のみでなければならない。

safe-html

文字列は HTML セーフでなければならない、参照 安全でない HTML。

read-only

文字列は読み取り専用なので Weblate で編集しないでください、参照 読み取り専用文字列。

priority:N

文字列の優先順位。優先順位の高い文字列が最初に翻訳されます。デフォルトの優先順位は 100、文字列の優先順位が高いほど、翻訳のために早く使用されます。

max-length:N

文字列の最大長を N 文字に制限する、参照 翻訳文の最大長。

xml-text

テキストを XML ドキュメントとして扱う、関連項目 XML 構文 および XML マークアップ。

font-family:NAME

表示テスト用にフォントを定義する、参照 フォントの管理。

font-weight:WEIGHT

表示テスト用にフォントの太さを定義する、参照 フォントの管理。

font-size:SIZE

表示テスト用にフォント サイズを定義する、参照 フォントの管理。

font-spacing:SPACING

表示テスト用にフォント間隔を定義する、参照 フォントの管理。

placeholders:NAME

翻訳にはプレースホルダー文字列が必要です、参照 プレースホルダー。

replacements:FROM:TO:FROM2:TO2...

結果のテキスト パラメータを検査するときに実行する置換（例 翻訳の最大長 または 翻訳文の最大長）。この一般的な使用例は、テキストが長い名前でも収まるように配置可能な場所を拡張すること、 例: replacements:%s:"John Doe"。

regex:REGEX

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

python-format、 c-format、 php-format、 python-brace-format、 javascript-format、 c-sharp-format、 java-format、 java-messageformat、 auto-java-messageformat、 qt-format、 qt-plural-format、 ruby-format、 vue-format

すべての文字列をフォーマット文字列のように扱う、関連項目 書式指定文字列、書式指定文字列、書式指定文字列、書式指定文字列、書式指定文字列、書式指定文字列、書式指定文字列、書式指定文字列、書式指定文字列、書式指定文字列、書式指定文字列、書式指定文字列、未翻訳の翻訳文。

strict-same

「未翻訳の翻訳」には、内蔵したブラックリストの単語を使用しないようにする、参考 未翻訳の翻訳文。

ignore-bbcode

「BBcode マークアップ」の品質検査を無効にする。

ignore-duplicate

「重複した単語の繰り返し」の品質検査を無効にする。

ignore-double-space

「連続したスペース」の品質検査を無効にする。

ignore-angularjs-format

「AngularJS 補間文字列」の品質検査を無効にする。

ignore-c-format

「C 形式」の品質検査を無効にする。

ignore-c-sharp-format

「C# 形式」の品質検査を無効にする。

ignore-es-format

「ECMAScript テンプレート リテラル」の品質検査を無効にする。

ignore-i18next-interpolation

「i18next 補間」の品質検査を無効にする。

ignore-java-format

「Java 形式」の品質検査を無効にする。

ignore-java-messageformat

「Java MessageFormat」の品質検査を無効にする。

ignore-javascript-format

「JavaScript 形式」の品質検査を無効にする。

ignore-percent-placeholders

「パーセントのプレースホルダー」の品質検査を無効にする。

ignore-perl-format

「Perl 形式」の品質検査を無効にする。

ignore-php-format

「PHP 形式」の品質検査を無効にする。

ignore-python-brace-format

「Python ブレース形式」の品質検査を無効にする。

ignore-python-format

「Python 形式」の品質検査を無効にする。

ignore-qt-format

「Qt 形式」の品質検査を無効にする。

ignore-qt-plural-format

「Qt 複数形形式」の品質検査を無効にする。

ignore-ruby-format

「Ruby 形式」の品質検査を無効にする。

ignore-vue-format

「Vue I18n 書式」の品質検査を無効にする。

ignore-translated

「翻訳済み」の品質検査を無効にする。

ignore-inconsistent

「一貫性に問題」の品質検査を無効にする。

ignore-kashida

「Kashida 文字の使用」の品質検査を無効にする。

ignore-md-link

「マークダウン リンク」の品質検査を無効にする。

ignore-md-reflink

「マークダウンの仕様」の品質検査を無効にする。

ignore-md-syntax

「マークダウン構文」の品質検査を無効にする。

ignore-max-length

「翻訳の最大文字数」の品質検査を無効にする。

ignore-max-size

「翻訳の最大サイズ」の品質検査を無効にする。

ignore-escaped-newline

「n の不一致」の品質検査を無効にする。

ignore-end-colon

「コロンの不一致」の品質検査を無効にする。

ignore-end-ellipsis

「省略記号の不一致」の品質検査を無効にする。

ignore-end-exclamation

「感嘆符の不一致」の品質検査を無効にする。

ignore-end-stop

「終止符の不一致」の品質検査を無効にする。

ignore-end-question

「疑問符の不一致」の品質検査を無効にする。

ignore-end-semicolon

「セミコロンの不一致」の品質検査を無効にする。

ignore-newline-count

「改行の不一致」の品質検査を無効にする。

ignore-plurals

「複数形の不備」の品質検査を無効にする。

ignore-placeholders

「プレースホルダー」の品質検査を無効にする。

ignore-punctuation-spacing

「句読点の間隔」の品質検査を無効にする。

ignore-regex

「正規表現」の品質検査を無効にする。

ignore-same-plurals

「同じ複数形」の品質検査を無効にする。

ignore-begin-newline

「先頭の改行」の品質検査を無効にする。

ignore-begin-space

「先頭のスペース」の品質検査を無効にする。

ignore-end-newline

「末尾の改行」の品質検査を無効にする。

ignore-end-space

「末尾のスペース」の品質検査を無効にする。

ignore-same

「未翻訳の翻訳」の品質検査を無効にする。

ignore-safe-html

「安全でない HTML」の品質検査を無効にする。

ignore-url

「URL」の品質検査を無効ににする。

ignore-xml-tags

「XMLマークアップ」の品質検査を無効にする。

ignore-xml-invalid

「XML 構文」の品質検査を無効にする。

ignore-zero-width-space

「ゼロ幅スペース」の品質検査を無効にする。

ignore-ellipsis

「省略記号」の品質検査を無効にする。

ignore-long-untranslated

「長期にわたり未翻訳」の品質検査を無効にする。

ignore-multiple-failures

「複数の検査で不合格」の品質検査を無効にする。

ignore-unnamed-format

「複数の名前のない変数」の品質検査を無効にする。

ignore-optional-plural

「複数形の不使用」の品質検査を無効にする。

注釈

基本的に、規則は名前に ignore-* という識別子がすべての検査に対して付いているため、独自の検査にも使用できます。

このフラグは、Component configuration 、原文ごとの設定、および翻訳ファイル自体（例えば GNU gettext）の両方で認識されます。

検査の強制

バージョン 3.11 で追加.

Component configuration で 検査の強制 を設定することで、無効にできない検査項目を設定できます。設定した検査項目は、ユーザーインターフェイスで除外にできず、検査で不合格となった文字列は 要編集 （参照 Translation states）と設定されます。

フォントの管理

バージョン 3.7 で追加.

レンダリングしたテキストのサイズの計算に使用する 翻訳の最大長 検査は、フォントを Weblate に読み込み、翻訳フラグ（参照 動作のカスタマイズ）を使用して選択する必要があります。

Weblate font management tool in Fonts under the Manage menu of your translation project provides interface to upload and manage fonts. TrueType or OpenType fonts can be uploaded, set up font-groups and use those in the check.

フォント グループを使用すると、言語ごとに異なるフォントを定義できます。通常、ラテン言語以外で必要:

フォント グループは名前で識別し、名前には空白文字や特殊文字を含めることはできません。このため、設定で選択して簡単に使用:

フォント ファミリとスタイルは、アップロード後に自動的に認識:

Weblate に複数のフォントを登録:

文字列の長さを確認するためにフォントを使用するには、適切なフラグ（参照 動作のカスタマイズ）を渡します。次の設定が必要になるはず:

max-size:500

最大幅の定義。

font-family:ubuntu

識別子を指定して使用するフォント グループの定義。

font-size:22

フォント サイズの定義。

独自検査の記述

幅広い品質検査を内蔵していますが（参照 品質検査）、検査したい項目をすべて網羅しているとは限りません。実行する検査の内容は、CHECK_LIST で設定できます。また、独自の検査も追加できます。

1. weblate.checks.Check をサブクラス化する

2. 複数の属性を設定する。

3. check （コードで複数形を扱う場合）または check_single メソッド（これはあなたに代わって実行）を実装する。

複数の例:

独自の検査を組み込むには、CHECK_LIST に Python クラスへの完全修飾パスを指定します、参照 品質検査、アドオン、自動修正のカスタマイズ。

翻訳テキストに「foo」が含まれていないかの確認

これは非常に単純な検査であり、翻訳に文字列「foo」を含まないかの検査をするだけです。

#
# Copyright © 2012 - 2020 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <https://weblate.org/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#
"""Simple quality check example."""

from django.utils.translation import gettext_lazy as _

from weblate.checks.base import TargetCheck


class FooCheck(TargetCheck):

    # Used as identifier for check, should be unique
    # Has to be shorter than 50 characters
    check_id = "foo"

    # Short name used to display failing check
    name = _("Foo check")

    # Description for failing check
    description = _("Your translation is foo")

    # Real check code
    def check_single(self, source, target, unit):
        return "foo" in target

チェコ語の翻訳文の複数形が異なっているかの確認

言語情報を使用して、チェコ語の 2 つの複数形が同じでないことを検査します。

#
# Copyright © 2012 - 2020 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <https://weblate.org/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#
"""Quality check example for Czech plurals."""

from django.utils.translation import gettext_lazy as _

from weblate.checks.base import TargetCheck


class PluralCzechCheck(TargetCheck):

    # Used as identifier for check, should be unique
    # Has to be shorter than 50 characters
    check_id = "foo"

    # Short name used to display failing check
    name = _("Foo check")

    # Description for failing check
    description = _("Your translation is foo")

    # Real check code
    def check_target_unit(self, sources, targets, unit):
        if self.is_language(unit, ("cs",)):
            return targets[1] == targets[2]
        return False

    def check_single(self, source, target, unit):
        """We don't check target strings here."""
        return False

機械翻訳

Built-in support for several machine translation services and can be turned on by the administrator using MT_SERVICES for each one. They come subject to their terms of use, so ensure you are allowed to use them how you want.

The source language can be configured at Project configuration.

amaGama

Special installation of tmserver run by the authors of Virtaal.

Turn on this service by adding weblate.machinery.tmserver.AmagamaTranslation to MT_SERVICES.

参考

Installing amaGama、Amagama、amaGama Translation Memory

Apertium

A libre software machine translation platform providing translations to a limited set of languages.

The recommended way to use Apertium is to run your own Apertium-APy server.

Turn on this service by adding weblate.machinery.apertium.ApertiumAPYTranslation to MT_SERVICES and set MT_APERTIUM_APY.

参考

MT_APERTIUM_APY, Apertium website, Apertium APy documentation

AWS

バージョン 3.1 で追加.

Amazon Translate is a neural machine translation service for translating text to and from English across a breadth of supported languages.

1. Turn on this service by adding weblate.machinery.aws.AWSTranslation to MT_SERVICES.

2. Install the boto3 module.

3. Configure Weblate.

参考

MT_AWS_REGION、MT_AWS_ACCESS_KEY_ID、MT_AWS_SECRET_ACCESS_KEY Amazon Translate Documentation

Baidu API machine translation

バージョン 3.2 で追加.

Machine translation service provided by Baidu.

This service uses an API and you need to obtain an ID and API key from Baidu to use it.

Turn on this service by adding weblate.machinery.baidu.BaiduTranslation to MT_SERVICES and set MT_BAIDU_ID and MT_BAIDU_SECRET.

参考

MT_BAIDU_ID、MT_BAIDU_SECRET Baidu Translate API

DeepL

バージョン 2.20 で追加.

DeepL is paid service providing good machine translation for a few languages. You need to purchase DeepL API subscription or you can use legacy DeepL Pro (classic) plan.

Turn on this service by adding weblate.machinery.deepl.DeepLTranslation to MT_SERVICES and set MT_DEEPL_KEY.

ヒント

In case you have subscription for CAT tools, you are supposed to use "v1 API" instead of default "v2" used by Weblate (it is not really an API version in this case). You can toggle this by MT_DEEPL_API_VERSION.

参考

MT_DEEPL_KEY、MT_DEEPL_API_VERSION、DeepL website 、DeepL pricing 、DeepL API documentation

Glosbe

Free dictionary and translation memory for almost every living language.

The API is gratis to use, but subject to the used data source license. There is a limit of calls that may be done from one IP in a set period of time, to prevent abuse.

Turn on this service by adding weblate.machinery.glosbe.GlosbeTranslation to MT_SERVICES.

参考

Glosbe website

Google Translate

Machine translation service provided by Google.

This service uses the Google Translation API, and you need to obtain an API key and turn on billing in the Google API console.

To turn on this service, add weblate.machinery.google.GoogleTranslation to MT_SERVICES and set MT_GOOGLE_KEY.

参考

MT_GOOGLE_KEY、Google translate documentation

Google Translate API V3 (Advanced)

Machine translation service provided by Google Cloud services.

This service differs from the former one in how it authenticates. To enable service, add weblate.machinery.googlev3.GoogleV3Translation to MT_SERVICES and set

• MT_GOOGLE_CREDENTIALS

• MT_GOOGLE_PROJECT

If location fails, you may also need to specify MT_GOOGLE_LOCATION.

参考

MT_GOOGLE_CREDENTIALS、MT_GOOGLE_PROJECT、MT_GOOGLE_LOCATION Google translate documentation

Microsoft Cognitive Services Translator

バージョン 2.10 で追加.

Machine translation service provided by Microsoft in Azure portal as a one of Cognitive Services.

Weblate implements Translator API V3.

To enable this service, add weblate.machinery.microsoft.MicrosoftCognitiveTranslation to MT_SERVICES and set MT_MICROSOFT_COGNITIVE_KEY.

Translator Text API V2

The key you use with Translator API V2 can be used with API 3.

Translator Text API V3

You need to register at Azure portal and use the key you obtain there. With new Azure keys, you also need to set MT_MICROSOFT_REGION to locale of your service.

参考

MT_MICROSOFT_COGNITIVE_KEY、MT_MICROSOFT_REGION、Cognitive Services - Text Translation API、Microsoft Azure Portal

Microsoft Terminology Service

バージョン 2.19 で追加.

The Microsoft Terminology Service API allows you to programmatically access the terminology, definitions and user interface (UI) strings available in the Language Portal through a web service.

Turn this service on by adding weblate.machinery.microsoftterminology.MicrosoftTerminologyService to MT_SERVICES.

参考

Microsoft Terminology Service API

ModernMT

バージョン 4.2 で追加.

Turn this service on by adding weblate.machinery.modernmt.ModernMTTranslation to MT_SERVICES and configure MT_MODERNMT_KEY.

参考

ModernMT API, MT_MODERNMT_KEY, MT_MODERNMT_URL

MyMemory

Huge translation memory with machine translation.

Free, anonymous usage is currently limited to 100 requests/day, or to 1000 requests/day when you provide a contact e-mail address in MT_MYMEMORY_EMAIL. You can also ask them for more.

Turn on this service by adding weblate.machinery.mymemory.MyMemoryTranslation to MT_SERVICES and set MT_MYMEMORY_EMAIL.

参考

MT_MYMEMORY_EMAIL、MT_MYMEMORY_USER、MT_MYMEMORY_KEY、MyMemory website

NetEase Sight API machine translation

バージョン 3.3 で追加.

Machine translation service provided by Netease.

This service uses an API, and you need to obtain key and secret from NetEase.

Turn on this service by adding weblate.machinery.youdao.NeteaseSightTranslation to MT_SERVICES and set MT_NETEASE_KEY and MT_NETEASE_SECRET.

参考

MT_NETEASE_KEY、MT_NETEASE_SECRET Netease Sight Translation Platform

tmserver

You can run your own translation memory server by using the one bundled with Translate-toolkit and let Weblate talk to it. You can also use it with an amaGama server, which is an enhanced version of tmserver.

1. First you will want to import some data to the translation memory:

2. Turn on this service by adding weblate.machinery.tmserver.TMServerTranslation to MT_SERVICES.

build_tmdb -d /var/lib/tm/db -s en -t cs locale/cs/LC_MESSAGES/django.po
build_tmdb -d /var/lib/tm/db -s en -t de locale/de/LC_MESSAGES/django.po
build_tmdb -d /var/lib/tm/db -s en -t fr locale/fr/LC_MESSAGES/django.po

3. Start tmserver to listen to your requests:

tmserver -d /var/lib/tm/db

4. Configure Weblate to talk to it:

MT_TMSERVER = "http://localhost:8888/tmserver/"

参考

MT_TMSERVER、tmserver Installing amaGama、Amagama、Amagama Translation Memory

Yandex Translate

Machine translation service provided by Yandex.

This service uses a Translation API, and you need to obtain an API key from Yandex.

Turn on this service by adding weblate.machinery.yandex.YandexTranslation to MT_SERVICES, and set MT_YANDEX_KEY.

参考

MT_YANDEX_KEY、Yandex Translate API 、Powered by Yandex.Translate

Youdao Zhiyun API machine translation

バージョン 3.2 で追加.

Machine translation service provided by Youdao.

This service uses an API, and you need to obtain an ID and an API key from Youdao.

Turn on this service by adding weblate.machinery.youdao.YoudaoTranslation to MT_SERVICES and set MT_YOUDAO_ID and MT_YOUDAO_SECRET.

参考

MT_YOUDAO_ID、MT_YOUDAO_SECRET Youdao Zhiyun Natural Language Translation Service

Weblate

Weblate can be the source of machine translations as well. It is based on the Woosh fulltext engine, and provides both exact and inexact matches.

Turn on these services by adding weblate.machinery.weblatetm.WeblateTranslation to MT_SERVICES.

Weblate Translation Memory

バージョン 2.20 で追加.

The 翻訳メモリ can be used as a source for machine translation suggestions as well.

Turn on these services by adding weblate.memory.machine.WeblateMemory to the MT_SERVICES. This service is turned on by default.

SAP Translation Hub

Machine translation service provided by SAP.

You need to have a SAP account (and enabled the SAP Translation Hub in the SAP Cloud Platform) to use this service.

Turn on this service by adding weblate.machinery.saptranslationhub.SAPTranslationHub to MT_SERVICES and set the appropriate access to either sandbox or the productive API.

注釈

To access the Sandbox API, you need to set MT_SAP_BASE_URL and MT_SAP_SANDBOX_APIKEY.

To access the productive API, you need to set MT_SAP_BASE_URL, MT_SAP_USERNAME and MT_SAP_PASSWORD.

参考

MT_SAP_BASE_URL、MT_SAP_SANDBOX_APIKEY、MT_SAP_USERNAME、MT_SAP_PASSWORD、MT_SAP_USE_MT SAP Translation Hub API

Custom machine translation

You can also implement your own machine translation services using a few lines of Python code. This example implements machine translation in a fixed list of languages using dictionary Python module:

#
# Copyright © 2012 - 2020 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <https://weblate.org/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#
"""Machine translation example."""

import dictionary

from weblate.machinery.base import MachineTranslation


class SampleTranslation(MachineTranslation):
    """Sample machine translation interface."""

    name = "Sample"

    def download_languages(self):
        """Return list of languages your machine translation supports."""
        return {"cs"}

    def download_translations(
        self,
        source,
        language,
        text: str,
        unit,
        user,
        search: bool,
        threshold: int = 75,
    ):
        """Return tuple with translations."""
        for t in dictionary.translate(text):
            yield {"text": t, "quality": 100, "service": self.name, "source": text}

You can list own class in MT_SERVICES and Weblate will start using that.

アドオン

バージョン 2.19 で追加.

アドオンを使用すると、翻訳ワークフローをカスタマイズできます。アドオンは翻訳コンポーネント画面にインストールして、バックグラウンドで動作します。アドオン管理は、管理者用の各翻訳コンポーネントの 管理 ↓ アドオン メニューから実行します。

内蔵アドオン

自動翻訳

バージョン 3.9 で追加.

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

このアドオンは、コンポーネントに新しい文字列が表示されると自動的に実行します。

参考

自動翻訳、Keeping translations same across components

JavaScript 現地語化 CDN

バージョン 4.2 で追加.

JavaScript または HTML の現地語化用に CDN を追加します。

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

アドオンをインストールすると、コンポーネント専用の URL が生成されます。この URL を HTML ドキュメントに含めると、コンポーネントを現地語化できます。詳細は Translating HTML and JavaScript using Weblate CDN を参照してください。

参考

Weblate CDN アドオンの設定、Translating HTML and JavaScript using Weblate CDN、Weblate CDN の文字列抽出、Weblate CDN を使用した HTML の現地化

空白文字列の削除

バージョン 4.4 で追加.

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

Use this if you do not want empty strings to appear in translation files (for example when your localization library displays them as empty strings instead of falling back to the source string).

参考

Does Weblate update translation files besides translations?

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

単一言語の基本ファイルに合わせてすべての翻訳ファイルを更新します。ほとんどのファイル形式で、基本ファイルに存在しない、無効な翻訳キーを削除します。

参考

Does Weblate update translation files besides translations?

言語の一貫性

1 つのプロジェクト内のすべてのコンポーネントに、追加されたすべての言語の翻訳を適用します。

コンポーネントを追加していない言語では、空の翻訳を作成します。

存在しない言語は、24 時間ごとに 1 回、および新しい言語を Weblate に追加したときに確認します。

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

ヒント

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

コンポーネントの検出

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

これは VCS を更新するたびに起動し、その他は、import_project 管理コマンドと同じです。この方法で、1 つの VCS 内で複数の変換コンポーネントを追跡できます。

今後消える可能性が最も低いメイン コンポーネントを 1 つ作成します。他のコンポーネントは、Weblate の内部 URL を VCS 設定として使用し、その中のすべてのコンポーネントを検索するように設定します。

コンポーネントの照合は正規表現を使用するが、この場合、性能は設定の複雑さとトレードオフになります。一般的な使用例については、アドオンのヘルプ セクションを参照してください。

保存 をクリックすると、一致するコンポーネントのプレビューを表示し、設定が実際のニーズに合っているか確認できます:

参考

Template markup

一括編集

バージョン 3.11 で追加.

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

新しい文字列のラベル付けを自動化すると便利です (まず NOT has:label という検索クエリから開始し、すべての文字列に適切なラベルが付けられるまで必要なラベルを追加します)。Weblate メタデータに対するその他の自動操作も実行できます。

例:

新しい文字列に自動的にラベルを追加

検索クエリ	NOT has:label
ラベルの追加	最近の

Marking all アプリ ストア メタデータ ファイル changelog entries read-only

検索クエリ	language:en AND key:changelogs/
翻訳フラグの追加	read-only

参考

一括編集

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

バージョン 3.1 で追加.

VCS からインポートされた新しい翻訳可能な文字列が原文と一致するたびに、Weblate は "要編集" フラグを付けます。これは、文字列が翻訳されていない場合であっても、すべての文字列を含むファイル形式には特に便利です。

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

新しい原文を VCS からインポートすると、Weblate は毎回 "要編集" フラグを付けます。このため、開発者が作成した原文を簡単にフィルタしたり、編集したりできます。

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

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

統計データの生成

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

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

たとえば、各翻訳の概要ファイルを生成する:

生成ファイルの名前

locale/{{ language_code }}.json

内容

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

参考

Template markup

コメント内の貢献者情報

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

PO ファイル ヘッダーには、貢献者と貢献年の一覧を含みます。

# Michal Čihař <michal@cihar.com>, 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 変数の更新

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

gettext 出力のカスタマイズ

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

以下のオプションがあります:

• Wrap lines at 77 characters and at newlines

• 改行文字でのみ改行する

• 改行しない

注釈

By default gettext wraps lines at 77 characters and for newlines. With the --no-wrap parameter, it wraps only at newlines.

LINGUAS ファイルの更新

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

MO ファイルの生成

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

The location of the generated MO file can be customized and the field for it uses Template markup.

POT に一致する PO ファイルの更新 (msgmerge)

Updates all PO files (as configured by File mask) to match the POT file (as configured by 新しい翻訳のテンプレート) using msgmerge.

このアドオンは、新しい変更が upstream リポジトリから新しい変更をプルするたびに実行されます。msgmerge のコマンド ライン オプションの大部分はアドオンの設定で設定できます。

参考

Does Weblate update translation files besides translations?

Git コミットをスカッシュ

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

以下のモードを選択することができます:

バージョン 3.4 で追加.

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

• 言語別に

• ファイル別に

バージョン 3.5 で追加.

• 翻訳者別に

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

バージョン 4.1 で追加.

The original commit messages can optionally be overridden with a custom commit message.

Trailers (commit lines like Co-authored-by: ...) can optionally be removed from the original commit messages and appended to the end of the squashed commit message. This also generates proper Co-authored-by: credit for every translator.

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

インデント処理や並べ替えなど、JSON 出力形式を調整できます。

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

Java プロパティ ファイルをソートします。

古いコメントの削除

バージョン 3.7 で追加.

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

This can be useful to remove old comments which might have become outdated. Use with care as comment being old does not mean they have lost their importance.

古い提案の削除

バージョン 3.7 で追加.

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

This can be very useful in connection with suggestion voting (see 相互評価) to remove suggestions which don't receive enough positive votes in a given timeframe.

RESX ファイルの更新

バージョン 3.9 で追加.

アップストリームの単一言語の基本ファイルに合わせて、すべての翻訳ファイルを更新します。使われていない文字列は削除し、新しい文字列は原文のコピーとして追加します。

ヒント

Use 翻訳ファイルのクリーンアップ if you only want to remove stale translation keys.

参考

Does Weblate update translation files besides translations?

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

バージョン 3.10.2 で追加.

行の長さや改行など、YAML 出力の動作を調整できます。

Customizing list of addons

The list of addons is configured by WEBLATE_ADDONS. To add another addon, simply include class absolute name in this setting.

Writing addon

You can write your own addons too, all you need to do is subclass weblate.addons.base.BaseAddon, define the addon metadata and implement a callback which will do the processing.

参考

アドオンの開発

Executing scripts from addon

Addons can also be used to execute external scripts. This used to be integrated in Weblate, but now you have to write some code to wrap your script with an addon.

#
# Copyright © 2012 - 2020 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <https://weblate.org/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#
"""Example pre commit script."""


from django.utils.translation import gettext_lazy as _

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


class ExamplePreAddon(BaseScriptAddon):
    # Event used to trigger the script
    events = (EVENT_PRE_COMMIT,)
    # Name of the addon, has to be unique
    name = "weblate.example.pre"
    # Verbose name and long descrption
    verbose = _("Execute script before commit")
    description = _("This addon 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"

For installation instructions see 品質検査、アドオン、自動修正のカスタマイズ.

The script is executed with the current directory set to the root of the VCS repository for any given component.

Additionally, the following environment variables are available:

WL_VCS

Version control system used.

WL_REPO

Upstream repository URL.

WL_PATH

Absolute path to VCS repository.

WL_BRANCH

バージョン 2.11 で追加.

Repository branch configured in the current component.

WL_FILEMASK

Filemask for current component.

WL_TEMPLATE

Filename of template for monolingual translations (can be empty).

WL_NEW_BASE

バージョン 2.14 で追加.

Filename of the file used for creating new translations (can be empty).

WL_FILE_FORMAT

Fileformat used in current component.

WL_LANGUAGE

Language of currently processed translation (not available for component level hooks).

WL_PREVIOUS_HEAD

Previous HEAD on update (available only when running post update hook).

WL_COMPONENT_SLUG

バージョン 3.9 で追加.

Component slug used to construct URL.

WL_PROJECT_SLUG

バージョン 3.9 で追加.

Project slug used to construct URL.

WL_COMPONENT_NAME

バージョン 3.9 で追加.

Component name.

WL_PROJECT_NAME

バージョン 3.9 で追加.

Project name.

WL_COMPONENT_URL

バージョン 3.9 で追加.

Component URL.

WL_ENGAGE_URL

バージョン 3.9 で追加.

Project engage URL.

参考

Component configuration

Post update repository processing

Post update repository processing can be used to update translation files when the VCS upstream source changes. To achieve this, please remember that Weblate only sees files committed to the VCS, so you need to commit changes as a part of the script.

For example with Gulp you can do it using following code:

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

Pre commit processing of translations

Use the commit script to automatically make changes to the translation before it is committed to the repository.

It is passed as a single parameter consisting of the filename of a current translation.

翻訳メモリ

バージョン 2.20 で追加.

Weblate comes with a built-in translation memory consisting of the following:

• Manually imported translation memory (see User interface).

• Automatically stored translations performed in Weblate (depending on Translation memory scopes).

• Automatically imported past translations.

Content in the translation memory can be applied one of two ways:

• Manually, 自動提案 view while translating.

• Automatically, by translating strings using 自動翻訳, or 自動翻訳 addon.

For installation tips, see Weblate Translation Memory, which is turned on by default.

Translation memory scopes

バージョン 3.2 で追加: In earlier versions translation memory could be only loaded from a file corresponding to the current imported translation memory scope.

The translation memory scopes are there to allow both privacy and sharing of translations, to suit the desired behavior.

Imported translation memory

Importing arbitrary translation memory data using the import_memory command makes memory content available to all users and projects.

Per user translation memory

Stores all user translations automatically in the personal translation memory of each respective user.

Per project translation memory

All translations within a project are automatically stored in a project translation memory only available for this project.

共有翻訳メモリ

All translation within projects with shared translation memory turned on are stored in a shared translation memory available to all projects.

Please consider carefully whether to turn this feature on for shared Weblate installations, as it can have severe implications:

• The translations can be used by anybody else.

• This might lead to disclosing secret information.

Managing translation memory

User interface

バージョン 3.2 で追加.

In the basic user interface you can manage per user and per project translation memories. It can be used to download, wipe or import translation memory.

ヒント

Translation memory in JSON can be imported into Weblate, TMX is provided for interoperability with other tools.

参考

Weblate 翻訳メモリ概要

Management interface

There are several management commands to manipulate the translation memory content. These operate on the translation memory as whole, unfiltered by scopes (unless requested by parameters):

dump_memory

Exports the memory into JSON

import_memory

Imports TMX or JSON files into the translation memory

設定

すべての設定は settings.py に保存されます（Django の通常の方法）。

注釈

これらの設定の変更後、Weblate（WSGI プロセスと Celery プロセスの両方）の再起動が必要です。

mod_wsgi として実行する場合は、Apache を再起動して設定のリロードが必要です。

参考

Django 本体の設定パラメーターについては、 Django's documentation も確認してください。

AKISMET_API_KEY

Weblate は Akismet を使用して、匿名の提案がスパムであるか検査できます。API キーを購入してサイトに関連付けるには、akismet.com にアクセスしてください。

ANONYMOUS_USER_NAME

サインインしていないユーザーのユーザー名。

参考

アクセス制御

AUDITLOG_EXPIRY

バージョン 3.6 で追加.

アカウントの作業履歴に関する情報を含む監査ログを Weblate が保持する日数。

デフォルトは 180 日です。

AUTH_LOCK_ATTEMPTS

バージョン 2.14 で追加.

レート制限を適用する前に失敗した認証試行の最大回数。

現在、以下の場所に適用しています:

• ログイン。アカウント パスワードを削除し、ユーザーが新しいパスワードを要求しなければサインインできないようにしています。

• Password resets. Prevents new e-mails from being sent, avoiding spamming users with too many password reset attempts.

Defaults to 10.

参考

レート制限、

AUTO_UPDATE

バージョン 3.2 で追加.

バージョン 3.11 で変更: The original on/off option was changed to differentiate which strings are accepted.

Updates all repositories on a daily basis.

ヒント

Useful if you are not using 通知フック to update Weblate repositories automatically.

注釈

On/off options exist in addition to string selection for backward compatibility.

Options are:

"none"

No daily updates.

"remote" also False

Only update remotes.

"full" also True

Update remotes and merge working copy.

注釈

This requires that Background tasks using Celery is working, and will take effect after it is restarted.

AVATAR_URL_PREFIX

Prefix for constructing avatar URLs as: ${AVATAR_URL_PREFIX}/avatar/${MAIL_HASH}?${PARAMS}. The following services are known to work:

Gravatar (default), as per https://gravatar.com/

AVATAR_URL_PREFIX = 'https://www.gravatar.com/'

Libravatar, as per https://www.libravatar.org/

AVATAR_URL_PREFIX = 'https://www.libravatar.org/'

参考

アバターのキャッシュ、ENABLE_AVATARS、Avatars

AUTH_TOKEN_VALID

バージョン 2.14 で追加.

How long the authentication token and temporary password from password reset e-mails is valid for. Set in number of seconds, defaulting to 172800 (2 days).

AUTH_PASSWORD_DAYS

バージョン 2.15 で追加.

How many days using the same password should be allowed.

注釈

Password changes made prior to Weblate 2.15 will not be accounted for in this policy.

デフォルトは 180 日です。

AUTOFIX_LIST

List of automatic fixes to apply when saving a string.

注釈

Provide a fully-qualified path to the Python class that implementing the autofixer interface.

Available fixes:

weblate.trans.autofixes.whitespace.SameBookendingWhitespace

Matches whitespace at the start and end of the string to the source.

weblate.trans.autofixes.chars.ReplaceTrailingDotsWithEllipsis

Replaces trailing dots (...) if the source string has ellipsis (…).

weblate.trans.autofixes.chars.RemoveZeroSpace

Removes zero-width space characters if the source does not contain any.

weblate.trans.autofixes.chars.RemoveControlChars

Removes control characters if the source does not contain any.

weblate.trans.autofixes.html.BleachHTML

Removes unsafe HTML markup from strings flagged as safe-html (see 安全でない HTML).

You can select which ones to use:

AUTOFIX_LIST = (
    "weblate.trans.autofixes.whitespace.SameBookendingWhitespace",
    "weblate.trans.autofixes.chars.ReplaceTrailingDotsWithEllipsis",
)

参考

自動修正、自動修正のカスタマイズ

BASE_DIR

Base directory where Weblate sources are located. Used to derive several other paths by default:

• DATA_DIR

Default value: Top level directory of Weblate sources.

BASIC_LANGUAGES

バージョン 4.4 で追加.

List of languages to offer users for starting new translation. When not specified built in list is used which includes all commonly used languages, but without country specific variants.

This only limits non privileged users to add unwanted languages. The project admins are still presented with full selection of languages defined in Weblate.

注釈

This does not define new languages for Weblate, it only filters existing ones in the database.

Example:

BASIC_LANGUAGES = {"cs", "it", "ja", "en"}

参考

Language definitions

CSP_SCRIPT_SRC, CSP_IMG_SRC, CSP_CONNECT_SRC, CSP_STYLE_SRC, CSP_FONT_SRC

Customize Content-Security-Policy header for Weblate. The header is automatically generated based on enabled integrations with third-party services (Matomo, Google Analytics, Sentry, ...).

All these default to empty list.

Example:

# Enable Cloudflare Javascript optimizations
CSP_SCRIPT_SRC = ["ajax.cloudflare.com"]

参考

Content security policy, Content Security Policy (CSP)

CHECK_LIST

翻訳に対して実行する品質検査のリストです。

注釈

check インタフェースを実装する Python クラスへの完全修飾パスを指定します。

検査するリストを調整して、関連する検査を含めます。

デフォルトでは、内蔵したすべての 品質検査 が有効なっているので、ここで設定を変更できます。デフォルトでは、サンプル設定 でコメント化されているため、デフォルト値が使用されます。その後は、Weblate の新しいバージョンのリリースのたびに新しい検査が行われます。

すべての検査を無効にする:

CHECK_LIST = ()

指定する項目だけ有効にする:

CHECK_LIST = (
    "weblate.checks.chars.BeginNewlineCheck",
    "weblate.checks.chars.EndNewlineCheck",
    "weblate.checks.chars.MaxLengthCheck",
)

注釈

この設定を変更すると、新しく変更した翻訳のみ検査されて、過去の検査結果は引き続きデータベースに保存されたままです。保存されている翻訳にも、新しい検査を適用するには、updatechecks を実行します。

参考

品質検査、動作のカスタマイズ

COMMENT_CLEANUP_DAYS

バージョン 3.6 で追加.

Delete comments after a given number of days. Defaults to None, meaning no deletion at all.

COMMIT_PENDING_HOURS

バージョン 2.10 で追加.

Number of hours between committing pending changes by way of the background task.

参考

Component configuration、コミットするまでの経過時間、Running maintenance tasks、commit_pending

DATA_DIR

The folder Weblate stores all data in. It contains links to VCS repositories, a fulltext index and various configuration files for external tools.

The following subdirectories usually exist:

home

Home directory used for invoking scripts.

ssh

SSH keys and configuration.

static

Default location for static Django files, specified by STATIC_ROOT.

media

Default location for Django media files, specified by MEDIA_ROOT.

vcs

Version control repositories.

backups

Daily backup data, please check Dumped data for backups for details.

注釈

This directory has to be writable by Weblate. Running it as uWSGI means the www-data user should have write access to it.

The easiest way to achieve this is to make the user the owner of the directory:

sudo chown www-data:www-data -R $DATA_DIR

Defaults to $BASE_DIR/data.

参考

BASE_DIR、Backing up and moving Weblate

DATABASE_BACKUP

バージョン 3.1 で追加.

Whether the database backups should be stored as plain text, compressed or skipped. The authorized values are:

• "plain"

• "compressed"

• "none"

参考

Backing up and moving Weblate

DEFAULT_ACCESS_CONTROL

バージョン 3.3 で追加.

The default access control setting for new projects:

0

Public

1

Protected

100

Private

200

Custom

Use Custom if you are managing ACL manually, which means not relying on the internal Weblate management.

参考

プロジェクトのアクセス制御、アクセス制御、アクセス制御

DEFAULT_RESTRICTED_COMPONENT

バージョン 4.1 で追加.

The default value for component restriction.

参考

プロジェクトのアクセス制御、Restricted access、アクセス制御

DEFAULT_ADD_MESSAGE, DEFAULT_ADDON_MESSAGE, DEFAULT_COMMIT_MESSAGE, DEFAULT_DELETE_MESSAGE, DEFAULT_MERGE_MESSAGE

Default commit messages for different operations, please check Component configuration for details.

参考

Template markup、Component configuration、Commit, add, delete, merge and addon messages

DEFAULT_ADDONS

Default addons to install on every created component.

注釈

This setting affects only newly created components.

例:

DEFAULT_ADDONS = {
    # Addon with no parameters
    "weblate.flags.target_edit": {},
    # Addon with parameters
    "weblate.autotranslate.autotranslate": {
        "mode": "suggest",
        "filter_type": "todo",
        "auto_source": "mt",
        "component": "",
        "engines": ["weblate-translation-memory"],
        "threshold": "80",
    },
}

参考

install_addon, WEBLATE_ADDONS

DEFAULT_COMMITER_EMAIL

バージョン 2.4 で追加.

Committer e-mail address for created translation components defaulting to noreply@weblate.org.

参考

DEFAULT_COMMITER_NAME、Component configuration、コミッタのメールアドレス

DEFAULT_COMMITER_NAME

バージョン 2.4 で追加.

Committer name for created translation components defaulting to Weblate.

参考

DEFAULT_COMMITER_EMAIL、Component configuration、コミッタの名前

DEFAULT_LANGUAGE

バージョン 4.3.2 で追加.

Default source language to use for example in 原文の言語.

Defaults to en. The matching language object needs to exist in the database.

参考

Language definitions、原文の言語

DEFAULT_MERGE_STYLE

バージョン 3.4 で追加.

Merge style for any new components.

• rebase - default

• merge

参考

Component configuration、マージスタイル

DEFAULT_TRANSLATION_PROPAGATION

バージョン 2.5 で追加.

Default setting for translation propagation, defaults to True.

参考

Component configuration、翻訳の伝達を許可する

DEFAULT_PULL_MESSAGE

Title for new pull requests, defaulting to 'Update from Weblate'.

ENABLE_AVATARS

Whether to turn on Gravatar-based avatars for users. By default this is on.

Avatars are fetched and cached on the server, lowering the risk of leaking private info, speeding up the user experience.

参考

アバターのキャッシュ、AVATAR_URL_PREFIX、Avatars

ENABLE_HOOKS

Whether to enable anonymous remote hooks.

参考

通知フック

ENABLE_HTTPS

Whether to send links to Weblate as HTTPS or HTTP. This setting affects sent e-mails and generated absolute URLs.

ヒント

In the default configuration this is also used for several Django settings related to HTTPS.

参考

SESSION_COOKIE_SECURE、CSRF_COOKIE_SECURE、SECURE_SSL_REDIRECT、Set correct site domain

ENABLE_SHARING

Turn on/off the Share menu so users can share translation progress on social networks.

GITLAB_CREDENTIALS

バージョン 4.3 で追加.

List for credentials for GitLab servers.

ヒント

Use this in case you want Weblate to interact with more of them, for single GitLab endpoint stick with GITLAB_USERNAME and GITLAB_TOKEN.

GITLAB_CREDENTIALS = {
    "gitlab.com": {
        "username": "weblate",
        "token": "your-api-token",
    },
    "gitlab.example.com": {
        "username": "weblate",
        "token": "another-api-token",
    },
}

GITLAB_USERNAME

GitLab username used to send merge requests for translation updates.

参考

GITLAB_CREDENTIALS、GitLab

GITLAB_TOKEN

バージョン 4.3 で追加.

翻訳の更新に使用する API 呼び出しの GitLab 個人用アクセス トークン。

参考

GITLAB_CREDENTIALS、GitLab、GitLab: Personal access token

GITHUB_CREDENTIALS

バージョン 4.3 で追加.

List for credentials for GitHub servers.

ヒント

Use this in case you want Weblate to interact with more of them, for single GitHub endpoint stick with GITHUB_USERNAME and GITHUB_TOKEN.

GITHUB_CREDENTIALS = {
    "api.github.com": {
        "username": "weblate",
        "token": "your-api-token",
    },
    "github.example.com": {
        "username": "weblate",
        "token": "another-api-token",
    },
}

GITHUB_USERNAME

GitHub username used to send pull requests for translation updates.

参考

GITHUB_CREDENTIALS、GitHub

GITHUB_TOKEN

バージョン 4.3 で追加.

GitHub personal access token used to make API calls to send pull requests for translation updates.

参考

GITHUB_CREDENTIALS、GitHub、Creating a personal access token

GOOGLE_ANALYTICS_ID

Google Analytics ID to turn on monitoring of Weblate using Google Analytics.

HIDE_REPO_CREDENTIALS

Hide repository credentials from the web interface. In case you have repository URL with user and password, Weblate will hide it when related info is shown to users.

For example instead of https://user:password@git.example.com/repo.git it will show just https://git.example.com/repo.git. It tries to clean up VCS error messages too in a similar manner.

注釈

This is turned on by default.

HIDE_VERSION

バージョン 4.3.1 で追加.

Hides version information from unauthenticated users. This also makes all documentation links point to latest version instead of the documentation matching currently installed version.

Hiding version is recommended security practice in some corporations, but it doesn't prevent attacker to figure out version by probing the behavior.

注釈

デフォルトで無効化されています。

IP_BEHIND_REVERSE_PROXY

バージョン 2.14 で追加.

Indicates whether Weblate is running behind a reverse proxy.

If set to True, Weblate gets IP address from a header defined by IP_PROXY_HEADER.

警告

Ensure you are actually using a reverse proxy and that it sets this header, otherwise users will be able to fake the IP address.

注釈

This is not on by default.

参考

Running behind reverse proxy、レート制限、IP_PROXY_HEADER、IP_PROXY_OFFSET

IP_PROXY_HEADER

バージョン 2.14 で追加.

Indicates which header Weblate should obtain the IP address from when IP_BEHIND_REVERSE_PROXY is turned on.

Defaults to HTTP_X_FORWARDED_FOR.

参考

Running behind reverse proxy、レート制限、SECURE_PROXY_SSL_HEADER、IP_BEHIND_REVERSE_PROXY、IP_PROXY_OFFSET

IP_PROXY_OFFSET

バージョン 2.14 で追加.

Indicates which part of IP_PROXY_HEADER is used as client IP address.

Depending on your setup, this header might consist of several IP addresses, (for example X-Forwarded-For: a, b, client-ip) and you can configure which address from the header is used as client IP address here.

警告

Setting this affects the security of your installation, you should only configure it to use trusted proxies for determining IP address.

Defaults to 0.

参考

Running behind reverse proxy、レート制限、SECURE_PROXY_SSL_HEADER, IP_BEHIND_REVERSE_PROXY、IP_PROXY_HEADER

LEGAL_URL

バージョン 3.5 で追加.

URL where your Weblate instance shows its legal documents.

ヒント

Useful if you host your legal documents outside Weblate for embedding them inside Weblate, please check 法律上の告知事項 for details.

例:

LEGAL_URL = "https://weblate.org/terms/"

LICENSE_EXTRA

Additional licenses to include in the license choices.

注釈

Each license definition should be tuple of its short name, a long name and an URL.

For example:

LICENSE_EXTRA = [
    (
        "AGPL-3.0",
        "GNU Affero General Public License v3.0",
        "https://www.gnu.org/licenses/agpl-3.0-standalone.html",
    ),
]

LICENSE_FILTER

バージョン 4.3 で変更: Setting this to blank value now disables license alert.

Filter list of licenses to show. This also disables the license alert when set to empty.

注釈

This filter uses the short license names.

For example:

LICENSE_FILTER = {"AGPL-3.0", "GPL-3.0-or-later"}

Following disables the license alert:

LICENSE_FILTER = set()

参考

Translation component alerts

LICENSE_REQUIRED

Defines whether the license attribute in Component configuration is required.

注釈

This is off by default.

LIMIT_TRANSLATION_LENGTH_BY_SOURCE_LENGTH

Whether the length of a given translation should be limited. The restriction is the length of the source string * 10 characters.

ヒント

Set this to False to allow longer translations (up to 10.000 characters) irrespective of source string length.

注釈

Defaults to True.

LOCALIZE_CDN_URL and LOCALIZE_CDN_PATH

These settings configure the JavaScript 現地語化 CDN addon. LOCALIZE_CDN_URL defines root URL where the localization CDN is available and LOCALIZE_CDN_PATH defines path where Weblate should store generated files which will be served at the LOCALIZE_CDN_URL.

ヒント

On Hosted Weblate, this uses https://weblate-cdn.com/.

参考

JavaScript 現地語化 CDN

LOGIN_REQUIRED_URLS

A list of URLs you want to require logging into. (Besides the standard rules built into Weblate).

ヒント

This allows you to password protect a whole installation using:

LOGIN_REQUIRED_URLS = (r"/(.*)$",)
REST_FRAMEWORK["DEFAULT_PERMISSION_CLASSES"] = [
    "rest_framework.permissions.IsAuthenticated"
]

ヒント

It is desirable to lock down API access as well, as shown in the above example.

LOGIN_REQUIRED_URLS_EXCEPTIONS

List of exceptions for LOGIN_REQUIRED_URLS. If not specified, users are allowed to access the sign in page.

Some of exceptions you might want to include:

LOGIN_REQUIRED_URLS_EXCEPTIONS = (
    r"/accounts/(.*)$",  # Required for sign in
    r"/static/(.*)$",  # Required for development mode
    r"/widgets/(.*)$",  # Allowing public access to widgets
    r"/data/(.*)$",  # Allowing public access to data exports
    r"/hooks/(.*)$",  # Allowing public access to notification hooks
    r"/api/(.*)$",  # Allowing access to API
    r"/js/i18n/$",  # JavaScript localization
)

MATOMO_SITE_ID

ID of a site in Matomo (formerly Piwik) you want to track.

注釈

This integration does not support the Matomo Tag Manager.

参考

MATOMO_URL

MATOMO_URL

Full URL (including trailing slash) of a Matomo (formerly Piwik) installation you want to use to track Weblate use. Please check <https://matomo.org/> for more details.

ヒント

This integration does not support the Matomo Tag Manager.

For example:

MATOMO_SITE_ID = 1
MATOMO_URL = "https://example.matomo.cloud/"

参考

MATOMO_SITE_ID

MT_SERVICES

バージョン 3.0 で変更: The setting was renamed from MACHINE_TRANSLATION_SERVICES to MT_SERVICES to be consistent with other machine translation settings.

List of enabled machine translation services to use.

注釈

Many of the services need additional configuration like API keys, please check their documentation 機械翻訳 for more details.

MT_SERVICES = (
    "weblate.machinery.apertium.ApertiumAPYTranslation",
    "weblate.machinery.deepl.DeepLTranslation",
    "weblate.machinery.glosbe.GlosbeTranslation",
    "weblate.machinery.google.GoogleTranslation",
    "weblate.machinery.microsoft.MicrosoftCognitiveTranslation",
    "weblate.machinery.microsoftterminology.MicrosoftTerminologyService",
    "weblate.machinery.mymemory.MyMemoryTranslation",
    "weblate.machinery.tmserver.AmagamaTranslation",
    "weblate.machinery.tmserver.TMServerTranslation",
    "weblate.machinery.yandex.YandexTranslation",
    "weblate.machinery.weblatetm.WeblateTranslation",
    "weblate.machinery.saptranslationhub.SAPTranslationHub",
    "weblate.memory.machine.WeblateMemory",
)

参考

機械翻訳、自動提案

MT_APERTIUM_APY

URL of the Apertium-APy server, https://wiki.apertium.org/wiki/Apertium-apy

参考

Apertium、機械翻訳、自動提案

MT_AWS_ACCESS_KEY_ID

Access key ID for Amazon Translate.

参考

AWS、機械翻訳、自動提案

MT_AWS_SECRET_ACCESS_KEY

API secret key for Amazon Translate.

参考

AWS、機械翻訳、自動提案

MT_AWS_REGION

Region name to use for Amazon Translate.

参考

AWS、機械翻訳、自動提案

MT_BAIDU_ID

Client ID for the Baidu Zhiyun API, you can register at https://api.fanyi.baidu.com/api/trans/product/index

参考

Baidu API machine translation、機械翻訳、自動提案

MT_BAIDU_SECRET

Client secret for the Baidu Zhiyun API, you can register at https://api.fanyi.baidu.com/api/trans/product/index

参考

Baidu API machine translation、機械翻訳、自動提案

MT_DEEPL_API_VERSION

バージョン 4.1.1 で追加.

API version to use with DeepL service. The version limits scope of usage:

v1

Is meant for CAT tools and is usable with user-based subscription.

v2

Is meant for API usage and the subscription is usage based.

Previously Weblate was classified as a CAT tool by DeepL, so it was supposed to use the v1 API, but now is supposed to use the v2 API. Therefore it defaults to v2, and you can change it to v1 in case you have an existing CAT subscription and want Weblate to use that.

参考

DeepL、機械翻訳、自動提案

MT_DEEPL_KEY

API key for the DeepL API, you can register at https://www.deepl.com/pro.html

参考

DeepL、機械翻訳、自動提案

MT_GOOGLE_KEY

API key for Google Translate API v2, you can register at https://cloud.google.com/translate/docs

参考

Google Translate、機械翻訳、自動提案

MT_GOOGLE_CREDENTIALS

API v3 JSON credentials file obtained in the Google cloud console. Please provide a full OS path. Credentials are per service-account affiliated with certain project. Please check https://cloud.google.com/docs/authentication/getting-started for more details.

MT_GOOGLE_PROJECT

Google Cloud API v3 project id with activated translation service and billing activated. Please check https://cloud.google.com/appengine/docs/standard/nodejs/building-app/creating-project for more details

MT_GOOGLE_LOCATION

API v3 Google Cloud App Engine may be specific to a location. Change accordingly if the default global fallback does not work for you.

Please check https://cloud.google.com/appengine/docs/locations for more details

参考

Google Translate API V3 (Advanced)

MT_MICROSOFT_BASE_URL

Region base URL domain as defined in the "Base URLs" section.

Defaults to api.cognitive.microsofttranslator.com for Azure Global.

For Azure China, please use api.translator.azure.cn.

MT_MICROSOFT_COGNITIVE_KEY

Client key for the Microsoft Cognitive Services Translator API.

参考

Microsoft Cognitive Services Translator、機械翻訳、自動提案、Cognitive Services - Text Translation API、Microsoft Azure Portal

MT_MICROSOFT_REGION

Region prefix as defined in the "Authenticating with a Multi-service resource" section.

MT_MICROSOFT_ENDPOINT_URL

Region endpoint URL domain for access token as defined in the "Authenticating with an access token" section.

Defaults to api.cognitive.microsoft.com for Azure Global.

For Azure China, please use your endpoint from the Azure Portal.

MT_MODERNMT_KEY

ModernMT 機械翻訳エンジンの API キー。

参考

ModernMT MT_MODERNMT_URL

MT_MODERNMT_URL

URL of ModernMT. It defaults to https://api.modernmt.com/ for the cloud service.

参考

ModernMT MT_MODERNMT_KEY

MT_MYMEMORY_EMAIL

MyMemory identification e-mail address. It permits 1000 requests per day.

参考

MyMemory、機械翻訳、自動提案、MyMemory: API technical specifications

MT_MYMEMORY_KEY

MyMemory access key for private translation memory, use it with MT_MYMEMORY_USER.

参考

MyMemory、機械翻訳、自動提案、MyMemory: API key generator

MT_MYMEMORY_USER

MyMemory user ID for private translation memory, use it with MT_MYMEMORY_KEY.

参考

MyMemory、機械翻訳、自動提案、MyMemory: API key generator

MT_NETEASE_KEY

App key for NetEase Sight API, you can register at https://sight.youdao.com/

参考

NetEase Sight API machine translation、機械翻訳、自動提案

MT_NETEASE_SECRET

App secret for the NetEase Sight API, you can register at https://sight.youdao.com/

参考

NetEase Sight API machine translation、機械翻訳、自動提案

MT_TMSERVER

URL where tmserver is running.

参考

tmserver、機械翻訳、自動提案、tmserver

MT_YANDEX_KEY

API key for the Yandex Translate API, you can register at https://yandex.com/dev/translate/

参考

Yandex Translate、機械翻訳、自動提案

MT_YOUDAO_ID

Client ID for the Youdao Zhiyun API, you can register at https://ai.youdao.com/product-fanyi-text.s.

参考

Youdao Zhiyun API machine translation、機械翻訳、自動提案

MT_YOUDAO_SECRET

Client secret for the Youdao Zhiyun API, you can register at https://ai.youdao.com/product-fanyi-text.s.

参考

Youdao Zhiyun API machine translation、機械翻訳、自動提案

MT_SAP_BASE_URL

API URL to the SAP Translation Hub service.

参考

SAP Translation Hub、機械翻訳、自動提案

MT_SAP_SANDBOX_APIKEY

API key for sandbox API usage

参考

SAP Translation Hub、機械翻訳、自動提案

MT_SAP_USERNAME

Your SAP username

参考

SAP Translation Hub、機械翻訳、自動提案

MT_SAP_PASSWORD

Your SAP password

参考

SAP Translation Hub、機械翻訳、自動提案

MT_SAP_USE_MT

Whether to also use machine translation services, in addition to the term database. Possible values: True or False

参考

SAP Translation Hub、機械翻訳、自動提案

NEARBY_MESSAGES

How many strings to show around the currently translated string. This is just a default value, users can adjust this in ユーザー情報.

PAGURE_CREDENTIALS

バージョン 4.3.2 で追加.

Pagure サーバーの資格情報の一覧です。

ヒント

Use this in case you want Weblate to interact with more of them, for single Pagure endpoint stick with PAGURE_USERNAME and PAGURE_TOKEN.

PAGURE_CREDENTIALS = {
    "pagure.io": {
        "username": "weblate",
        "token": "your-api-token",
    },
    "pagure.example.com": {
        "username": "weblate",
        "token": "another-api-token",
    },
}

PAGURE_USERNAME

バージョン 4.3.2 で追加.

翻訳を更新するマージ リクエストを送信するために使用する Pagure のユーザー名。

参考

PAGURE_CREDENTIALS、Pagure

PAGURE_TOKEN

バージョン 4.3.2 で追加.

翻訳の更新に使用する API 呼び出し Pagure の個人用アクセス トークン。

参考

PAGURE_CREDENTIALS、Pagure、Pagure API

RATELIMIT_ATTEMPTS

バージョン 3.2 で追加.

Maximum number of authentication attempts before rate limiting is applied.

Defaults to 5.

参考

レート制限、RATELIMIT_WINDOW、RATELIMIT_LOCKOUT

RATELIMIT_WINDOW

バージョン 3.2 で追加.

How long authentication is accepted after rate limiting applies.

An amount of seconds defaulting to 300 (5 minutes).

参考

レート制限、RATELIMIT_ATTEMPTS、RATELIMIT_LOCKOUT

RATELIMIT_LOCKOUT

バージョン 3.2 で追加.

How long authentication is locked after rate limiting applies.

An amount of seconds defaulting to 600 (10 minutes).

参考

レート制限、RATELIMIT_ATTEMPTS、RATELIMIT_WINDOW

REGISTRATION_ALLOW_BACKENDS

バージョン 4.1 で追加.

List of authentication backends to allow registration from. This only limits new registrations, users can still authenticate and add authentication using all configured authentication backends.

It is recommended to keep REGISTRATION_OPEN enabled while limiting registration backends, otherwise users will be able to register, but Weblate will not show links to register in the user interface.

例:

REGISTRATION_ALLOW_BACKENDS = ["azuread-oauth2", "azuread-tenant-oauth2"]

ヒント

The backend names match names used in URL for authentication.

参考

REGISTRATION_OPEN、認証

REGISTRATION_CAPTCHA

A value of either True or False indicating whether registration of new accounts is protected by CAPTCHA. This setting is optional, and a default of True will be assumed if it is not supplied.

If turned on, a CAPTCHA is added to all pages where a users enters their e-mail address:

• New account registration.

• Password recovery.

• Adding e-mail to an account.

• Contact form for users that are not signed in.

REGISTRATION_EMAIL_MATCH

バージョン 2.17 で追加.

Allows you to filter which e-mail addresses can register.

Defaults to .*, which allows any e-mail address to be registered.

You can use it to restrict registration to a single e-mail domain:

REGISTRATION_EMAIL_MATCH = r"^.*@weblate\.org$"

REGISTRATION_OPEN

Whether registration of new accounts is currently permitted. This optional setting can remain the default True, or changed to False.

This setting affects built-in authentication by e-mail address or through the Python Social Auth (you can whitelist certain back-ends using REGISTRATION_ALLOW_BACKENDS).

注釈

If using third-party authentication methods such as LDAP authentication, it just hides the registration form, but new users might still be able to sign in and create accounts.

参考

REGISTRATION_ALLOW_BACKENDS、REGISTRATION_EMAIL_MATCH、認証

REPOSITORY_ALERT_THRESHOLD

バージョン 4.0.2 で追加.

Threshold for triggering an alert for outdated repositories, or ones that contain too many changes. Defaults to 25.

参考

Translation component alerts

REQUIRE_LOGIN

バージョン 4.1 で追加.

This enables LOGIN_REQUIRED_URLS and configures REST framework to require sign in for all API endpoints.

注釈

This is implemented in the サンプル設定. For Docker, use WEBLATE_REQUIRE_LOGIN.

SENTRY_DSN

バージョン 3.9 で追加.

Sentry DSN to use for Collecting error reports.

参考

Django integration for Sentry

SESSION_COOKIE_AGE_AUTHENTICATED

バージョン 4.3 で追加.

Set session expiry for authenticated users. This complements SESSION_COOKIE_AGE which is used for unauthenticated users.

参考

SESSION_COOKIE_AGE

SIMPLIFY_LANGUAGES

Use simple language codes for default language/country combinations. For example an fr_FR translation will use the fr language code. This is usually the desired behavior, as it simplifies listing languages for these default combinations.

Turn this off if you want to different translations for each variant.

SITE_DOMAIN

Configures site domain. This is necessary to produce correct absolute links in many scopes (for example activation e-mails, notifications or RSS feeds).

In case Weblate is running on non-standard port, include it here as well.

例:

# Production site with domain name
SITE_DOMAIN = "weblate.example.com"

# Local development with IP address and port
SITE_DOMAIN = "127.0.0.1:8000"

注釈

This setting should only contain the domain name. For configuring protocol, (enabling and enforcing HTTPS) use ENABLE_HTTPS and for changing URL, use URL_PREFIX.

ヒント

On a Docker container, the site domain is configured through WEBLATE_ALLOWED_HOSTS.

参考

Set correct site domain、Allowed hosts setup、Correctly configure HTTPS WEBLATE_SITE_DOMAIN、ENABLE_HTTPS

SITE_TITLE

Site title to be used for the website and sent e-mails.

SPECIAL_CHARS

Additional characters to include in the visual keyboard, ビジュアル キーボード.

The default value is:

SPECIAL_CHARS = ("\t", "\n", "…")

SINGLE_PROJECT

バージョン 3.8 で追加.

Redirects users directly to a project or component instead of showing the dashboard. You can either set it to True and in this case it only works in case there is actually only single project in Weblate. Alternatively set the project slug, and it will redirect unconditionally to this project.

バージョン 3.11 で変更: The setting now also accepts a project slug, to force displaying that single project.

例:

SINGLE_PROJECT = "test"

STATUS_URL

The URL where your Weblate instance reports its status.

SUGGESTION_CLEANUP_DAYS

バージョン 3.2.1 で追加.

Automatically deletes suggestions after a given number of days. Defaults to None, meaning no deletions.

UPDATE_LANGUAGES

バージョン 4.3.2 で追加.

Controls whether languages database should be updated when running database migration and is enabled by default. This setting has no effect on invocation of setuplang.

参考

内蔵の言語設定

URL_PREFIX

This setting allows you to run Weblate under some path (otherwise it relies on being run from the webserver root).

注釈

To use this setting, you also need to configure your server to strip this prefix. For example with WSGI, this can be achieved by setting WSGIScriptAlias.

ヒント

The prefix should start with a /.

例:

URL_PREFIX = "/translations"

注釈

This setting does not work with Django's built-in server, you would have to adjust urls.py to contain this prefix.

VCS_BACKENDS

Configuration of available VCS backends.

注釈

Weblate tries to use all supported back-ends you have the tools for.

ヒント

You can limit choices or add custom VCS back-ends by using this.

VCS_BACKENDS = ("weblate.vcs.git.GitRepository",)

参考

バージョン管理の統合

VCS_CLONE_DEPTH

バージョン 3.10.2 で追加.

Configures how deep cloning of repositories Weblate should do.

注釈

Currently this is only supported in Git. By default Weblate does shallow clones of the repositories to make cloning faster and save disk space. Depending on your usage (for example when using custom アドオン), you might want to increase the depth or turn off shallow clones completely by setting this to 0.

ヒント

In case you get fatal: protocol error: expected old/new/ref, got 'shallow <commit hash>' error when pushing from Weblate, turn off shallow clones completely by setting:

VCS_CLONE_DEPTH = 0

WEBLATE_ADDONS

List of addons available for use. To use them, they have to be enabled for a given translation component. By default this includes all built-in addons, when extending the list you will probably want to keep existing ones enabled, for example:

WEBLATE_ADDONS = (
    # Built-in addons
    "weblate.addons.gettext.GenerateMoAddon",
    "weblate.addons.gettext.UpdateLinguasAddon",
    "weblate.addons.gettext.UpdateConfigureAddon",
    "weblate.addons.gettext.MsgmergeAddon",
    "weblate.addons.gettext.GettextCustomizeAddon",
    "weblate.addons.gettext.GettextAuthorComments",
    "weblate.addons.cleanup.CleanupAddon",
    "weblate.addons.consistency.LangaugeConsistencyAddon",
    "weblate.addons.discovery.DiscoveryAddon",
    "weblate.addons.flags.SourceEditAddon",
    "weblate.addons.flags.TargetEditAddon",
    "weblate.addons.flags.SameEditAddon",
    "weblate.addons.flags.BulkEditAddon",
    "weblate.addons.generate.GenerateFileAddon",
    "weblate.addons.json.JSONCustomizeAddon",
    "weblate.addons.properties.PropertiesSortAddon",
    "weblate.addons.git.GitSquashAddon",
    "weblate.addons.removal.RemoveComments",
    "weblate.addons.removal.RemoveSuggestions",
    "weblate.addons.resx.ResxUpdateAddon",
    "weblate.addons.autotranslate.AutoTranslateAddon",
    "weblate.addons.yaml.YAMLCustomizeAddon",
    "weblate.addons.cdn.CDNJSAddon",
    # Addon you want to include
    "weblate.addons.example.ExampleAddon",
)

注釈

Removing the addon from the list does not uninstall it from the components. Weblate will crash in that case. Please uninstall addon from all components prior to removing it from this list.

参考

アドオン、DEFAULT_ADDONS

WEBLATE_EXPORTERS

バージョン 4.2 で追加.

List of a available exporters offering downloading translations or glossaries in various file formats.

参考

Supported file formats

WEBLATE_FORMATS

バージョン 3.0 で追加.

List of file formats available for use.

注釈

The default list already has the common formats.

参考

Supported file formats

WEBLATE_GPG_IDENTITY

バージョン 3.1 で追加.

Identity used by Weblate to sign Git commits, for example:

WEBLATE_GPG_IDENTITY = "Weblate <weblate@example.com>"

The Weblate GPG keyring is searched for a matching key (home/.gnupg under DATA_DIR). If not found, a key is generated, please check Signing Git commits with GnuPG for more details.

参考

Signing Git commits with GnuPG

サンプル設定

Weblate は設定例として weblate/settings_example.py が同梱されています:

#
# Copyright © 2012 - 2020 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <https://weblate.org/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#


import os
import platform
from logging.handlers import SysLogHandler

#
# Django settings for Weblate project.
#

DEBUG = True

ADMINS = (
    # ("Your Name", "your_email@example.com"),
)

MANAGERS = ADMINS

DATABASES = {
    "default": {
        # Use "postgresql" or "mysql".
        "ENGINE": "django.db.backends.postgresql",
        # Database name.
        "NAME": "weblate",
        # Database user.
        "USER": "weblate",
        # Name of role to alter to set parameters in PostgreSQL,
        # use in case role name is different than user used for authentication.
        # "ALTER_ROLE": "weblate",
        # Database password.
        "PASSWORD": "",
        # Set to empty string for localhost.
        "HOST": "127.0.0.1",
        # Set to empty string for default.
        "PORT": "",
        # Customizations for databases.
        "OPTIONS": {
            # In case of using an older MySQL server,
            # which has MyISAM as a default storage
            # "init_command": "SET storage_engine=INNODB",
            # Uncomment for MySQL older than 5.7:
            # "init_command": "SET sql_mode='STRICT_TRANS_TABLES'",
            # Set emoji capable charset for MySQL:
            # "charset": "utf8mb4",
            # Change connection timeout in case you get MySQL gone away error:
            # "connect_timeout": 28800,
        },
    }
}

BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

# Data directory
DATA_DIR = os.path.join(BASE_DIR, "data")

# Local time zone for this installation. Choices can be found here:
# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
# although not all choices may be available on all operating systems.
# In a Windows environment this must be set to your system time zone.
TIME_ZONE = "UTC"

# Language code for this installation. All choices can be found here:
# http://www.i18nguy.com/unicode/language-identifiers.html
LANGUAGE_CODE = "en-us"

LANGUAGES = (
    ("ar", "العربية"),
    ("az", "Azərbaycan"),
    ("be", "Беларуская"),
    ("be@latin", "Biełaruskaja"),
    ("bg", "Български"),
    ("br", "Brezhoneg"),
    ("ca", "Català"),
    ("cs", "Čeština"),
    ("da", "Dansk"),
    ("de", "Deutsch"),
    ("en", "English"),
    ("el", "Ελληνικά"),
    ("en-gb", "English (United Kingdom)"),
    ("es", "Español"),
    ("fi", "Suomi"),
    ("fr", "Français"),
    ("gl", "Galego"),
    ("he", "עברית"),
    ("hu", "Magyar"),
    ("hr", "Hrvatski"),
    ("id", "Indonesia"),
    ("is", "Íslenska"),
    ("it", "Italiano"),
    ("ja", "日本語"),
    ("kab", "Taqbaylit"),
    ("kk", "Қазақ тілі"),
    ("ko", "한국어"),
    ("nb", "Norsk bokmål"),
    ("nl", "Nederlands"),
    ("pl", "Polski"),
    ("pt", "Português"),
    ("pt-br", "Português brasileiro"),
    ("ru", "Русский"),
    ("sk", "Slovenčina"),
    ("sl", "Slovenščina"),
    ("sq", "Shqip"),
    ("sr", "Српски"),
    ("sv", "Svenska"),
    ("tr", "Türkçe"),
    ("uk", "Українська"),
    ("zh-hans", "简体字"),
    ("zh-hant", "正體字"),
)

SITE_ID = 1

# If you set this to False, Django will make some optimizations so as not
# to load the internationalization machinery.
USE_I18N = True

# If you set this to False, Django will not format dates, numbers and
# calendars according to the current locale.
USE_L10N = True

# If you set this to False, Django will not use timezone-aware datetimes.
USE_TZ = True

# URL prefix to use, please see documentation for more details
URL_PREFIX = ""

# Absolute filesystem path to the directory that will hold user-uploaded files.
MEDIA_ROOT = os.path.join(DATA_DIR, "media")

# URL that handles the media served from MEDIA_ROOT. Make sure to use a
# trailing slash.
MEDIA_URL = f"{URL_PREFIX}/media/"

# Absolute path to the directory static files should be collected to.
# Don't put anything in this directory yourself; store your static files
# in apps' "static/" subdirectories and in STATICFILES_DIRS.
STATIC_ROOT = os.path.join(DATA_DIR, "static")

# URL prefix for static files.
STATIC_URL = f"{URL_PREFIX}/static/"

# Additional locations of static files
STATICFILES_DIRS = (
    # Put strings here, like "/home/html/static" or "C:/www/django/static".
    # Always use forward slashes, even on Windows.
    # Don't forget to use absolute paths, not relative paths.
)

# List of finder classes that know how to find static files in
# various locations.
STATICFILES_FINDERS = (
    "django.contrib.staticfiles.finders.FileSystemFinder",
    "django.contrib.staticfiles.finders.AppDirectoriesFinder",
    "compressor.finders.CompressorFinder",
)

# Make this unique, and don't share it with anybody.
# You can generate it using weblate/examples/generate-secret-key
SECRET_KEY = ""

_TEMPLATE_LOADERS = [
    "django.template.loaders.filesystem.Loader",
    "django.template.loaders.app_directories.Loader",
]
if not DEBUG:
    _TEMPLATE_LOADERS = [("django.template.loaders.cached.Loader", _TEMPLATE_LOADERS)]
TEMPLATES = [
    {
        "BACKEND": "django.template.backends.django.DjangoTemplates",
        "OPTIONS": {
            "context_processors": [
                "django.contrib.auth.context_processors.auth",
                "django.template.context_processors.debug",
                "django.template.context_processors.i18n",
                "django.template.context_processors.request",
                "django.template.context_processors.csrf",
                "django.contrib.messages.context_processors.messages",
                "weblate.trans.context_processors.weblate_context",
            ],
            "loaders": _TEMPLATE_LOADERS,
        },
    }
]


# GitHub username for sending pull requests.
# Please see the documentation for more details.
GITHUB_USERNAME = None
GITHUB_TOKEN = None

# GitLab username for sending merge requests.
# Please see the documentation for more details.
GITLAB_USERNAME = None
GITLAB_TOKEN = None

# Authentication configuration
AUTHENTICATION_BACKENDS = (
    "social_core.backends.email.EmailAuth",
    # "social_core.backends.google.GoogleOAuth2",
    # "social_core.backends.github.GithubOAuth2",
    # "social_core.backends.bitbucket.BitbucketOAuth",
    # "social_core.backends.suse.OpenSUSEOpenId",
    # "social_core.backends.ubuntu.UbuntuOpenId",
    # "social_core.backends.fedora.FedoraOpenId",
    # "social_core.backends.facebook.FacebookOAuth2",
    "weblate.accounts.auth.WeblateUserBackend",
)

# Custom user model
AUTH_USER_MODEL = "weblate_auth.User"

# Social auth backends setup
SOCIAL_AUTH_GITHUB_KEY = ""
SOCIAL_AUTH_GITHUB_SECRET = ""
SOCIAL_AUTH_GITHUB_SCOPE = ["user:email"]

SOCIAL_AUTH_BITBUCKET_KEY = ""
SOCIAL_AUTH_BITBUCKET_SECRET = ""
SOCIAL_AUTH_BITBUCKET_VERIFIED_EMAILS_ONLY = True

SOCIAL_AUTH_FACEBOOK_KEY = ""
SOCIAL_AUTH_FACEBOOK_SECRET = ""
SOCIAL_AUTH_FACEBOOK_SCOPE = ["email", "public_profile"]
SOCIAL_AUTH_FACEBOOK_PROFILE_EXTRA_PARAMS = {"fields": "id,name,email"}

SOCIAL_AUTH_GOOGLE_OAUTH2_KEY = ""
SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET = ""

# Social auth settings
SOCIAL_AUTH_PIPELINE = (
    "social_core.pipeline.social_auth.social_details",
    "social_core.pipeline.social_auth.social_uid",
    "social_core.pipeline.social_auth.auth_allowed",
    "social_core.pipeline.social_auth.social_user",
    "weblate.accounts.pipeline.store_params",
    "weblate.accounts.pipeline.verify_open",
    "social_core.pipeline.user.get_username",
    "weblate.accounts.pipeline.require_email",
    "social_core.pipeline.mail.mail_validation",
    "weblate.accounts.pipeline.revoke_mail_code",
    "weblate.accounts.pipeline.ensure_valid",
    "weblate.accounts.pipeline.remove_account",
    "social_core.pipeline.social_auth.associate_by_email",
    "weblate.accounts.pipeline.reauthenticate",
    "weblate.accounts.pipeline.verify_username",
    "social_core.pipeline.user.create_user",
    "social_core.pipeline.social_auth.associate_user",
    "social_core.pipeline.social_auth.load_extra_data",
    "weblate.accounts.pipeline.cleanup_next",
    "weblate.accounts.pipeline.user_full_name",
    "weblate.accounts.pipeline.store_email",
    "weblate.accounts.pipeline.notify_connect",
    "weblate.accounts.pipeline.password_reset",
)
SOCIAL_AUTH_DISCONNECT_PIPELINE = (
    "social_core.pipeline.disconnect.allowed_to_disconnect",
    "social_core.pipeline.disconnect.get_entries",
    "social_core.pipeline.disconnect.revoke_tokens",
    "weblate.accounts.pipeline.cycle_session",
    "weblate.accounts.pipeline.adjust_primary_mail",
    "weblate.accounts.pipeline.notify_disconnect",
    "social_core.pipeline.disconnect.disconnect",
    "weblate.accounts.pipeline.cleanup_next",
)

# Custom authentication strategy
SOCIAL_AUTH_STRATEGY = "weblate.accounts.strategy.WeblateStrategy"

# Raise exceptions so that we can handle them later
SOCIAL_AUTH_RAISE_EXCEPTIONS = True

SOCIAL_AUTH_EMAIL_VALIDATION_FUNCTION = "weblate.accounts.pipeline.send_validation"
SOCIAL_AUTH_EMAIL_VALIDATION_URL = f"{URL_PREFIX}/accounts/email-sent/"
SOCIAL_AUTH_LOGIN_ERROR_URL = f"{URL_PREFIX}/accounts/login/"
SOCIAL_AUTH_EMAIL_FORM_URL = f"{URL_PREFIX}/accounts/email/"
SOCIAL_AUTH_NEW_ASSOCIATION_REDIRECT_URL = f"{URL_PREFIX}/accounts/profile/#account"
SOCIAL_AUTH_PROTECTED_USER_FIELDS = ("email",)
SOCIAL_AUTH_SLUGIFY_USERNAMES = True
SOCIAL_AUTH_SLUGIFY_FUNCTION = "weblate.accounts.pipeline.slugify_username"

# Password validation configuration
AUTH_PASSWORD_VALIDATORS = [
    {
        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"  # noqa: E501, pylint: disable=line-too-long
    },
    {
        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
        "OPTIONS": {"min_length": 10},
    },
    {"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator"},
    {"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator"},
    {"NAME": "weblate.accounts.password_validation.CharsPasswordValidator"},
    {"NAME": "weblate.accounts.password_validation.PastPasswordsValidator"},
    # Optional password strength validation by django-zxcvbn-password
    # {
    #     "NAME": "zxcvbn_password.ZXCVBNValidator",
    #     "OPTIONS": {
    #         "min_score": 3,
    #         "user_attributes": ("username", "email", "full_name")
    #     }
    # },
]

# Allow new user registrations
REGISTRATION_OPEN = True

# Shortcut for login required setting
REQUIRE_LOGIN = False

# Middleware
MIDDLEWARE = [
    "weblate.middleware.RedirectMiddleware",
    "weblate.middleware.ProxyMiddleware",
    "django.middleware.security.SecurityMiddleware",
    "django.contrib.sessions.middleware.SessionMiddleware",
    "django.middleware.csrf.CsrfViewMiddleware",
    "weblate.accounts.middleware.AuthenticationMiddleware",
    "django.contrib.messages.middleware.MessageMiddleware",
    "django.middleware.clickjacking.XFrameOptionsMiddleware",
    "social_django.middleware.SocialAuthExceptionMiddleware",
    "weblate.accounts.middleware.RequireLoginMiddleware",
    "weblate.api.middleware.ThrottlingMiddleware",
    "weblate.middleware.SecurityMiddleware",
]

ROOT_URLCONF = "weblate.urls"

# Django and Weblate apps
INSTALLED_APPS = [
    # Weblate apps on top to override Django locales and templates
    "weblate.addons",
    "weblate.auth",
    "weblate.checks",
    "weblate.formats",
    "weblate.glossary",
    "weblate.machinery",
    "weblate.trans",
    "weblate.lang",
    "weblate_language_data",
    "weblate.memory",
    "weblate.screenshots",
    "weblate.fonts",
    "weblate.accounts",
    "weblate.configuration",
    "weblate.utils",
    "weblate.vcs",
    "weblate.wladmin",
    "weblate",
    # Optional: Git exporter
    "weblate.gitexport",
    # Standard Django modules
    "django.contrib.auth",
    "django.contrib.contenttypes",
    "django.contrib.sessions",
    "django.contrib.messages",
    "django.contrib.staticfiles",
    "django.contrib.admin.apps.SimpleAdminConfig",
    "django.contrib.admindocs",
    "django.contrib.sitemaps",
    "django.contrib.humanize",
    # Third party Django modules
    "social_django",
    "crispy_forms",
    "compressor",
    "rest_framework",
    "rest_framework.authtoken",
    "django_filters",
]

# Custom exception reporter to include some details
DEFAULT_EXCEPTION_REPORTER_FILTER = "weblate.trans.debug.WeblateExceptionReporterFilter"

# Default logging of Weblate messages
# - to syslog in production (if available)
# - otherwise to console
# - you can also choose "logfile" to log into separate file
#   after configuring it below

# Detect if we can connect to syslog
HAVE_SYSLOG = False
if platform.system() != "Windows":
    try:
        handler = SysLogHandler(address="/dev/log", facility=SysLogHandler.LOG_LOCAL2)
        handler.close()
        HAVE_SYSLOG = True
    except OSError:
        HAVE_SYSLOG = False

if DEBUG or not HAVE_SYSLOG:
    DEFAULT_LOG = "console"
else:
    DEFAULT_LOG = "syslog"
DEFAULT_LOGLEVEL = "DEBUG" if DEBUG else "INFO"

# A sample logging configuration. The only tangible logging
# performed by this configuration is to send an email to
# the site admins on every HTTP 500 error when DEBUG=False.
# See http://docs.djangoproject.com/en/stable/topics/logging for
# more details on how to customize your logging configuration.
LOGGING = {
    "version": 1,
    "disable_existing_loggers": True,
    "filters": {"require_debug_false": {"()": "django.utils.log.RequireDebugFalse"}},
    "formatters": {
        "syslog": {"format": "weblate[%(process)d]: %(levelname)s %(message)s"},
        "simple": {"format": "[%(asctime)s: %(levelname)s/%(process)s] %(message)s"},
        "logfile": {"format": "%(asctime)s %(levelname)s %(message)s"},
        "django.server": {
            "()": "django.utils.log.ServerFormatter",
            "format": "[%(server_time)s] %(message)s",
        },
    },
    "handlers": {
        "mail_admins": {
            "level": "ERROR",
            "filters": ["require_debug_false"],
            "class": "django.utils.log.AdminEmailHandler",
            "include_html": True,
        },
        "console": {
            "level": "DEBUG",
            "class": "logging.StreamHandler",
            "formatter": "simple",
        },
        "django.server": {
            "level": "INFO",
            "class": "logging.StreamHandler",
            "formatter": "django.server",
        },
        "syslog": {
            "level": "DEBUG",
            "class": "logging.handlers.SysLogHandler",
            "formatter": "syslog",
            "address": "/dev/log",
            "facility": SysLogHandler.LOG_LOCAL2,
        },
        # Logging to a file
        # "logfile": {
        #     "level":"DEBUG",
        #     "class":"logging.handlers.RotatingFileHandler",
        #     "filename": "/var/log/weblate/weblate.log",
        #     "maxBytes": 100000,
        #     "backupCount": 3,
        #     "formatter": "logfile",
        # },
    },
    "loggers": {
        "django.request": {
            "handlers": ["mail_admins", DEFAULT_LOG],
            "level": "ERROR",
            "propagate": True,
        },
        "django.server": {
            "handlers": ["django.server"],
            "level": "INFO",
            "propagate": False,
        },
        # Logging database queries
        # "django.db.backends": {
        #     "handlers": [DEFAULT_LOG],
        #     "level": "DEBUG",
        # },
        "weblate": {"handlers": [DEFAULT_LOG], "level": DEFAULT_LOGLEVEL},
        # Logging VCS operations
        "weblate.vcs": {"handlers": [DEFAULT_LOG], "level": DEFAULT_LOGLEVEL},
        # Python Social Auth
        "social": {"handlers": [DEFAULT_LOG], "level": DEFAULT_LOGLEVEL},
        # Django Authentication Using LDAP
        "django_auth_ldap": {"handlers": [DEFAULT_LOG], "level": DEFAULT_LOGLEVEL},
        # SAML IdP
        "djangosaml2idp": {"handlers": [DEFAULT_LOG], "level": DEFAULT_LOGLEVEL},
    },
}

# Remove syslog setup if it's not present
if not HAVE_SYSLOG:
    del LOGGING["handlers"]["syslog"]

# List of machine translations
MT_SERVICES = (
    #     "weblate.machinery.apertium.ApertiumAPYTranslation",
    #     "weblate.machinery.baidu.BaiduTranslation",
    #     "weblate.machinery.deepl.DeepLTranslation",
    #     "weblate.machinery.glosbe.GlosbeTranslation",
    #     "weblate.machinery.google.GoogleTranslation",
    #     "weblate.machinery.googlev3.GoogleV3Translation",
    #     "weblate.machinery.microsoft.MicrosoftCognitiveTranslation",
    #     "weblate.machinery.microsoftterminology.MicrosoftTerminologyService",
    #     "weblate.machinery.modernmt.ModernMTTranslation",
    #     "weblate.machinery.mymemory.MyMemoryTranslation",
    #     "weblate.machinery.netease.NeteaseSightTranslation",
    #     "weblate.machinery.tmserver.AmagamaTranslation",
    #     "weblate.machinery.tmserver.TMServerTranslation",
    #     "weblate.machinery.yandex.YandexTranslation",
    #     "weblate.machinery.saptranslationhub.SAPTranslationHub",
    #     "weblate.machinery.youdao.YoudaoTranslation",
    "weblate.machinery.weblatetm.WeblateTranslation",
    "weblate.memory.machine.WeblateMemory",
)

# Machine translation API keys

# URL of the Apertium APy server
MT_APERTIUM_APY = None

# DeepL API key
MT_DEEPL_KEY = None

# Microsoft Cognitive Services Translator API, register at
# https://portal.azure.com/
MT_MICROSOFT_COGNITIVE_KEY = None
MT_MICROSOFT_REGION = None

# ModernMT
MT_MODERNMT_KEY = None

# MyMemory identification email, see
# https://mymemory.translated.net/doc/spec.php
MT_MYMEMORY_EMAIL = None

# Optional MyMemory credentials to access private translation memory
MT_MYMEMORY_USER = None
MT_MYMEMORY_KEY = None

# Google API key for Google Translate API v2
MT_GOOGLE_KEY = None

# Google Translate API3 credentials and project id
MT_GOOGLE_CREDENTIALS = None
MT_GOOGLE_PROJECT = None

# Baidu app key and secret
MT_BAIDU_ID = None
MT_BAIDU_SECRET = None

# Youdao Zhiyun app key and secret
MT_YOUDAO_ID = None
MT_YOUDAO_SECRET = None

# Netease Sight (Jianwai) app key and secret
MT_NETEASE_KEY = None
MT_NETEASE_SECRET = None

# API key for Yandex Translate API
MT_YANDEX_KEY = None

# tmserver URL
MT_TMSERVER = None

# SAP Translation Hub
MT_SAP_BASE_URL = None
MT_SAP_SANDBOX_APIKEY = None
MT_SAP_USERNAME = None
MT_SAP_PASSWORD = None
MT_SAP_USE_MT = True

# Title of site to use
SITE_TITLE = "Weblate"

# Site domain
SITE_DOMAIN = ""

# Whether site uses https
ENABLE_HTTPS = False

# Use HTTPS when creating redirect URLs for social authentication, see
# documentation for more details:
# https://python-social-auth-docs.readthedocs.io/en/latest/configuration/settings.html#processing-redirects-and-urlopen
SOCIAL_AUTH_REDIRECT_IS_HTTPS = ENABLE_HTTPS

# Make CSRF cookie HttpOnly, see documentation for more details:
# https://docs.djangoproject.com/en/1.11/ref/settings/#csrf-cookie-httponly
CSRF_COOKIE_HTTPONLY = True
CSRF_COOKIE_SECURE = ENABLE_HTTPS
# Store CSRF token in session
CSRF_USE_SESSIONS = True
# Customize CSRF failure view
CSRF_FAILURE_VIEW = "weblate.trans.views.error.csrf_failure"
SESSION_COOKIE_SECURE = ENABLE_HTTPS
SESSION_COOKIE_HTTPONLY = True
# SSL redirect
SECURE_SSL_REDIRECT = ENABLE_HTTPS
# Sent referrrer only for same origin links
SECURE_REFERRER_POLICY = "same-origin"
# SSL redirect URL exemption list
SECURE_REDIRECT_EXEMPT = (r"healthz/$",)  # Allowing HTTP access to health check
# Session cookie age (in seconds)
SESSION_COOKIE_AGE = 1000
SESSION_COOKIE_AGE_AUTHENTICATED = 1209600
# Increase allowed upload size
DATA_UPLOAD_MAX_MEMORY_SIZE = 50000000

# Apply session coookie settings to language cookie as ewll
LANGUAGE_COOKIE_SECURE = SESSION_COOKIE_SECURE
LANGUAGE_COOKIE_HTTPONLY = SESSION_COOKIE_HTTPONLY
LANGUAGE_COOKIE_AGE = SESSION_COOKIE_AGE_AUTHENTICATED * 10

# Some security headers
SECURE_BROWSER_XSS_FILTER = True
X_FRAME_OPTIONS = "DENY"
SECURE_CONTENT_TYPE_NOSNIFF = True

# Optionally enable HSTS
SECURE_HSTS_SECONDS = 31536000 if ENABLE_HTTPS else 0
SECURE_HSTS_PRELOAD = ENABLE_HTTPS
SECURE_HSTS_INCLUDE_SUBDOMAINS = ENABLE_HTTPS

# HTTPS detection behind reverse proxy
SECURE_PROXY_SSL_HEADER = None

# URL of login
LOGIN_URL = f"{URL_PREFIX}/accounts/login/"

# URL of logout
LOGOUT_URL = f"{URL_PREFIX}/accounts/logout/"

# Default location for login
LOGIN_REDIRECT_URL = f"{URL_PREFIX}/"

# Anonymous user name
ANONYMOUS_USER_NAME = "anonymous"

# Reverse proxy settings
IP_PROXY_HEADER = "HTTP_X_FORWARDED_FOR"
IP_BEHIND_REVERSE_PROXY = False
IP_PROXY_OFFSET = 0

# Sending HTML in mails
EMAIL_SEND_HTML = True

# Subject of emails includes site title
EMAIL_SUBJECT_PREFIX = f"[{SITE_TITLE}] "

# Enable remote hooks
ENABLE_HOOKS = True

# By default the length of a given translation is limited to the length of
# the source string * 10 characters. Set this option to False to allow longer
# translations (up to 10.000 characters)
LIMIT_TRANSLATION_LENGTH_BY_SOURCE_LENGTH = True

# Use simple language codes for default language/country combinations
SIMPLIFY_LANGUAGES = True

# Render forms using bootstrap
CRISPY_TEMPLATE_PACK = "bootstrap3"

# List of quality checks
# CHECK_LIST = (
#     "weblate.checks.same.SameCheck",
#     "weblate.checks.chars.BeginNewlineCheck",
#     "weblate.checks.chars.EndNewlineCheck",
#     "weblate.checks.chars.BeginSpaceCheck",
#     "weblate.checks.chars.EndSpaceCheck",
#     "weblate.checks.chars.DoubleSpaceCheck",
#     "weblate.checks.chars.EndStopCheck",
#     "weblate.checks.chars.EndColonCheck",
#     "weblate.checks.chars.EndQuestionCheck",
#     "weblate.checks.chars.EndExclamationCheck",
#     "weblate.checks.chars.EndEllipsisCheck",
#     "weblate.checks.chars.EndSemicolonCheck",
#     "weblate.checks.chars.MaxLengthCheck",
#     "weblate.checks.chars.KashidaCheck",
#     "weblate.checks.chars.PunctuationSpacingCheck",
#     "weblate.checks.format.PythonFormatCheck",
#     "weblate.checks.format.PythonBraceFormatCheck",
#     "weblate.checks.format.PHPFormatCheck",
#     "weblate.checks.format.CFormatCheck",
#     "weblate.checks.format.PerlFormatCheck",
#     "weblate.checks.format.JavaScriptFormatCheck",
#     "weblate.checks.format.CSharpFormatCheck",
#     "weblate.checks.format.JavaFormatCheck",
#     "weblate.checks.format.JavaMessageFormatCheck",
#     "weblate.checks.format.PercentPlaceholdersCheck",
#     "weblate.checks.format.VueFormattingCheck",
#     "weblate.checks.format.I18NextInterpolationCheck",
#     "weblate.checks.format.ESTemplateLiteralsCheck",
#     "weblate.checks.angularjs.AngularJSInterpolationCheck",
#     "weblate.checks.qt.QtFormatCheck",
#     "weblate.checks.qt.QtPluralCheck",
#     "weblate.checks.ruby.RubyFormatCheck",
#     "weblate.checks.consistency.PluralsCheck",
#     "weblate.checks.consistency.SamePluralsCheck",
#     "weblate.checks.consistency.ConsistencyCheck",
#     "weblate.checks.consistency.TranslatedCheck",
#     "weblate.checks.chars.EscapedNewlineCountingCheck",
#     "weblate.checks.chars.NewLineCountCheck",
#     "weblate.checks.markup.BBCodeCheck",
#     "weblate.checks.chars.ZeroWidthSpaceCheck",
#     "weblate.checks.render.MaxSizeCheck",
#     "weblate.checks.markup.XMLValidityCheck",
#     "weblate.checks.markup.XMLTagsCheck",
#     "weblate.checks.markup.MarkdownRefLinkCheck",
#     "weblate.checks.markup.MarkdownLinkCheck",
#     "weblate.checks.markup.MarkdownSyntaxCheck",
#     "weblate.checks.markup.URLCheck",
#     "weblate.checks.markup.SafeHTMLCheck",
#     "weblate.checks.placeholders.PlaceholderCheck",
#     "weblate.checks.placeholders.RegexCheck",
#     "weblate.checks.duplicate.DuplicateCheck",
#     "weblate.checks.source.OptionalPluralCheck",
#     "weblate.checks.source.EllipsisCheck",
#     "weblate.checks.source.MultipleFailingCheck",
#     "weblate.checks.source.LongUntranslatedCheck",
#     "weblate.checks.format.MultipleUnnamedFormatsCheck",
# )

# List of automatic fixups
# AUTOFIX_LIST = (
#     "weblate.trans.autofixes.whitespace.SameBookendingWhitespace",
#     "weblate.trans.autofixes.chars.ReplaceTrailingDotsWithEllipsis",
#     "weblate.trans.autofixes.chars.RemoveZeroSpace",
#     "weblate.trans.autofixes.chars.RemoveControlChars",
# )

# List of enabled addons
# WEBLATE_ADDONS = (
#     "weblate.addons.gettext.GenerateMoAddon",
#     "weblate.addons.gettext.UpdateLinguasAddon",
#     "weblate.addons.gettext.UpdateConfigureAddon",
#     "weblate.addons.gettext.MsgmergeAddon",
#     "weblate.addons.gettext.GettextCustomizeAddon",
#     "weblate.addons.gettext.GettextAuthorComments",
#     "weblate.addons.cleanup.CleanupAddon",
#     "weblate.addons.consistency.LangaugeConsistencyAddon",
#     "weblate.addons.discovery.DiscoveryAddon",
#     "weblate.addons.flags.SourceEditAddon",
#     "weblate.addons.flags.TargetEditAddon",
#     "weblate.addons.flags.SameEditAddon",
#     "weblate.addons.flags.BulkEditAddon",
#     "weblate.addons.generate.GenerateFileAddon",
#     "weblate.addons.json.JSONCustomizeAddon",
#     "weblate.addons.properties.PropertiesSortAddon",
#     "weblate.addons.git.GitSquashAddon",
#     "weblate.addons.removal.RemoveComments",
#     "weblate.addons.removal.RemoveSuggestions",
#     "weblate.addons.resx.ResxUpdateAddon",
#     "weblate.addons.yaml.YAMLCustomizeAddon",
#     "weblate.addons.cdn.CDNJSAddon",
#     "weblate.addons.autotranslate.AutoTranslateAddon",
# )

# E-mail address that error messages come from.
SERVER_EMAIL = "noreply@example.com"

# Default email address to use for various automated correspondence from
# the site managers. Used for registration emails.
DEFAULT_FROM_EMAIL = "noreply@example.com"

# List of URLs your site is supposed to serve
ALLOWED_HOSTS = ["*"]

# Configuration for caching
CACHES = {
    "default": {
        "BACKEND": "django_redis.cache.RedisCache",
        "LOCATION": "redis://127.0.0.1:6379/1",
        # If redis is running on same host as Weblate, you might
        # want to use unix sockets instead:
        # "LOCATION": "unix:///var/run/redis/redis.sock?db=1",
        "OPTIONS": {
            "CLIENT_CLASS": "django_redis.client.DefaultClient",
            "PARSER_CLASS": "redis.connection.HiredisParser",
            "PASSWORD": None,
            "CONNECTION_POOL_KWARGS": {},
        },
        "KEY_PREFIX": "weblate",
    },
    "avatar": {
        "BACKEND": "django.core.cache.backends.filebased.FileBasedCache",
        "LOCATION": os.path.join(DATA_DIR, "avatar-cache"),
        "TIMEOUT": 86400,
        "OPTIONS": {"MAX_ENTRIES": 1000},
    },
}

# Store sessions in cache
SESSION_ENGINE = "django.contrib.sessions.backends.cache"
# Store messages in session
MESSAGE_STORAGE = "django.contrib.messages.storage.session.SessionStorage"

# REST framework settings for API
REST_FRAMEWORK = {
    # Use Django's standard `django.contrib.auth` permissions,
    # or allow read-only access for unauthenticated users.
    "DEFAULT_PERMISSION_CLASSES": [
        # Require authentication for login required sites
        "rest_framework.permissions.IsAuthenticated"
        if REQUIRE_LOGIN
        else "rest_framework.permissions.IsAuthenticatedOrReadOnly"
    ],
    "DEFAULT_AUTHENTICATION_CLASSES": (
        "rest_framework.authentication.TokenAuthentication",
        "weblate.api.authentication.BearerAuthentication",
        "rest_framework.authentication.SessionAuthentication",
    ),
    "DEFAULT_THROTTLE_CLASSES": (
        "weblate.api.throttling.UserRateThrottle",
        "weblate.api.throttling.AnonRateThrottle",
    ),
    "DEFAULT_THROTTLE_RATES": {"anon": "100/day", "user": "5000/hour"},
    "DEFAULT_PAGINATION_CLASS": ("rest_framework.pagination.PageNumberPagination"),
    "PAGE_SIZE": 20,
    "VIEW_DESCRIPTION_FUNCTION": "weblate.api.views.get_view_description",
    "UNAUTHENTICATED_USER": "weblate.auth.models.get_anonymous",
}

# Fonts CDN URL
FONTS_CDN_URL = None

# Django compressor offline mode
COMPRESS_OFFLINE = False
COMPRESS_OFFLINE_CONTEXT = [
    {"fonts_cdn_url": FONTS_CDN_URL, "STATIC_URL": STATIC_URL, "LANGUAGE_BIDI": True},
    {"fonts_cdn_url": FONTS_CDN_URL, "STATIC_URL": STATIC_URL, "LANGUAGE_BIDI": False},
]

# Require login for all URLs
if REQUIRE_LOGIN:
    LOGIN_REQUIRED_URLS = (r"/(.*)$",)

# In such case you will want to include some of the exceptions
# LOGIN_REQUIRED_URLS_EXCEPTIONS = (
#    rf"{URL_PREFIX}/accounts/(.*)$",  # Required for login
#    rf"{URL_PREFIX}/admin/login/(.*)$",  # Required for admin login
#    rf"{URL_PREFIX}/static/(.*)$",  # Required for development mode
#    rf"{URL_PREFIX}/widgets/(.*)$",  # Allowing public access to widgets
#    rf"{URL_PREFIX}/data/(.*)$",  # Allowing public access to data exports
#    rf"{URL_PREFIX}/hooks/(.*)$",  # Allowing public access to notification hooks
#    rf"{URL_PREFIX}/healthz/$",  # Allowing public access to health check
#    rf"{URL_PREFIX}/api/(.*)$",  # Allowing access to API
#    rf"{URL_PREFIX}/js/i18n/$",  # JavaScript localization
#    rf"{URL_PREFIX}/contact/$",  # Optional for contact form
#    rf"{URL_PREFIX}/legal/(.*)$",  # Optional for legal app
# )

# Silence some of the Django system checks
SILENCED_SYSTEM_CHECKS = [
    # We have modified django.contrib.auth.middleware.AuthenticationMiddleware
    # as weblate.accounts.middleware.AuthenticationMiddleware
    "admin.E408"
]

# Celery worker configuration for testing
# CELERY_TASK_ALWAYS_EAGER = True
# CELERY_BROKER_URL = "memory://"
# CELERY_TASK_EAGER_PROPAGATES = True
# Celery worker configuration for production
CELERY_TASK_ALWAYS_EAGER = False
CELERY_BROKER_URL = "redis://localhost:6379"
CELERY_RESULT_BACKEND = CELERY_BROKER_URL

# Celery settings, it is not recommended to change these
CELERY_WORKER_MAX_MEMORY_PER_CHILD = 200000
CELERY_BEAT_SCHEDULE_FILENAME = os.path.join(DATA_DIR, "celery", "beat-schedule")
CELERY_TASK_ROUTES = {
    "weblate.trans.tasks.auto_translate": {"queue": "translate"},
    "weblate.accounts.tasks.notify_*": {"queue": "notify"},
    "weblate.accounts.tasks.send_mails": {"queue": "notify"},
    "weblate.utils.tasks.settings_backup": {"queue": "backup"},
    "weblate.utils.tasks.database_backup": {"queue": "backup"},
    "weblate.wladmin.tasks.backup": {"queue": "backup"},
    "weblate.wladmin.tasks.backup_service": {"queue": "backup"},
    "weblate.memory.tasks.*": {"queue": "memory"},
}

# Enable plain database backups
DATABASE_BACKUP = "plain"

# Enable auto updating
AUTO_UPDATE = False

# PGP commits signing
WEBLATE_GPG_IDENTITY = None

# Third party services integration
MATOMO_SITE_ID = None
MATOMO_URL = None
GOOGLE_ANALYTICS_ID = None
SENTRY_DSN = None
AKISMET_API_KEY = None

Management commands

注釈

Running management commands under a different user than the one running your webserver can result in files getting wrong permissions, please check Filesystem permissions for more details.

You will find basic management commands (available as ./manage.py in the Django sources, or as an extended set in a script called weblate installable atop Weblate).

Invoking management commands

As mentioned before, invocation depends on how you installed Weblate.

If using virtualenv for Weblate, you can either specify the full path to weblate, or activate the virtualenv prior to invoking it:

# Direct invocation
~/weblate-env/bin/weblate

# Activating virtualenv adds it to search path
. ~/weblate-env/bin/activate
weblate

If you are using source code directly (either from a tarball or Git checkout), the management script is ./manage.py available in the Weblate sources. To run it:

python ./manage.py list_versions

If you've installed Weblate using the pip or pip3 installer, or by using the ./setup.py script, the weblate is installed to your path (or virtualenv path), from where you can use it to control Weblate:

weblate list_versions

For the Docker image, the script is installed like above, and you can run it using docker exec:

docker exec --user weblate <container> weblate list_versions

For docker-compose the process is similar, you just have to use docker-compose exec:

docker-compose exec --user weblate weblate weblate list_versions

In case you need to pass it a file, you can temporary add a volume:

docker-compose exec --user weblate /tmp:/tmp weblate weblate importusers /tmp/users.json

参考

Installing using Docker、Installing on Debian and Ubuntu、Installing on SUSE and openSUSE、Installing on RedHat, Fedora and CentOS、Installing from sources

add_suggestions

weblate add_suggestions <project> <component> <language> <file>

バージョン 2.5 で追加.

Imports a translation from the file to use as a suggestion for the given translation. It skips duplicated translations; only different ones are added.

--author USER@EXAMPLE.COM

E-mail of author for the suggestions. This user has to exist prior to importing (you can create one in the admin interface if needed).

例:

weblate --author michal@cihar.com add_suggestions weblate application cs /tmp/suggestions-cs.po

auto_translate

weblate auto_translate <project> <component> <language>

バージョン 2.5 で追加.

Performs automatic translation based on other component translations.

--source PROJECT/COMPONENT

Specifies the component to use as source available for translation. If not specified all components in the project are used.

--user USERNAME

Specify username listed as author of the translations. "Anonymous user" is used if not specified.

--overwrite

Whether to overwrite existing translations.

--inconsistent

Whether to overwrite existing translations that are inconsistent (see 一貫性の欠如).

--add

Automatically add language if a given translation does not exist.

--mt MT

Use machine translation instead of other components as machine translations.

--threshold THRESHOLD

Similarity threshold for machine translation, defaults to 80.

例:

weblate auto_translate --user nijel --inconsistent --source weblate/application weblate website cs

参考

自動翻訳

celery_queues

weblate celery_queues

バージョン 3.7 で追加.

Displays length of Celery task queues.

checkgit

weblate checkgit <project|project/component>

Prints current state of the back-end Git repository.

You can either define which project or component to update (for example weblate/application), or use --all to update all existing components.

commitgit

weblate commitgit <project|project/component>

Commits any possible pending changes to the back-end Git repository.

You can either define which project or component to update (for example weblate/application), or use --all to update all existing components.

commit_pending

weblate commit_pending <project|project/component>

Commits pending changes older than a given age.

You can either define which project or component to update (for example weblate/application), or use --all to update all existing components.

--age HOURS

Age in hours for committing. If not specified the value configured in Component configuration is used.

注釈

This is automatically performed in the background by Weblate, so there no real need to invoke this manually, besides forcing an earlier commit than specified by Component configuration.

参考

Running maintenance tasks、COMMIT_PENDING_HOURS

cleanuptrans

weblate cleanuptrans

Cleans up orphaned checks and translation suggestions. There is normally no need to run this manually, as the cleanups happen automatically in the background.

参考

Running maintenance tasks

createadmin

weblate createadmin

Creates an admin account with a random password, unless it is specified.

--password PASSWORD

Provides a password on the command-line, to not generate a random one.

--no-password

Do not set password, this can be useful with --update.

--username USERNAME

Use the given name instead of admin.

--email USER@EXAMPLE.COM

Specify the admin e-mail address.

--name

Specify the admin name (visible).

--update

Update the existing user (you can use this to change passwords).

バージョン 2.9 で変更: Added parameters --username, --email, --name and --update.

dump_memory

weblate dump_memory

バージョン 2.20 で追加.

Export a JSON file containing Weblate Translation Memory content.

参考

翻訳メモリ、Weblate 翻訳メモリ概要

dumpuserdata

weblate dumpuserdata <file.json>

Dumps userdata to a file for later use by importuserdata

ヒント

This comes in handy when migrating or merging Weblate instances.

import_demo

weblate import_demo

バージョン 4.1 で追加.

Creates a demo project with components based on <https://github.com/WeblateOrg/demo>.

This can be useful when developing Weblate.

import_json

weblate import_json <json-file>

バージョン 2.7 で追加.

Batch import of components based on JSON data.

The imported JSON file structure pretty much corresponds to the component object (see GET /api/components/(string:project)/(string:component)/). You have to include the name and filemask fields.

--project PROJECT

Specifies where the components will be imported from.

--main-component COMPONENT

Use the given VCS repository from this component for all of them.

--ignore

Skip (already) imported components.

--update

Update (already) imported components.

バージョン 2.9 で変更: The parameters --ignore and --update are there to deal with already imported components.

Example of JSON file:

[
  {
    "slug": "po",
    "name": "Gettext PO",
    "file_format": "po",
    "filemask": "po/*.po",
    "new_lang": "none"
  },
  {
    "name": "Android",
    "filemask": "android/values-*/strings.xml",
    "template": "android/values/strings.xml",
    "repo": "weblate://test/test",
    "file_format": "aresource"
  }
]

参考

import_memory

import_memory

weblate import_memory <file>

バージョン 2.20 で追加.

Imports a TMX or JSON file into the Weblate translation memory.

--language-map LANGMAP

Allows mapping languages in the TMX to the Weblate translation memory. The language codes are mapped after normalization usually done by Weblate.

--language-map en_US:en will for example import all en_US strings as en ones.

This can be useful in case your TMX file locales happen not to match what you use in Weblate.

参考

翻訳メモリ、Weblate 翻訳メモリ概要

import_project

weblate import_project <project> <gitrepo> <branch> <filemask>

バージョン 3.0 で変更: The import_project command is now based on the コンポーネントの検出 addon, leading to some changes in behavior and what parameters are accepted.

Batch imports components into project based on filemask.

<project> names an existing project, into which the components are to be imported.

The <gitrepo> defines the Git repository URL to use, and <branch> signifies the Git branch. To import additional translation components from an existing Weblate component, use a weblate://<project>/<component> URL for the <gitrepo>.

The <filemask> defines file discovery for the repository. It can be either be made simple using wildcards, or it can use the full power of regular expressions.

The simple matching uses ** for component name and * for language, for example: **/*.po

The regular expression has to contain groups named component and language. For example: (?P<language>[^/]*)/(?P<component>[^-/]*)\.po

The import matches existing components based on files and adds the ones that do not exist. It does not change already existing ones.

--name-template TEMPLATE

Customize the name of a component using Django template syntax.

For example: Documentation: {{ component }}

--base-file-template TEMPLATE

Customize the base file for monolingual translations.

For example: {{ component }}/res/values/string.xml

--new-base-template TEMPLATE

Customize the base file for addition of new translations.

For example: {{ component }}/ts/en.ts

--file-format FORMAT

You can also specify the file format to use (see Supported file formats), the default is auto-detection.

--language-regex REGEX

You can specify language filtering (see Component configuration) with this parameter. It has to be a valid regular expression.

--main-component

You can specify which component will be chosen as the main one—the one actually containing the VCS repository.

--license NAME

Specify the overall, project or component translation license.

--license-url URL

Specify the URL where the translation license is to be found.

--vcs NAME

In case you need to specify which version control system to use, you can do it here. The default version control is Git.

To give you some examples, let's try importing two projects.

First The Debian Handbook translations, where each language has separate a folder with the translations of each chapter:

weblate import_project \
    debian-handbook \
    git://anonscm.debian.org/debian-handbook/debian-handbook.git \
    squeeze/master \
    '*/**.po'

Then the Tanaguru tool, where the file format needs be specified, along with the base file template, and how all components and translations are located in single folder:

weblate import_project \
    --file-format=properties \
    --base-file-template=web-app/tgol-web-app/src/main/resources/i18n/%s-I18N.properties \
    tanaguru \
    https://github.com/Tanaguru/Tanaguru \
    master \
    web-app/tgol-web-app/src/main/resources/i18n/**-I18N_*.properties

More complex example of parsing of filenames to get the correct component and language out of a filename like src/security/Numerous_security_holes_in_0.10.1.de.po:

weblate import_project \
    tails \
    git://git.tails.boum.org/tails master \
    'wiki/src/security/(?P<component>.*)\.(?P<language>[^.]*)\.po$'

Filtering only translations in a chosen language:

./manage import_project \
    --language-regex '^(cs|sk)$' \
    weblate \
    https://github.com/WeblateOrg/weblate.git \
    'weblate/locale/*/LC_MESSAGES/**.po'

Importing Sphinx documentation split to multiple files:

$ weblate import_project --name-template 'Documentation: %s' \
    --file-format po \
    project https://github.com/project/docs.git master \
    'docs/locale/*/LC_MESSAGES/**.po'

Importing Sphinx documentation split to multiple files and directories:

$ weblate import_project --name-template 'Directory 1: %s' \
    --file-format po \
    project https://github.com/project/docs.git master \
    'docs/locale/*/LC_MESSAGES/dir1/**.po'
$ weblate import_project --name-template 'Directory 2: %s' \
    --file-format po \
    project https://github.com/project/docs.git master \
    'docs/locale/*/LC_MESSAGES/dir2/**.po'

参考

More detailed examples can be found in the Starting with internationalization chapter, alternatively you might want to use import_json.

importuserdata

weblate importuserdata <file.json>

Imports user data from a file created by dumpuserdata

importusers

weblate importusers --check <file.json>

Imports users from JSON dump of the Django auth_users database.

--check

With this option it will just check whether a given file can be imported and report possible conflicts arising from usernames or e-mails.

You can dump users from the existing Django installation using:

weblate dumpdata auth.User > users.json

install_addon

バージョン 3.2 で追加.

weblate install_addon --addon ADDON <project|project/component>

Installs an addon to a set of components.

--addon ADDON

Name of the addon to install. For example weblate.gettext.customize.

--configuration CONFIG

JSON encoded configuration of an addon.

--update

Update the existing addon configuration.

You can either define which project or component to install the addon in (for example weblate/application), or use --all to include all existing components.

To install gettext 出力のカスタマイズ for all components:

weblate install_addon --addon weblate.gettext.customize --config '{"width": -1}' --update --all

参考

アドオン

list_languages

weblate list_languages <locale>

Lists supported languages in MediaWiki markup - language codes, English names and localized names.

This is used to generate <https://wiki.l10n.cz/Slovn%C3%ADk_s_n%C3%A1zvy_jazyk%C5%AF>.

list_translators

weblate list_translators <project|project/component>

Lists translators by contributed language for the given project:

[French]
Jean Dupont <jean.dupont@example.com>
[English]
John Doe <jd@example.com>

--language-code

List names by language code instead of language name.

You can either define which project or component to use (for example weblate/application), or use --all to list translators from all existing components.

list_versions

weblate list_versions

Lists all Weblate dependencies and their versions.

loadpo

weblate loadpo <project|project/component>

Reloads translations from disk (for example in case you have done some updates in the VCS repository).

--force

Force update, even if the files should be up-to-date.

--lang LANGUAGE

Limit processing to a single language.

You can either define which project or component to update (for example weblate/application), or use --all to update all existing components.

注釈

You seldom need to invoke this, Weblate will automatically load changed files for every VCS update. This is needed in case you manually changed an underlying Weblate VCS repository or in some special cases following an upgrade.

lock_translation

weblate lock_translation <project|project/component>

Prevents further translation of a component.

ヒント

Useful in case you want to do some maintenance on the underlying repository.

You can either define which project or component to update (for example weblate/application), or use --all to update all existing components.

参考

unlock_translation

move_language

weblate move_language source target

バージョン 3.0 で追加.

Allows you to merge language content. This is useful when updating to a new version which contains aliases for previously unknown languages that have been created with the (generated) suffix. It moves all content from the source language to the target one.

例:

weblate move_language cze cs

After moving the content, you should check whether there is anything left (this is subject to race conditions when somebody updates the repository meanwhile) and remove the (generated) language.

pushgit

weblate pushgit <project|project/component>

Pushes committed changes to the upstream VCS repository.

--force-commit

Force commits any pending changes, prior to pushing.

You can either define which project or component to update (for example weblate/application), or use --all to update all existing components.

注釈

Weblate pushes changes automatically if コミット時にプッシュする in Component configuration is turned on, which is the default.

unlock_translation

weblate unlock_translation <project|project/component>

Unlocks a given component, making it available for translation.

ヒント

Useful in case you want to do some maintenance on the underlying repository.

You can either define which project or component to update (for example weblate/application), or use --all to update all existing components.

参考

lock_translation

setupgroups

weblate setupgroups

Configures default groups and optionally assigns all users to that default group.

--no-privs-update

Turns off automatic updating of existing groups (only adds new ones).

--no-projects-update

Prevents automatic updates of groups for existing projects. This allows adding newly added groups to existing projects, see プロジェクトのアクセス制御.

参考

アクセス制御

setuplang

weblate setuplang

Updates list of defined languages in Weblate.

--no-update

Turns off automatic updates of existing languages (only adds new ones).

updatechecks

weblate updatechecks <project|project/component>

Updates all checks for all strings.

ヒント

Useful for upgrades which do major changes to checks.

You can either define which project or component to update (for example weblate/application), or use --all to update all existing components.

updategit

weblate updategit <project|project/component>

Fetches remote VCS repositories and updates the internal cache.

You can either define which project or component to update (for example weblate/application), or use --all to update all existing components.

注釈

Usually it is better to configure hooks in the repository to trigger 通知フック, instead of regular polling by updategit.

お知らせ

バージョン 4.0 で変更: In prior releases this feature was called whiteboard messages.

Provide info to your translators by posting announcements, site-wide, per project, component, or language.

Announce the purpose, deadlines, status, or specify targets for translation.

The users will receive notification on the announcements for watched projects (unless they opt out).

This can be useful for various things from announcing the purpose of the website to specifying targets for translations.

The announcements can posted on each level in the Manage menu, using Post announcement:

It can be also added using the admin interface:

The announcements are then shown based on their specified context:

No context specified

Shown on dashboard (landing page).

Project specified

Shown within the project, including all its components and translations.

Component specified

Shown for a given component and all its translations.

Language specified

Shown on the language overview and all translations in that language.

This is how it looks on the language overview page:

コンポーネント リストのセット

ユーザー ダッシュボードにオプションとして表示するコンポーネント リストのセットを複数指定し、ユーザーがデフォルト ビューとして 1 つを選択できるようにします。詳細については、ダッシュボード を参照してください。

バージョン 2.20 で変更: ダッシュボードに表示される各コンポーネントリストごとの状況を表示します。

コンポーネント リストのセットの名前と内容は、管理インターフェイスの Component lists セクションで指定できます。各コンポーネント リストには、ユーザーに表示される名前と、URL に表示するスラグが必要です。

バージョン 2.13 で変更: 管理者インターフェイスから匿名ユーザーのダッシュボード設定を変更し、認証されていないユーザーに表示するダッシュボードを変更します。

コンポーネント リストのセットの自動割り当て

バージョン 2.13 で追加.

Automatic component list assignment ルールを作成して、スラグに基づいてコンポーネントをリストに自動的に追加します。

• 大規模なインストールでコンポーネント リストのセットを管理する場合や、Weblate のインストールで必要なすべてのコンポーネントを 1 つのコンポーネント リストにする場合に便利です。

ヒント

Weblate インストールのすべてのコンポーネントを含むコンポーネント リストを作成します。

1. Define Automatic component list assignment with ^.*$ as regular expression in both the project and the component fields, as shown on this image:

Optional Weblate modules

Several optional modules are available for your setup.

Git exporter

バージョン 2.10 で追加.

Provides you read-only access to the underlying Git repository using HTTP(S).

導入

1. Add weblate.gitexport to installed apps in settings.py:

INSTALLED_APPS += ("weblate.gitexport",)

2. Export existing repositories by migrating your database after installation:

weblate migrate

Usage

The module automatically hooks into Weblate and sets the exported repository URL in the Component configuration. The repositories are accessible under the /git/ part of the Weblate URL, for example https://example.org/git/weblate/master/.

Repositories for publicly available projects can be cloned without authentication:

git clone 'https://example.org/git/weblate/master/'

Access to the repositories with restricted access (using プロジェクトのアクセス制御 or when REQUIRE_LOGIN is enabled) requires a API token which can be obtained in your ユーザー情報:

git clone 'https://user:KEY@example.org/git/weblate/master/'

請求

バージョン 2.4 で追加.

This is used on Hosted Weblate to define billing plans, track invoices and usage limits.

導入

1. Add weblate.billing to installed apps in settings.py:

INSTALLED_APPS += ("weblate.billing",)

2. Run the database migration to optionally install additional database structures for the module:

weblate migrate

Usage

After installation you can control billing in the admin interface. Users with billing enabled will get new Billing tab in their ユーザー情報.

The billing module additionally allows project admins to create new projects and components without being superusers (see Adding translation projects and components). This is possible when following conditions are met:

• The billing is in its configured limits (any overusage results in blocking of project/component creation) and paid (if its price is non zero)

• The user is admin of existing project with billing or user is owner of billing (the latter is necessary when creating new billing for users to be able to import new projects).

Upon project creation user is able to choose which billing should be charged for the project in case he has access to more of them.

法律上の告知事項

バージョン 2.15 で追加.

This is used on Hosted Weblate to provide required legal documents. It comes provided with blank documents, and you are expected to fill out the following templates in the documents:

legal/documents/tos.html

Terms of service document

legal/documents/privacy.html

Privacy policy document

legal/documents/summary.html

Short overview of the terms of service and privacy policy

注釈

Legal documents for the Hosted Weblate service are available in this Git repository <https://github.com/WeblateOrg/wllegal/tree/master/wllegal/templates/legal/documents>.

Most likely these will not be directly usable to you, but might come in handy as a starting point if adjusted to meet your needs.

導入

1. Add weblate.legal to installed apps in settings.py:

INSTALLED_APPS += ("weblate.legal",)

# Optional:

# Social auth pipeline to confirm TOS upon registration/subsequent sign in
SOCIAL_AUTH_PIPELINE += ("weblate.legal.pipeline.tos_confirm",)

# Middleware to enforce TOS confirmation of signed in users
MIDDLEWARE += [
    "weblate.legal.middleware.RequireTOSMiddleware",
]

2. Run the database migration to optionally install additional database structures for the module:

weblate migrate

3. Edit the legal documents in the weblate/legal/templates/legal/ folder to match your service.

Usage

After installation and editing, the legal documents are shown in the Weblate UI.

Avatars

Avatars are downloaded and cached server-side to reduce information leaks to the sites serving them by default. The built-in support for fetching avatars from e-mails addresses configured for it can be turned off using ENABLE_AVATARS.

Weblate currently supports:

• Gravatar

参考

アバターのキャッシュ、AVATAR_URL_PREFIX、ENABLE_AVATARS

Spam protection

You can protect against suggestion spamming by unauthenticated users by using the akismet.com service.

1. Install the akismet Python module

2. Configure the Akismet API key.

注釈

This (among other things) relies on IP address of the client, please see Running behind reverse proxy for properly configuring that.

参考

Running behind reverse proxy、AKISMET_API_KEY

Signing Git commits with GnuPG

バージョン 3.1 で追加.

All commits can be signed by the GnuPG key of the Weblate instance.

1. Turn on WEBLATE_GPG_IDENTITY. (Weblate will generate a GnuPG key when needed and will use it to sign all translation commits.)

This feature needs GnuPG 2.1 or newer installed.

You can find the key in the DATA_DIR and the public key is shown on the "About" page:

2. Alternatively you can also import existing keys into Weblate, just set HOME=$DATA_DIR/home when invoking gpg.

参考

WEBLATE_GPG_IDENTITY

レート制限

バージョン 3.2 で変更: レート制限では、さらに詳細な設定が可能になりました。

Several operations in Weblate are rate limited. At most RATELIMIT_ATTEMPTS attempts are allowed within RATELIMIT_WINDOW seconds. The user is then blocked for RATELIMIT_LOCKOUT. There are also settings specific to scopes, for example RATELIMIT_CONTACT_ATTEMPTS or RATELIMIT_TRANSLATE_ATTEMPTS. The table below is a full list of available scopes.

次の操作は、レート制限の対象となります。

名前	範囲	許可した試行回数	ウィンドウ レート制限	ロックアウト期間
登録	REGISTRATION	5	300	600
管理者へメッセージの送信	MESSAGE	5	300	600
サイン イン時のパスワード認証	LOGIN	5	300	600
サイト全体の検索	SEARCH	6	60	60
翻訳	TRANSLATE	30	60	600
用語集に用語を追加	GLOSSARY	30	60	600

ユーザーがログインに AUTH_LOCK_ATTEMPTS 回失敗した場合、パスワードのリセット処理を完了するまで、アカウントのパスワード認証を無効にします。

The API has separate rate limiting settings, see API レート制限.

参考

レート制限、Running behind reverse proxy、API レート制限

Customizing Weblate

Extend and customize using Django and Python. Contribute your changes upstream so that everybody can benefit. This reduces your maintenance costs; code in Weblate is taken care of when changing internal interfaces or refactoring the code.

警告

Neither internal interfaces nor templates are considered a stable API. Please review your own customizations for every upgrade, the interfaces or their semantics might change without notice.

参考

Weblate に貢献

Creating a Python module

If you are not familiar with Python, you might want to look into Python For Beginners, explaining the basics and pointing to further tutorials.

To write some custom Python code (called a module), a place to store it is needed, either in the system path (usually something like /usr/lib/python3.7/site-packages/) or in the Weblate directory, which is also added to the interpreter search path.

Better yet, turn your customization into a proper Python package:

1. Create a folder for your package (we will use weblate_customization).

2. Within it, create a setup.py file to describe the package:

   from setuptools import setup
   
   setup(
       name="weblate_customization",
       version="0.0.1",
       author="Your name",
       author_email="yourname@example.com",
       description="Sample Custom check for Weblate.",
       license="GPLv3+",
       keywords="Weblate check example",
       packages=["weblate_customization"],
   )
   

3. Create a folder for the Python module (also called weblate_customization) for the customization code.

4. Within it, create a __init__.py file to make sure Python can import the module.

5. This package can now be installed using pip install -e. More info to be found in “Editable” Installs.

6. Once installed, the module can be used in the Weblate configuration (for example weblate_customization.checks.FooCheck).

Your module structure should look like this:

weblate_customization
├── setup.py
└── weblate_customization
    ├── __init__.py
    ├── addons.py
    └── checks.py

You can find an example of customizing Weblate at <https://github.com/WeblateOrg/customize-example>, it covers all the topics described below.

Changing the logo

1. 上書きしたい静的ファイルを含む単純な Django アプリケーションを作成します（参照:ref:custom-module）。

   Branding appears in the following files:

   icons/weblate.svg

   Logo shown in the navigation bar.

   logo-*.png

   Web icons depending on screen resolution and web-browser.

   favicon.ico

   Web icon used by legacy browsers.

   weblate-*.png

   Avatars for bots or anonymous users. Some web-browsers use these as shortcut icons.

   email-logo.png

   Used in notifications e-mails.

2. Add it to INSTALLED_APPS:

   INSTALLED_APPS = (
       # Add your customization as first
       "weblate_customization",
       # Weblate apps are here…
   )
   

3. Run weblate collectstatic --noinput, to collect static files served to clients.

参考

Managing static files (e.g. images, JavaScript, CSS)、Serving static files

品質検査、アドオン、自動修正のカスタマイズ

あなたのコードを Weblate の 自動修正のカスタマイズ、独自検査の記述、またはr Writing addon にインストールする方法:

1. Weblate のカスタマイズを含むファイルを、Python モジュール内に置く（参照:ref:custom-module）。

2. Python クラスへの完全修飾パスを専用設定に追加する（WEBLATE_ADDONS、CHECK_LIST または AUTOFIX_LIST):

# Checks
CHECK_LIST += ("weblate_customization.checks.FooCheck",)

# Autofixes
AUTOFIX_LIST += ("weblate_customization.autofix.FooFixer",)

# Addons
WEBLATE_ADDONS += ("weblate_customization.addons.ExamplePreAddon",)

参考

自動修正のカスタマイズ、独自検査の記述、Writing addon、Executing scripts from addon

Management interface

The management interface offer administration settings under the /management/ URL. It is available for users signed in with admin privileges, accessible by using the wrench icon top right:

The Django admin interface

警告

Will be removed in the future, as its use is discouraged—most features can be managed directly in Weblate.

Here you can manage objects stored in the database, such as users, translations and other settings:

In the Reports section, you can check the status of your site, tweak it for Production setup, or manage SSH keys used to access リポジトリへの接続.

Manage database objects under any of the sections. The most interesting one is probably Weblate translations, where you can manage translatable projects, see Project configuration and Component configuration.

Weblate languages holds language definitions, explained further in Language definitions.

Adding a project

Adding a project serves as container for all components. Usually you create one project for one piece of software, or book (See Project configuration for info on individual parameters):

参考

Project configuration

Bilingual components

Once you have added a project, translation components can be added to it. (See Component configuration for info regarding individual parameters):

参考

Component configuration、Bilingual and monolingual formats

Monolingual components

For easier translation of these, provide a template file containing the mapping of message IDs to its respective source language (usually English). (See Component configuration for info regarding individual parameters):

参考

Component configuration、Bilingual and monolingual formats

Getting support for Weblate

Weblate はコミュニティによる支援がある、コピーレフトな Libre ソフトウェアです。サブスクライバ（定期購入者）は、追加料金なしで優先的なサポートを受けられます。事前購入のヘルプ パッケージ（一時的な緊急サポート）は、誰でも申し込めます。現在提供されているサポートの詳細については、<https://weblate.org/support/> を参照してください。

Integrating support

バージョン 3.8 で追加.

Purchased support packages can optionally be integrated into your Weblate subscription management interface, from where you will find a link to it. Basic instance details about your installation are also reported back to Weblate this way.

Data submitted to the Weblate

• URL where your Weblate instance is configured

• Your site title

• The Weblate version you are running

• Tallies of some objects in your Weblate database (projects, components, languages, source strings and users)

• The public SSH key of your instance

No other data is submitted.

Integration services

• See if your support package is still valid

• Weblate provisioned backup storage

ヒント

Purchased support packages are already activated upon purchase, and can be used without integrating them.

Legal documents

注釈

Herein you will find various legal information you might need to operate Weblate in certain legal jurisdictions. It is provided as a means of guidance, without any warranty of accuracy or correctness. It is ultimately your responsibility to ensure that your use of Weblate complies with all applicable laws and regulations.

ITAR and other export controls

Weblate can be run within your own datacenter or virtual private cloud. As such, it can be used to store ITAR or other export-controlled information, however, end users are responsible for ensuring such compliance.

The Hosted Weblate service has not been audited for compliance with ITAR or other export controls, and does not currently offer the ability to restrict translations access by country.

US encryption controls

Weblate does not contain any cryptographic code, but might be subject export controls as it uses third party components utilizing cryptography for authentication, data-integrity and -confidentiality.

Most likely Weblate would be classified as ECCN 5D002 or 5D992 and, as publicly available libre software, it should not be subject to EAR (see Encryption items NOT Subject to the EAR).

Software components used by Weblate (listing only components related to cryptographic function):

Python

See https://wiki.python.org/moin/PythonSoftwareFoundationLicenseFaq#Is_Python_subject_to_export_laws.3F

GnuPG

Optionally used by Weblate

Git

Optionally used by Weblate

curl

Used by Git

OpenSSL

Used by Python and cURL

The strength of encryption keys depends on the configuration of Weblate and the third party components it interacts with, but in any decent setup it will include all export restricted cryptographic functions:

• In excess of 56 bits for a symmetric algorithm

• Factorisation of integers in excess of 512 bits for an asymmetric algorithm

• Computation of discrete logarithms in a multiplicative group of a finite field of size greater than 512 bits for an asymmetric algorithm

• Discrete logarithms in a group different than above in excess of 112 bits for an asymmetric algorithm

Weblate doesn't have any cryptographic activation feature, but it can be configured in a way where no cryptography code would be involved. The cryptographic features include:

• Accessing remote servers using secure protocols (HTTPS)

• Generating signatures for code commits (PGP)

参考

Export Controls (EAR) on Open Source Software

Starting with internationalization

Have a project and want to translate it into several languages? This guide will help you do so. Several typical situations are showcased, but most of the examples are generic and can be applied to other scenarios as well.

Before translating any software, you should realize that languages around the world are really different and you should not make any assumption based on your experience. For most of languages it will look weird if you try to concatenate a sentence out of translated segments. You also should properly handle plural forms because many languages have complex rules for that and the internationalization framework you end up using should support this.

Last but not least, sometimes it might be necessary to add some context to the translated string. Imagine a translator would get string Sun to translate. Without context most people would translate that as our closest star, but it might be actually used as an abbreviation for Sunday.

Choosing internationalization framework

Choose whatever is standard on your platform, try to avoid reinventing the wheel by creating your own framework to handle localizations. Weblate supports most of the widely used frameworks, see Supported file formats for more information (especially Translation types capabilities).

Our personal recommendation for some platforms is in the following table. This is based on our experience, but that can not cover all use cases, so always consider your environment when doing the choice.

Platform	Recommended format
Android	Android string resources
iOS	Apple iOS strings
Qt	Qt Linguist .ts
Python	GNU gettext
PHP	GNU gettext 1
C/C++	GNU gettext
C#	.XML resource files
Perl	GNU gettext
Ruby	Ruby YAML files
Web extensions	WebExtension JSON
Java	XLIFF 2
JavaScript	JSON i18next files 3

1

The native Gettext support in PHP is buggy and often missing on Windows builds, it is recommended to use third party library motranslator instead.

2

You can also use Java properties if plurals are not needed.

3

You can also use plain JSON files if plurals are not needed.

The more detailed workflow for some formats is described in following chapters:

• Translating software using GNU Gettext

• Translating documentation using Sphinx

• Translating HTML and JavaScript using Weblate CDN

参考

Integrating with Weblate、Web サービスを連携して翻訳

Integrating with Weblate

Weblate の基本

プロジェクトとコンポーネントの構造

Weblate では、翻訳はプロジェクトとコンポーネントから成ります。各プロジェクトには複数のコンポーネントを含めることができ、コンポーネントにはそれぞれの言語への翻訳が含まれます。コンポーネントは、翻訳可能な 1 つのファイル（例えば GNU gettext や Android string resources）に対応します。プロジェクトは、コンポーネントを論理的なまとまりに分類する（たとえば、1 つのアプリケーション内で使用するすべての翻訳をグループ化する）のに便利です。

内部ではデフォルトで、各プロジェクトごとに、共通する文字列の翻訳をプロジェクト内の他のコンポーネントに伝播します。これにより、反復や複数バージョンの翻訳の負担を軽減します。翻訳を分岐する場合は、変換の伝播を Component configuration ごとに無効にできます。

現地語化プロジェクトを Weblate にインポートする

Weblate was developed with VCS integration in mind. The easiest approach to integrate with it is to grant access to your VCS repository. The import process will guide you through configuring components with your translations.

In case you do not use VCS or do not want to grant access to your VCS at all, you can use Weblate without a remote VCS repository - it will create local repository with all the translations.

参考

Adding translation projects and components、How can I limit Weblate access to only translations, without exposing source code to it?

Getting translations updates from Weblate

To fetch updated strings from Weblate you can simply fetch the underlying repository (either from filesystem or it can be made available through Git exporter). Prior to this, you might want to commit any pending changes (see Lazy commits). This can be achieved in the user interface (in the Repository maintenance) or from command line using Weblate クライアント.

This can be automated if you grant Weblate push access to your repository and configure リポジトリの送信先 URL in the Component configuration.

参考

Web サービスを連携して翻訳

Pushing string changes to Weblate

To push newly updated strings to Weblate, just let it pull from the upstream repository. This can be achieved in the user interface (in the Repository maintenance) or from command line using Weblate クライアント.

This can be automated by installing a webhook on your repository to trigger Weblate whenever there is a new commit, see Updating repositories for more details.

When not using a VCS integration, you can use UI or Weblate's REST API to update translations to match your code base.

参考

Web サービスを連携して翻訳

新しい文字列の追加

In case your translation files are stored in VCS together with the code, you most likely have existing workflow for developers to introduce new strings. You might extend it by using 原文の品質ゲートウェイ.

When the translation files are separate, there needs to be a way to introduce new strings. Weblate can add new strings on monolingual translations only (see Bilingual and monolingual formats). You have three options to do that:

• Manually, using Add new translation string from Tools menu on source language translation.

• プログラムのように、 API を使用します POST /api/translations/(string:project)/(string:component)/(string:language)/units/.

• By uploading source file as Replace existing translation file (this overwrites existing strings, so please make sure the file includes both old and new ones, see インポート方法).

Translating software using GNU Gettext

GNU Gettext is one of the most widely used tool for internationalization of free software. It provides a simple yet flexible way to localize the software. It has great support for plurals, it can add further context to the translated string and there are quite a lot of tools built around it. Of course it has great support in Weblate (see GNU gettext file format description).

注釈

If you are about to use it in proprietary software, please consult licensing first, it might not be suitable for you.

GNU Gettext can be used from a variety of languages (C, Python, PHP, Ruby, JavaScript and many more) and usually the UI frameworks already come with some support for it. The standard usage is through the gettext() function call, which is often aliased to _() to make the code simpler and easier to read.

Additionally it provides pgettext() call to provide additional context to translators and ngettext() which can handle plural types as defined for target language.

As a widely spread tool, it has many wrappers which make its usage really simple, instead of manual invoking of Gettext described below, you might want to try one of them, for example intltool.

ワークフローの概要

The GNU Gettext uses several files to manage the localization:

• PACKAGE.pot contains strings extracted from your source code, typically using xgettext or some high level wrappers such as intltool.

• LANGUAGE.po contains strings with a translation to single language. It has to be updated by msgmerge once the PACKAGE.pot is updated. You can create new language files using msginit or within Weblate.

• LANGUAGE.mo contains binary representation of LANGUAGE.po and is used at application runtime. Typically it is not kept under version control, but generated at compilation time using msgfmt. In case you want to have it in the version control, you can generate it in Weblate using MO ファイルの生成 addon.

Overall the GNU Gettext workflow looks like this:

参考

GNU Gettext の概要

Sample program

The simple program in C using Gettext might look like following:

#include <libintl.h>
#include <locale.h>
#include <stdio.h>
#include <stdlib.h>

int main(void)
{
    int count = 1;
    setlocale(LC_ALL, "");
    bindtextdomain("hello", "/usr/share/locale");
    textdomain("hello");
    printf(
        ngettext(
            "Orangutan has %d banana.\n",
            "Orangutan has %d bananas.\n",
            count
        ),
        count
    );
    printf("%s\n", gettext("Thank you for using Weblate."));
    exit(0);
}

Extracting translatable strings

Once you have code using the gettext calls, you can use xgettext to extract messages from it and store them into a .pot:

$ xgettext main.c -o po/hello.pot

注釈

There are alternative programs to extract strings from the code, for example pybabel.

This creates a template file, which you can use for starting new translations (using msginit) or updating existing ones after code change (you would use msgmerge for that). The resulting file is simply a structured text file:

# SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
# This file is distributed under the same license as the PACKAGE package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2015-10-23 11:02+0200\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"Language: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=CHARSET\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"

#: main.c:14
#, c-format
msgid "Orangutan has %d banana.\n"
msgid_plural "Orangutan has %d bananas.\n"
msgstr[0] ""
msgstr[1] ""

#: main.c:20
msgid "Thank you for using Weblate."
msgstr ""

Each msgid line defines a string to translate, the special empty string in the beginning is the file header containing metadata about the translation.

Starting new translation

With the template in place, we can start our first translation:

$ msginit -i po/hello.pot -l cs --no-translator -o po/cs.po
Created cs.po.

The just created cs.po already has some information filled in. Most importantly it got the proper plural forms definition for chosen language and you can see number of plurals have changed according to that:

# Czech translations for PACKAGE package.
# Copyright (C) 2015 THE PACKAGE'S COPYRIGHT HOLDER
# This file is distributed under the same license as the PACKAGE package.
# Automatically generated, 2015.
#
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2015-10-23 11:02+0200\n"
"PO-Revision-Date: 2015-10-23 11:02+0200\n"
"Last-Translator: Automatically generated\n"
"Language-Team: none\n"
"Language: cs\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=ASCII\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=3; plural=(n==1) ? 0 : (n>=2 && n<=4) ? 1 : 2;\n"

#: main.c:14
#, c-format
msgid "Orangutan has %d banana.\n"
msgid_plural "Orangutan has %d bananas.\n"
msgstr[0] ""
msgstr[1] ""
msgstr[2] ""

#: main.c:20
msgid "Thank you for using Weblate."
msgstr ""

This file is compiled into an optimized binary form, the .mo file used by the GNU Gettext functions at runtime.

Updating strings

Once you add more strings or change some strings in your program, you execute again xgettext which regenerates the template file:

$ xgettext main.c -o po/hello.pot

Then you can update individual translation files to match newly created templates (this includes reordering the strings to match new template):

$ msgmerge --previous --update po/cs.po po/hello.pot

Importing to Weblate

To import such translation into Weblate, all you need to define are the following fields when creating component (see Component configuration for detailed description of the fields):

Field	Value
ソースコードのリポジトリ	URL of the VCS repository with your project
File mask	po/*.po
新しい翻訳のテンプレート	po/hello.pot
ファイル形式	Choose Gettext PO file
新しい言語	Choose Create new language file

And that's it, you're now ready to start translating your software!

参考

You can find a Gettext example with many languages in the Weblate Hello project on GitHub: <https://github.com/WeblateOrg/hello>.

Translating documentation using Sphinx

Sphinx is a tool for creating beautiful documentation. It uses simple reStructuredText syntax and can generate output in many formats. If you're looking for an example, this documentation is also built using it. The very useful companion for using Sphinx is the Read the Docs service, which will build and publish your documentation for free.

I will not focus on writing documentation itself, if you need guidance with that, just follow instructions on the Sphinx website. Once you have documentation ready, translating it is quite easy as Sphinx comes with support for this and it is quite nicely covered in their Internationalization. It's matter of few configuration directives and invoking of the sphinx-intl tool.

If you are using Read the Docs service, you can start building translated documentation on the Read the Docs. Their Localization of Documentation covers pretty much everything you need - creating another project, set its language and link it from main project as a translation.

Now all you need is translating the documentation content. Sphinx generates PO file for each directory or top level file, what can lead to quite a lot of files to translate (depending on gettext_compact settings). You can import the index.po into Weblate as an initial component and then configure コンポーネントの検出 addon to automatically discover all others.

Component configuration

コンポーネント名	Documentation
File mask	docs/locales/*/LC_MESSAGES/index.po
新しい翻訳のテンプレート	docs/locales/index.pot
ファイル形式	gettext PO file
翻訳フラグ	rst-text

コンポーネント検出の設定

翻訳ファイルを照合する正規表現	docs/locales/(?P<language>[^/.]*)/LC_MESSAGES/(?P<component>[^/]*)\.po
コンポーネント名のカスタマイズ	Documentation: {{ component|title }}
新しい翻訳に対する基本ファイルの定義	docs/locales/{{ component }}.pot

ヒント

Would you prefer Sphinx to generate just single PO file? Since Sphinx 3.3.0 you can achieve this using:

gettext_compact = "docs"

You can find several documentation projects being translated using this approach:

• Weblate documentation (you are reading that now)

• Godot engine documentation

• Gallette documentation

• phpMyAdmin documentation

Translating HTML and JavaScript using Weblate CDN

Starting with Weblate 4.2 it is possible to export localization to a CDN using JavaScript 現地語化 CDN addon.

注釈

This feature is configured on Hosted Weblate. It requires additional configuration on your installation, see LOCALIZE_CDN_URL and LOCALIZE_CDN_PATH.

Upon installation into your component it will push committed translations (see Lazy commits) to the CDN and these can be used in your web pages to localize them.

コンポーネントの作成

First, you need to create a monolingual component which will hold your strings, see Adding translation projects and components for generic instructions on that.

In case you have existing repository to start with (for example the one containing HTML files), create an empty JSON file in the repository for the source language (see 原文の言語), for example locales/en.json. The content should be {} to indicate an empty object. Once you have that, the repository can be imported into Weblate and you can start with an addon configuration.

ヒント

In case you have existing translations, you can place them into the language JSON files and those will be used in Weblate.

For those who do not want to use existing repository (or do not have one), choose Start from scratch when creating component and choose JSON file as a file format (it is okay to choose any monolingual format at this point).

Weblate CDN アドオンの設定

The JavaScript 現地語化 CDN addon provides few configuration options.

翻訳目標のしきい値

Translations translated above this threshold will be included in the CDN.

CSS セレクタ

Configures which strings from the HTML documents are translatable, see Weblate CDN の文字列抽出 and Weblate CDN を使用した HTML の現地化.

言語 Cookie 名

Name of cookie which contains user selected language. Used in the JavaScript snippet for Weblate CDN を使用した HTML の現地化.

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

List of files in the repository or URLs where Weblate will look for translatable strings and offer them for a translation, see Weblate CDN の文字列抽出.

Weblate CDN の文字列抽出

The translation strings have to be present in Weblate. You can either manage these manually, use API to create them or list files or URLs using Extract strings from HTML files and Weblate will extract them automatically. The files have to present in the repository or contain remote URLs which will be download and parsed regularly by Weblate.

The default configuration for CSS selector extracts elements with CSS class l10n, for example it would extract two strings from following snippets:

<section class="content">
    <div class="row">
        <div class="wrap">
            <h1 class="section-title min-m l10n">Maintenance in progress</h1>
            <div class="page-desc">
                <p class="l10n">We're sorry, but this site is currently down for maintenance.</p>
            </div>
        </div>
    </div>
</section>

In case you don't want to modify existing code, you can also use * as a selector to process all elements.

注釈

Right now, only text of the elements is extracted. This addon doesn't support localization of element attributes or elements with childs.

Weblate CDN を使用した HTML の現地化

To localize a HTML document, you need to load the weblate.js script:

<script src="https://weblate-cdn.com/a5ba5dc29f39498aa734528a54b50d0a/weblate.js" async></script>

Upon loading, this will automatically find all matching translatable elements (based on CSS selector configuration) and replace their text with a translation.

The user language is detected from the configured cookie and falls back to user preferred languages configured in the browser.

The Language cookie name can be useful for integration with other applications (for example choose django_language when using Django).

JavaScript の現地化

The individual translations are exposed as bilingual JSON files under the CDN. To fetch one you can use following code:

fetch(("https://weblate-cdn.com/a5ba5dc29f39498aa734528a54b50d0a/cs.json")
  .then(response => response.json())
  .then(data => console.log(data));

The actual localization logic needs to be implemented in this case.

Translation component alerts

Shows errors in the Weblate configuration or the translation project for any given translation component. Guidance on how to address found issues is also offered.

Currently the following is covered:

• Duplicated source strings in translation files

• Duplicated languages within translations

• Merge or update failures in the source repository

• Unused new base in component settings

• Parse errors in the translation files

• Duplicate filemask used for linked components

• Broken URLs

• ライセンスがありません

Alerts are listed on each respective component page as Alerts. If it is missing, the component clears all current checks. Alerts can not be ignored, but will disappear once the underlying problem has been fixed.

A component with both duplicated strings and languages looks like this:

参考

Using custom certificate authority

Building translators community

現地化コミュニティのチェックリスト

バージョン 3.9 で追加.

The Community localization checklist which can be found in the menu of each component can give you guidance to make your localization process easy for community translators.

Managing translations

Adding new translations

New strings can be made available for translation when they appear in the base file, called Template for new translations (see Component configuration). If your file format doesn't require such a file, as is the case with most monolingual translation flows, you can start with blank files).

New languages can be added right away when requested by a user in Weblate, or a notification will be sent to project admins for approval and manual addition. This can be done using Start new translation in Component configuration.

注釈

Project admins can always start translation within Weblate directly.

Language files added manually to the VCS are added to the component when Weblate updates the repository. About repository update settings, see Updating repositories.

String variants

Variants are useful to group several strings together so that translators can see all variants of the string at one place. You can define regular expression to group the strings in the Component configuration:

In case the Key matches the expression, the matching part is removed to generate root key of the variant. All strings with same root key are then part of single variants group, including the translation exactly matching the root key and not matching the expression.

The following table lists some usage examples:

Use case	Regular expression variant	Matched translation keys
Suffix identification	(Short|Min)$	monthShort, monthMin, month
Inline identification	#[SML]	dial#S.key, dial#M.key, dial.key

The variant is later grouped when translating:

String labels

Split component translation strings into categories by text and colour in the project configuration.

ヒント

Labels can be assigned to units in Additional info on source strings by bulk editing, or using the 一括編集 addon.

Reviewing strings

Activity reports

Activity reports check changes of translations, for projects, components or individual users.

The activity reports for a project or component is accessible from its dashboard, on the Insights tab, selecting Activity.

More reports are accessible on the Insights tab, selecting Translation reports.

The activity of the currently signed in user can be seen by clicking on Profile from the user menu on the top right.

Source strings checks

There are many 品質検査, some of them focus on improving the quality of source strings. Many failing checks suggest a hint to make source strings easier to translate. All types of failing source checks are displayed on the Source tab of every component.

Translation string checks

Erroneous failing translation string checks indicate the problem is with the source string. Translators sometimes fix mistakes in the translation instead of reporting it - a typical example is a missing full stop at the end of a sentence.

Reviewing all failing checks can provide valuable feedback to improve its source strings. To make source strings review easier, Weblate automatically creates a translation for the source language and shows you source level checks there:

One of the most interesting checks here is the 複数の検査で不合格 - it is triggered whenever there is failure on multiple translations of a given string. Usually this is something to look for, as this is a string which translators have problems translating properly.

The detailed listing is a per language overview:

原文のフィードバックの受信

Translators can comment on both translation and source strings. Each Component configuration can be configured to receive such comments to an e-mail address (see 原文ミスの報告先アドレス), and using the developers mailing list is usually the best approach. This way you can keep an eye on when problems arise in translation, take care of them, and fix them quickly.

参考

コメント

Promoting the translation

Weblate provides you widgets to share on your website or other sources to promote the translation project. It also has a nice welcome page for new contributors to give them basic information about the translation. Additionally you can share information about translation using Facebook or Twitter. All these possibilities can be found on the Share tab:

All these badges are provided with the link to simple page which explains users how to translate using Weblate:

翻訳の進捗状況レポート

Reporting features give insight into how a translation progresses over a given period. A summary of contributions to any given component over time is provided. The reporting tool is found in the Insights menu of any translation component, project or on the dashboard:

Several reporting tools are available on this page and all can produce output in HTML, reStructuredText or JSON. The first two formats are suitable for embedding statistics into existing documentation, while JSON is useful for further processing of the data.

Translator credits

Generates a document usable for crediting translators - sorted by language and lists all contributors to a given language:

* Czech

    * Michal Čihař <michal@cihar.com> (10)
    * John Doe <john@example.com> (5)

* Dutch

    * Jane Doe <jane@example.com> (42)

It will render as:

• チェコ語

  • Michal Čihař <michal@cihar.com> (10)

  • John Doe <john@example.com> (5)

• オランダ語

  • Jae Doe <jane@example.com> (42)

ヒント

The number in parenthesis indicates number of contributions in given period.

貢献者の統計情報

Generates the number of translated words and strings by translator name:

======================================== ======================================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ========================
Name                                     Email                                    Count total              Source words total       Source chars total       Target words total       Target chars total       Count new                Source words new         Source chars new         Target words new         Target chars new         Count approved           Source words approved    Source chars approved    Target words approved    Target chars approved    Count edited             Source words edited      Source chars edited      Target words edited      Target chars edited
======================================== ======================================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ========================
Michal Čihař                             michal@cihar.com                                                1                        3                       24                        3                       21                        1                        3                       24                        3                       21                        0                        0                        0                        0                        0                        0                        0                        0                        0                        0
Allan Nordhøy                            allan@example.com                                               2                        5                       25                        4                       28                        2                        3                       24                        3                       21                        0                        0                        0                        0                        0                        0                        0                        0                        0                        0
======================================== ======================================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ======================== ========================

And it will get rendered as:

名前	Email	Count total	Source words total	Source chars total	Target words total	Target chars total	Count new	Source words new	Source chars new	Target words new	Target chars new	Count approved	Source words approved	Source chars approved	Target words approved	Target chars approved	Count edited	Source words edited	Source chars edited	Target words edited	Target chars edited
Michal Čihař	michal@cihar.com	1	3	24	3	21	1	3	24	3	21	0	0	0	0	0	0	0	0	0	0
Allan Nordhøy	allan@example.com	2	5	25	4	28	2	3	24	3	21	0	0	0	0	0	0	0	0	0	0

It can be useful if you pay your translators based on amount of work, it gives you various stats on translators work.

All stats are available in three variants:

Total

Overall number of edited strings.

New

Newly translated strings which didn't have translation before.

Approved

Count for string approvals in review workflow (see 専任の査読者).

Edited

Edited strings which had translation before.

The following metrics are available for each:

Count

Number of strings.

Edits

Number of edits in the string, measured in Damerau–Levenshtein distance.

Source words

Number of words in the source string.

Source characters

Number of characters in the source string.

Target words

Number of words in the translated string.

Target characters

Number of characters in the translated string.

Weblate に貢献

Weblate に貢献する方法はたくさんあります。コーディング、グラフィックデザイン、ドキュメンテーション、スポンサーシップなど、どのような援助も歓迎します:

• Weblate の問題の報告

• Weblate にコードの提供開始

• Weblate の翻訳

• Weblate 開発に資金提供

Weblate の翻訳

Weblate は、Weblate 自体を用いて 翻訳されています。できるだけ多くの人間の言語で Weblate を利用できるようにする取り組みに気軽に参加してください。

Weblate 開発に資金提供

donate page`_から Weblate の開発を前進させる資金を提供できます。集められた資金は、Libre ソフトウェア プロジェクトの無料ホスティング、および Weblate の開発を前進させるために使用されます。資金提供の目標や資金提供者への報酬などの詳細は `寄付ページ をご覧ください。

Weblate に資金提供した支援者

Weblate 支援者名簿:

• Yashiro Ccs

• Cheng-Chia Tseng

• Timon Reinhard

• Cassidy James

• Loic Dachary

• Marozed

• https://freedombox.org/

• GNU Solidario (GNU Health)

• BallotReady

支援者名簿に掲載しませんか？Weblate に寄付をする の選択から選んでください。

Weblate にコードの提供開始

Weblate のソース コードを理解するには、まず Weblate のソース コード、 Weblate フロントエンド、 Weblate の内部 を確認してください。

コードベースから始める

Weblate コードベースに慣れるためにバグを探しているなら、good first issue というラベルのついたものを探してください。

Weblate をローカルで実行

Weblate の開発を始める最も快適な方法は、Installing from sources に従うことです。編集可能な Weblate のソースを付属した仮想環境を入手します。

1. Weblate ソースのクローン：

   git clone https://github.com/WeblateOrg/weblate.git
   cd weblate
   

2. virtualenv の作成：

   virtualenv .venv
   .venv/bin/activate
   

3. Install Weblate (this will need some system deps, see Installing from sources):

   pip install -e .
   

3. 開発に便利な依存関係をすべてインストール：

   pip install -r requirements-dev.txt
   

4. 開発サーバーの実行開始：

   weblate runserver
   

5. 設定すると、Celery Worker を起動することもできます:

   ./weblate/examples/celery start
   

6. To run test (see Local testing for more details):

   . scripts/test-database
   ./manage.py test
   

参考

Installing from sources

Docker上でローカルに Weblate の実行

Docker と docker-compose をインストールしている場合は、以下を実行するだけで開発環境を起動できます。

./rundev.sh

開発用 Docker イメージを作成して起動します。Weblate は <http://127.0.0.1:8080/> で動作しており、admin ユーザと admin パスワードでサインインできます。新しいインストールは空なので、Adding translation projects and components に進んでください。

Dockerfile と docker-compose.yml は、dev-docker ディレクトリにあります。

スクリプトは、複数のパラメータを受け取り、テストを実行するために test パラメータを指定して実行し、次に test パラメータを指定します、たとえば:

./rundev.sh test --failfast weblate.trans

注釈

テストを実行する前に、Docker コンテナが稼働していることを確認してください。これは docker ps コマンドを実行して確認できます。

To display the logs:

./rundev.sh logs

バックグラウンド コンテナの実行を停止するには:

./rundev.sh stop

引数を指定せずにスクリプトを実行すると、Docker コンテナが再作成されて再起動します。

注釈

これは本番環境には適していません。安全とは言えないものの開発を容易にする複数のハックを含んでいます。

PyCharm による Weblate のコーディング

PyCharm は Python の IDE として知られていますが、この中に Weblate プロジェクトをセットアップするためのガイドラインがあります。

Github リポジトリをクローンした直後なので、PyCharm でクローンしたフォルダを開くだけです。IDE を開いたら、最初に必要なインタプリターを指定する:

PyCharm で virtualenv を作成するか、または既存の仮想環境を選択する:

インタープリターを設定したら、依存関係をインストールすることを忘れないでください:　依存関係は、コンソール（デフォルトでは、IDE のコンソールが virtualenv を直接使用する）からインストールします。また、依存関係が存在しない、という警告が表示されたときはインターフェースからインストールします。

2 番目のステップは、PyCharm 内でネイティブで Django を使用するための適切な情報の設定です:　このアイデアは、IDE でユニットテストを即座に起動できるようにすることです。そのために必要な、Django のルート パスの指定と設定用のパスの指定:

「Djangoプロジェクトのルート」 はリポジトリのルートであり、weblate のサブ ディレクトリではないことに注意してください。設定に関しては、個人的にはリポジトリの settings_test を使用していますが、独自の設定を作成してそこで設定することもできます。

最後のステップは、サーバーを実行して、コードにブレークポイントを設定してデバッグできること。そのための、新しい Django Server 設定の作成:

「再ロードなし」を理解した上で注意して設定してください:　ファイルを変更すると、サーバーのライブ リロードは行われなくなりますが、デバッガーは設定したブレークポイントで停止します。

開発者のインスタンスをブートストラップ

import_demo を使用してデモ翻訳を作成し、createadmin を使用して管理者ユーザーを作成できます。

Weblate のソース コード

Weblateは GitHub 上で開発しています。コードをフォークしてプル リクエストを開くことができます。他の形式のパッチも歓迎します。

参考

Weblate の内部 を確認して、Weblate の内部をどうなっているか調べてください。

セキュリティ設計原則

Weblate のコードはすべて、 セキュリティ設計原則 を念頭に記述しなければなりません。

コーディング規約

コードは PEP-8 コーディング ガイドラインに従い、black コード整形ツールを使用して書式設定する必要があります。

コードの品質を検査するには flake 8 を使用します。推奨プラグインの一覧は .pre-commit-config.yaml にあり、設定は:file:`setup.cfg`にあります。

これを実行する最も簡単な方法は、pre-commit インストールすることです。Webrate リポジトリには、コミットされたファイルが正常であることを確認するための設定が含まれています。インストール後（すでに requirements-lint.txt に含まれています）、Weblate のチェックアウトで pre-commit install を実行して有効にします。これにより、すべての変更が自動的に検査されます。

手動で検査を実行し、すべてのファイルの実行も検査する：

pre-commit run --all

Debugging Weblate

Bugs can behave as application crashes or as misbehavior. You are welcome to collect info on any such issue and submit it to the issue tracker.

デバッグモード

Turning on debug mode will make the exceptions show in the browser. This is useful to debug issues in the web interface, but not suitable for production environment as it has performance consequences and might leak private data.

参考

Disable debug mode

Weblate logs

Weblate can produce detailed logs of what is going in the background. In the default configuration it uses syslog and that makes the log appear either in /var/log/messages or /var/log/syslog (depending on your syslog daemon configuration).

The Celery process (see Background tasks using Celery) usually produces own logs as well. The example system-wide setups log to several files under /var/log/celery/.

Docker containers log to their output (as usual in the Docker world), so you can look at the logs using docker-compose logs.

参考

サンプル設定 contains LOGGING configuration.

Analyzing application crashes

In case the application crashes, it is useful to collect as much info about the crash as possible. The easiest way to achieve this is by using third-party services which can collect such info automatically. You can find info on how to set this up in Collecting error reports.

Silent failures

Lots of tasks are offloaded to Celery for background processing. Failures are not shown in the user interface, but appear in the Celery logs. Configuring Collecting error reports helps you to notice such failures easier.

Performance issues

In case Weblate performs badly in some situation, please collect the relevant logs showing the issue, and anything that might help figuring out where the code might be improved.

In case some requests take too long without any indication, you might want to install dogslow <https://pypi.org/project/dogslow/> along with Collecting error reports and get pinpointed and detailed tracebacks in the error collection tool.

Weblate の内部

注釈

この章では、Weblate 内部の基本的な概要を説明します。

Weblate はそのコード構造の大部分は Django をベースに作成しています。

ディレクトリ構造

Weblate メイン リポジトリのディレクトリ構造の概要:

docs

このドキュメントのソース コードは、Sphinx を使用して構築しています。

dev-docker

開発サーバを実行する Docker コード、参照 Docker上でローカルに Weblate の実行。

weblate

`Django<https://www.djangoproject.com/>`_ アプリケーションとしての Weblate のソース コード、参照 Weblate の内部。

weblate/static

クライアント ファイル（CSS、Javascript および画像）、参照 Weblate フロントエンド。

モジュール

Weblate は、複数の Django アプリケーションで構成されています（複数のオプション、参照 Optional Weblate modules）。

accounts

ユーザー アカウント、プロファイル、および通知。

addons

Weblate の動作の詳細設定用のアドオン、参照 アドオン。

api

Django REST framework をベースにした API。

auth

認証とアクセス権。

billing

オプションの 請求 モジュール。

checks

翻訳文字列の 品質検査 モジュール。

fonts

フォント レンダリング検査モジュール。

formats

translate-toolkit をベースにしたファイル形式抽象化レイヤー。

gitexport

オプションの Git exporter モジュール。

lang

言語と複数形のモデルを定義するモジュール。

legal

オプションの 法律上の告知事項 モジュール。

machinery

機械翻訳サービスの統合。

memory

内蔵の翻訳メモリ、参照 翻訳メモリ。

screenshots

スクリーンショット管理と OCR モジュール。

trans

翻訳を処理するメイン モジュール。

utils

複数のヘルパー ユーティリティ。

vcs

バージョン管理システムの抽象化。

wladmin

カスタマイズした Django の管理画面。

アドオンの開発

アドオン are way to customize localization workflow in Weblate.

class weblate.addons.base.BaseAddon(storage=None)

classmethod can_install(component, user)

アドオンが指定したコンポーネントと互換性があるかどうかを確認します。

configure(settings)

設定を保存します。

daily(component)

Hook triggered daily.

classmethod get_add_form(user, component, **kwargs)

新しいアドオンを追加するための設定フォームを返します。

get_settings_form(user, **kwargs)

このアドオンの設定フォームを返します。

post_add(translation)

新しい翻訳が追加された後にフックが実行されます。

post_commit(component)

変更がリポジトリにコミットされた後にフックが実行されます。

post_push(component)

リポジトリが upstream にプッシュされた後にフックが実行されます。

post_update(component, previous_head: str, skip_push: bool)

Hook triggered after repository is updated from upstream.

パラメータ

• previous_head (str) -- HEAD of the repository prior to update, can be blank on initial clone

• skip_push (bool) -- Whether the addon operation should skip pushing changes upstream. Usually you can pass this to underlying methods as commit_and_push or commit_pending.

pre_commit(translation, author)

変更がリポジトリにコミットされる前にフックが実行されます。

pre_push(component)

Hook triggered before repository is pushed upstream.

pre_update(component)

Hook triggered before repository is updated from upstream.

save_state()

アドオンの状態を保存します。

stay_on_create = False

Weblate アドオンの基本クラス。

store_post_load(translation, store)

ファイルを解析し、ストレージ クラスが構築された後にフックが実行されます。

unit_pre_create(unit)

新しいユニットが作成される前にフックが実行されます。

アドオンの例：

#
# Copyright © 2012 - 2020 Michal Čihař <michal@cihar.com>
#
# This file is part of Weblate <https://weblate.org/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#


from django.utils.translation import gettext_lazy as _

from weblate.addons.base import BaseAddon
from weblate.addons.events import EVENT_PRE_COMMIT


class ExampleAddon(BaseAddon):
    # Filter for compatible components, every key is
    # matched against property of component
    compat = {"file_format": {"po", "po-mono"}}
    # List of events addon should receive
    events = (EVENT_PRE_COMMIT,)
    # Addon unique identifier
    name = "weblate.example.example"
    # Verbose name shown in the user interface
    verbose = _("Example addon")
    # Detailed addon description
    description = _("This addon does nothing it is just an example.")

    # Callback to implement custom behavior
    def pre_commit(self, translation, author):
        return

Weblate フロントエンド

フロントエンドは、現在 Bootstrap、jQuery、およびサード パーティの数少ないライブラリを使用して構築されています。

依存関係の管理

yarn パッケージ マネージャーは、サード パーティのライブラリを更新するために使用します。設定は scripts/yarn にあり、これはライブラリを更新するラッパ スクリプト scripts/yarn-update であり、ビルドして正しい場所 weblate/static/vendor にコピーするためのものです。この場所には、すべてサードパーティーのフロントエンドのコードが配置されています。

コーディング スタイル

Weblate は、JavaScript ファイルと CSS ファイルの両方のコード フォーマットに `Prettier`_を使用しています。

また ESLint を使用して JavaScript コードを検査します。

現地語化

る：フロントエンドのコードでユーザーに表示するテキストが必要な場合は、現地語化ができる必要があります。ほとんどの場合、テキストを gettext 関数内でラップするだけだが、もっと複雑な機能も利用できる：

document.write(gettext('this is to be translated'));

var object_count = 1 // or 0, or 2, or 3, ...
s = ngettext('literal for the singular case',
        'literal for the plural case', object_count);

fmts = ngettext('There is %s object. Remaining: %s',
        'There are %s objects. Remaining: %s', 11);
s = interpolate(fmts, [11, 20]);
// s is 'There are 11 objects. Remaining: 20'

参考

Translation topic in the Django documentation

アイコン

Weblate では現在、マテリアルデザインのアイコンを使用しています。新しいアイコンをお探しの方は <https://materialdesignicons.com/> を確認してください。

また、ほとんどのアイコンが HTML に埋め込まれていて、パスをスタイルで設定できるため、SVG のサイズを小さくする :file:'scripts/optimize-svg' を用意しました。

Weblate の問題の報告

私たちの 課題管理ツール は GitHub で管理中：

Weblate の問題を報告や、改善を提案することを歓迎します。発見したものが Weblate のセキュリティ上の問題である場合は、下記の「セキュリティの問題」のセクションを参照してください。

セキュリティの問題

In order to give the community time to respond and upgrade you are strongly urged to report all security issues privately. HackerOne is used to handle security issues, and can be reported directly at HackerOne.

Alternatively, report to security@weblate.org, which ends up on HackerOne as well.

If you don't want to use HackerOne, for whatever reason, you can send the report by e-mail to michal@cihar.com. You can choose to encrypt it using this PGP key 3CB 1DF1 EF12 CF2A C0EE 5A32 9C27 B313 42B7 511D. You can also get the PGP key from Keybase.

注釈

Weblate depends on third party components for many things. In case you find a vulnerability affecting one of those components in general, please report it directly to the respective project.

Some of these are:

• Django

• Django REST framework

• Python Social Auth

Weblate testsuite and continuous integration

Testsuites exist for most of the current code, increase coverage by adding testcases for any new functionality, and verify that it works.

Continuous integration

Current test results can be found on GitHub Actions and coverage is reported on Codecov.

There are several jobs to verify different aspects:

• Unit tests

• Documentation build and external links

• Migration testing from all supported releases

• Code linting

• Setup verification (ensures that generated dist files do not miss anything and can be tested)

The configuration for the CI is in .github/workflows directory. It heavily uses helper scripts stored in ci directory. The scripts can be also executed manually, but they require several environment variables, mostly defining Django settings file to use and database connection. The example definition of that is in scripts/test-database:

# Simple way to configure test database from environment

# Database backend to use postgresql / mysql / mariadb
export CI_DATABASE=${1:-postgresql}

# Database server configuration
export CI_DB_USER=weblate
export CI_DB_PASSWORD=weblate
export CI_DB_HOST=127.0.0.1

# Django settings module to use
export DJANGO_SETTINGS_MODULE=weblate.settings_test

The simple execution can look like:

. scripts/test-database
./ci/run-migrate
./ci/run-test
./ci/run-docs
./ci/run-setup

Local testing

To run a testsuite locally, use:

DJANGO_SETTINGS_MODULE=weblate.settings_test ./manage.py test

ヒント

You will need a database (PostgreSQL) server to be used for tests. By default Django creates separate database to run tests with test_ prefix, so in case your settings is configured to use weblate, the tests will use test_weblate database. See Database setup for Weblate for setup instructions.

The weblate/settings_test.py is used in CI environment as well (see Continuous integration) and can be tuned using environment variables:

# Simple way to configure test database from environment

# Database backend to use postgresql / mysql / mariadb
export CI_DATABASE=${1:-postgresql}

# Database server configuration
export CI_DB_USER=weblate
export CI_DB_PASSWORD=weblate
export CI_DB_HOST=127.0.0.1

# Django settings module to use
export DJANGO_SETTINGS_MODULE=weblate.settings_test

Prior to running tests you should collect static files as some tests rely on them being present:

DJANGO_SETTINGS_MODULE=weblate.settings_test ./manage.py collectstatic

You can also specify individual tests to run:

DJANGO_SETTINGS_MODULE=weblate.settings_test ./manage.py test weblate.gitexport

ヒント

The tests can also be executed inside developer docker container, see Docker上でローカルに Weblate の実行.

参考

See Testing in Django for more info on running and writing tests for Django.

データ スキーマ

Weblate は JSON Schema to を使用して外部 JSON ファイルのレイアウトを定義します。

Weblate 翻訳メモリ概要

https://weblate.org/schemas/weblate-memory.schema.json
型	配列
項目	翻訳メモリの項目
	型	オブジェクト
	プロパティ
	category	文字列のカテゴリー
		1 = グローバル、2 = 共有、10000000 以上 = プロジェクト固有、20000000 以上 = ユーザ固有
		型	整数
		例	1
		最小	0
		デフォルト	1
	origin	文字列のオリジナル
		ファイル名またはコンポーネント名
		型	文字列
		例	test
		デフォルト
	source	原文
		型	文字列
		例	Hello
		minLength	1
		デフォルト
	source_language	原文の言語
		ISO 639-1 / ISO 639-2 / IETF BCP 47
		型	文字列
		例	en
		パターン	^[^ ]+$
		デフォルト
	target	翻訳対象の文字列
		型	文字列
		例	Ahoj
		minLength	1
		デフォルト
	target_language	翻訳対象の言語
		ISO 639-1 / ISO 639-2 / IETF BCP 47
		型	文字列
		例	cs
		パターン	^[^ ]+$
		デフォルト
	追加のプロパティ	False
定義

参考

翻訳メモリ、dump_memory、import_memory

Weblate ユーザー データのエクスポート

https://weblate.org/schemas/weblate-userdata.schema.json
型	オブジェクト
プロパティ
basic	基本
	型	オブジェクト
	プロパティ
	username	Username
		型	文字列
		例	管理者
		デフォルト
	full_name	フル ネーム
		型	文字列
		例	Weblate 管理者
		デフォルト
	email	メールアドレス
		型	文字列
		例	noreply@example.com
		デフォルト
	date_joined	登録日
		型	文字列
		例	2019-11-18T18:53:54.862Z
		デフォルト
profile	プロフィール
	型	オブジェクト
	プロパティ
	language	言語
		型	文字列
		例	cs
		パターン	^.*$
		デフォルト
	suggested	提案された文字列の数
		型	整数
		例	1
		デフォルト	0
	translated	翻訳済み文字列の数
		型	整数
		例	24
		デフォルト	0
	uploaded	アップロードされたスクリーンショットの数
		型	整数
		例	1
		デフォルト	0
	hide_completed	完了した翻訳をダッシュボードで非表示にする
		型	boolean
		例	False
		デフォルト	True
	secondary_in_zen	Zen モードで参考言語を表示する
		型	boolean
		例	True
		デフォルト	True
	hide_source_secondary	参考言語の翻訳がある場合は原文を表示しない
		型	boolean
		例	False
		デフォルト	True
	editor_link	エディタ リンク
		型	文字列
		例
		パターン	^.*$
		デフォルト
	translate_mode	翻訳エディタ モード
		型	整数
		例	0
		デフォルト	0
	zen_mode	Zen 編集モード
		型	整数
		例	0
		デフォルト	0
	special_chars	特殊文字
		型	文字列
		例
		パターン	^.*$
		デフォルト
	dashboard_view	デフォルトのダッシュボード画面
		型	整数
		例	1
		デフォルト	0
	dashboard_component_list	デフォルトのコンポーネント リスト
		デフォルト	なし
		どちらか	型	null
			型	整数
	languages	翻訳言語
		型	配列
		デフォルト
		項目	言語コード
			型	文字列
			例	cs
パターン			^.*$
デフォルト
secondary_languages	参考言語
	型	配列
	デフォルト
	項目	言語コード
		型	文字列
		例	sk
		パターン	^.*$
		デフォルト
watched	監視中のプロジェクト
	型	配列
	デフォルト
	項目	プロジェクトのスラッグ
		型	文字列
		例	weblate
		パターン	^.*$
		デフォルト
auditlog	監査ログ
	型	配列
	デフォルト
	項目	項目
		型	オブジェクト
		プロパティ
		address	IP アドレス
			型	文字列
			例	127.0.0.1
			パターン	^.*$
			デフォルト
		user_agent	ユーザー エージェント
			型	文字列
			例	PC / Linux / Firefox 70.0
			パターン	^.*$
			デフォルト
		timestamp	タイムスタンプ
			型	文字列
			例	2019-11-18T18:58:30.845Z
			パターン	^.*$
			デフォルト
		activity	作業履歴
			型	文字列
			例	ログイン
			パターン	^.*$
			デフォルト
定義

参考

ユーザー情報、dumpuserdata

Weblate のリリース

リリース スケジュール

Weblate has two month release cycle for releases (x.y). These are usually followed by a bunch of bugfix releases to fix issues which slip into them (x.y.z).

The change in the major version indicates that the upgrade process can not skip this version - you always have to upgrade to x.0 before upgrading to higher x.y releases.

参考

Upgrading Weblate

Release planning

The features for upcoming releases are collected using GitHub milestones, you can see our roadmap at <https://github.com/WeblateOrg/weblate/milestones>.

Release process

リリース前に確認すること:

1. ./scripts/list-translated-languages で新規に翻訳された言語の確認。

2. ./scripts/prepare-release で最終バージョンの設定。

3. スクリーンショットが最新であるかの確認 make -C docs update-screenshots。

リリースの実行:

4. リリースの作成 ./scripts/create-release --tag （必須条件は下記を参照）。

リリース後の手動手順:

5. Docker イメージの更新。

6. GitHub のマイルストーンを閉じる。

7. Docker イメージをテストしたら、タグを追加してプッシュする。

8. Helm チャートを新バージョンに更新。

9. .github/workflows/migrations.yml に新しいバージョンをインクルードして、移行テストでカバーする。

10. リポジトリのバージョンを ./scripts/set-version で上げる。

./scripts/create-release スクリプトを使用してタグを作成するには、次のものが必要です。

• リリースの署名に使用する秘密鍵を持つ GnuPG

• Weblate git リポジトリへの push 接続（タグを push）

• hub ツールを設定し、Weblate リポジトリに接続してリリースの作成

• Weblate ダウンロード サーバーへ SSH 接続（Web サイトのダウンロードは、そこにコピーされます）

Weblate について

プロジェクトの目標

Web-based continuous localization tool with tight バージョン管理の統合 supporting a wide range of Supported file formats, making it easy for translators to contribute.

プロジェクト名

"Weblate" は、"web" と "translate" を組み合わせた単語です。

プロジェクトの Web サイト

ランディング ページは <https://weblate.org/>、クラウド ホスト サービスは <https://hosted.weblate.org/> です。ドキュメントは <https://docs.weblate.org/> にあります。

プロジェクトのロゴ

プロジェクトのロゴとその他のグラフィックは、<https://github.com/WeblateOrg/graphics/> のリポジトリから入手できます。

管理者

このプロジェクトは Michal Čihař <michal@cihar.com> によって管理されています。

開発者

Weblate は Michal Čihař <michal@cihar.com> が始めました。2012 年の開設以来、何千人もの人が貢献しています。

ライセンス

Copyright (C) 2012 - 2020 Michal Čihař <michal@cihar.com>

このプログラムはフリーソフトウェアです:　あなたは、FreeSoftware Foundation によって発行された GNU General Public License のバージョン 3 または（あなたの選択で）それ以降のバージョンのいずれかの条件のもとで、プログラムの再配布または変更ができます。

このプログラムは有用であることを願って配布していますが、いかなる保証もありません。商品性や特定目的への適合性の暗黙の保証もありません。詳細は GNU General Public License を参照してください。

あなたは、このプログラムと共に、GNU General Public License のコピーを受け取っているはずです。そうでない場合は、<https://www.gnu.org/licenses/>を参照してください。

Weblate 4.4

Released on December 15th 2020.

• Improved validation when creating component.

• Weblate now requires Django 3.1.

• 管理インターフェイスで外観の変更の対応を追加。

• Fixed read only state handling in bulk edit.

• CodeMirror の統合の改善。

• 翻訳ファイルから空白の文字列を削除するアドオンの追加。

• コードミラー エディタを翻訳に使用するようにしました。

• Syntax highlighting in translation editor for XML, HTML, Markdown and reStructuredText.

• 翻訳エディタで配置可能を強調表示。

• Improved support for non standard language codes.

• あいまいな言語コードを使用する場合の警告の追加。

• User is now presented filtered list of languages when adding new translation.

• Extended search capabilities for changes history.

• Improved billing detail pages and libre hosting workflow.

• 翻訳統計 API の拡張。

• 翻訳中の他の翻訳タブの改善。

• Added tasks API.

• ファイル アップロードのパフォーマンスの向上。

• Improved display of user defined special characters.

• Improved auto translate performance.

• Several minor user interface improvements.

• Improved naming of ZIP downloads.

• Added option for getting notifications on unwatched projects.

Weblate 4.3.2

Released on November 4th 2020.

• Fixed crash on certain component filemasks.

• 連続重複語検査の精度向上。

• Pagure のプル リクエストの対応の追加。

• Improved error messages on failed registraiton.

• Reverted rendering developer comments as markdown.

• Simplified setup of Git repositories with different default branch than master.

• Newly created internal repositories now use main as default branch.

• reStructuredText を翻訳中の、未変更の翻訳の誤検知の減少。

• Fixed CodeMirror display issues in some situations.

• Renamed Template group to Sources to clarify its meaning.

• Fixed GitLab pull requests on repos with longer path.

Weblate 4.3.1

Released on October 21st 2020.

• 自動翻訳の性能の改善。

• 認証したユーザーのセッションの有効期限の修正。

• バージョン情報の非表示の対応の追加。

• Improve hooks compatibility with Bitbucket Server.

• 翻訳メモリの機能拡張と改善。

• Reduced memory usage.

• 対応表の表示機能の改善。

• プロジェクトからユーザーを削除する前の確認を追加。

Weblate 4.3

Released on October 15th 2020.

• Include user stats in the API.

• Fixed component ordering on paginated pages.

• Define source language for a glossary.

• Rewritten support for GitHub and GitLab pull requests.

• 提案を削除した後の統計カウントを修正しました。

• 公開ユーザー情報を拡張しました。

• Fixed configuration of enforced checks.

• Improve documentation about built-in backups.

• Moved source language attribute from project to a component.

• Vue I18n 書式の検査の追加。

• Generic placeholders check now supports regular expressions.

• Improved look of matrix mode.

• 機械翻訳を、新しく自動提案と命名。

• Added support for interacting with multiple GitLab or GitHub instances.

• Extended API to cover project updates, unit updates and removals and glossaries.

• Unit API now properly handles plural strings.

• Component creation can now handle ZIP file or document upload.

• Consolidated API response status codes.

• 貢献者同意条項の markdown のサポート。

• 原文の記録を改善した。

• Improved JSON, YAML and CSV formats compatibility.

• 文字列の削除に対応。

• Improved performance of file downloads.

• Improved repository management view.

• Automatically enable java-format for Android.

• 翻訳に合わせたスクリーンショットに対応。

• Python 3.9 に対応。

• Fixed translating HTML files under certain conditions.

Weblate 4.2.2

Released on September 2nd 2020.

• JSON 形式の原文の一致を修正しました。

• Fixed login redirect for some authentication configurations.

• Fixed LDAP authentication with group sync.

• 自動翻訳の進行状況のレポートのクラッシュを修正しました。

• Fixed Git commit squashing with trailers enabled.

• Fixed creating local VCS components using API.

Weblate 4.2.1

Released on August 21st 2020.

• Fixed saving plurals for some locales in Android resources.

• Fixed crash in the cleanup addon for some XLIFF files.

• Allow to configure localization CDN in Docker image.

Weblate 4.2

Released on August 18th 2020.

• Improved user pages and added listing of users.

• Dropped support for migrating from 3.x releases, migrate through 4.1 or 4.0.

• Added exports into several monolingual formats.

• Improved activity charts.

• Number of displayed nearby strings can be configured.

• リポジトリエラーが発生するコンポーネントをロックするためのサポートを追加しました。

• Simplified main navigation (replaced buttons with icons).

• Improved language code handling in Google Translate integration.

• The Git squash addon can generate Co-authored-by: trailers.

• Improved query search parser.

• Improved user feedback from format strings checks.

• Improved performance of bulk state changes.

• Added compatibility redirects after project or component renaming.

• Added notifications for strings approval, component locking and license change.

• Added support for ModernMT.

• Allow to avoid overwriting approved translations on file upload.

• Dropped support for some compatibility URL redirects.

• ECMAScript テンプレート リテラルの検査を追加しました。

• コンポーネントを監視するオプションを追加しました。

• Removed leading dot from JSON unit keys.

• 翻訳メモリ用の個別の Celery キューを削除しました。

• すべてのコンポーネントを一度に言語を翻訳できるようにします。

• Allow to configure Content-Security-Policy HTTP headers.

• Added support for aliasing languages at project level.

• New addon to help with HTML or JavaScript localization, see JavaScript 現地語化 CDN.

• The Weblate domain is now configured in the settings, see SITE_DOMAIN.

• コンポーネントおよびプロジェクトによる検索のサポートを追加。

Weblate 4.1.1

Released on June 19th 2020.

• Fixed changing autofix or addons configuration in Docker.

• Fixed possible crash in "About" page.

• Improved installation of byte-compiled locale files.

• Fixed adding words to glossary.

• Fixed keyboard shortcuts for machinery.

• Removed debugging output causing discarding log events in some setups.

• Fixed lock indication on project listing.

• Fixed listing GPG keys in some setups.

• Added option for which DeepL API version to use.

• Added support for acting as SAML Service Provider, see SAML authentication.

Weblate 4.1

Released on June 15th 2020.

• Added support for creating new translations with included country code.

• Added support for searching source strings with screenshot.

• Extended info available in the stats insights.

• Improved search editing on "Translate" pages.

• Improve handling of concurrent repository updates.

• Include source language in project creation form.

• Include changes count in credits.

• Fixed UI language selection in some cases.

• Allow to whitelist registration methods with registrations closed.

• Improved lookup of related terms in glossary.

• Improved translation memory matches.

• Group same machinery results.

• Add direct link to edit screenshot from translate page.

• Improved removal confirmation dialog.

• Include templates in ZIP download.

• Add support for Markdown and notification configuration in announcements.

• Extended details in check listings.

• 新しいファイル形式のサポートを追加した: Laravel PHP 文字列、HTML files、OpenDocument Format、IDML Format、Windows RC files、INI translations、Inno Setup INI の翻訳、GWT properties、go-i18n JSON files、ARB File。

• Consistently use dismissed as state of dismissed checks.

• Add support for configuring default addons to enable.

• Fixed editor keyboard shortcut to dismiss checks.

• Improved machine translation of strings with placeholders.

• Show ghost translation for user languages to ease starting them.

• Improved language code parsing.

• Show translations in user language first in the list.

• Renamed shapings to more generic name variants.

• Added new quality checks: 複数の無名変数, 長期間未翻訳, 重複単語の連続.

• Reintroduced support for wiping translation memory.

• Fixed option to ignore source checks.

• Added support for configuring different branch for pushing changes.

• API now reports rate limiting status in the HTTP headers.

• Added support for Google Translate V3 API (Advanced).

• Added ability to restrict access on component level.

• Added support for whitespace and other special chars in translation flags, see 動作のカスタマイズ.

• Always show rendered text check if enabled.

• API now supports filtering of changes.

• Added support for sharing glossaries between projects.

Weblate 4.0.4

Released on May 07th 2020.

• Fixed testsuite execution on some Python 3.8 environments.

• Typo fixes in the documentation.

• Fixed creating components using API in some cases.

• Fixed JavaScript errors breaking mobile navigation.

• Fixed crash on displaying some checks.

• Fixed screenshots listing.

• Fixed monthly digest notifications.

• Fixed intermediate translation behavior with units non existing in translation.

Weblate 4.0.3

Released on May 02nd 2020.

• Fixed possible crash in reports.

• User mentions in comments are now case insensitive.

• Fixed PostgreSQL migration for non superusers.

• Fixed changing the repository URL while creating component.

• Fixed crash when upstream repository is gone.

Weblate 4.0.2

Released on April 27th 2020.

• Improved performance of translation stats.

• Improved performance of changing labels.

• Improved bulk edit performance.

• Improved translation memory performance.

• Fixed possible crash on component deletion.

• Fixed displaying of translation changes in some corner cases.

• Improved warning about too long celery queue.

• Fixed possible false positives in the consistency check.

• Fixed deadlock when changing linked component repository.

• Included edit distance in changes listing and CSV and reports.

• Avoid false positives of punctuation spacing check for Canadian French.

• Fixed XLIFF export with placeholders.

• Fixed false positive with zero width check.

• Improved reporting of configuration errors.

• Fixed bilingual source upload.

• Automatically detect supported languages for DeepL machine translation.

• Fixed progress bar display in some corner cases.

• Fixed some checks triggering on non translated strings.

Weblate 4.0.1

Released on April 16th 2020.

• Fixed package installation from PyPI.

Weblate 4.0

Released on April 16th 2020.

• Weblate now requires Python 3.6 or newer.

• Added management overview of component alerts.

• Added component alert for broken repository browser URLs.

• Improved sign in and registration pages.

• Project access control and workflow configuration integrated to project settings.

• Added check and highlighter for i18next interpolation and nesting.

• Added check and highlighter for percent placeholders.

• 検査で不合格となった提案を表示する。

• Record source string changes in history.

• Upgraded Microsoft Translator to version 3 API.

• Reimplemented translation memory backend.

• Added support for several is: lookups in 検索.

• Allow to make 未翻訳の翻訳文 avoid internal blacklist.

• Improved comments extraction from monolingual po files.

• Renamed whiteboard messages to announcements.

• Fixed occasional problems with registration mails.

• Improved LINGUAS update addon to handle more syntax variants.

• Fixed editing monolingual XLIFF source file.

• Added support for exact matching in 検索.

• スクリーンショット、ユーザー、グループ、コンポーネント リストのセット、および拡張した作成プロジェクトをカバーする拡張 API。

• Add support for source upload on bilingual translations.

• Added support for intermediate language from developers.

• Added support for source strings review.

• Extended download options for platform wide translation memory.

Weblate 3.x series

Weblate 3.11.3

Released on March 11th 2020.

• Fixed searching for fields with certain priority.

• Fixed predefined query for recently added strings.

• Fixed searching returning duplicate matches.

• Fixed notifications rendering in Gmail.

• Fixed reverting changes from the history.

• Added links to events in digest notifications.

• Fixed email for account removal confirmation.

• Added support for Slack authentication in Docker container.

• Avoid sending notifications for not subscribed languages.

• Include Celery queues in performance overview.

• Fixed documentation links for addons.

• 未翻訳の翻訳検査の誤検知を減らしました。

• Raised bleach dependency to address CVE-2020-6802.

• Fixed listing project level changes in history.

• Fixed stats invalidation in some corner cases.

• Fixed searching for certain string states.

• Improved format string checks behavior on missing percent.

• Fixed authentication using some third party providers.

Weblate 3.11.2

Released on February 22nd 2020.

• Fixed rendering of suggestions.

• Fixed some strings wrongly reported as having no words.

Weblate 3.11.1

Released on February 20th 2020.

• Documented Celery setup changes.

• Improved filename validation on component creation.

• Fixed minimal versions of some dependencies.

• Fixed adding groups with certain Django versions.

• Fixed manual pushing to upstream repository.

• Improved glossary matching.

Weblate 3.11

Released on February 17th 2020.

• Allow using VCS push URL during component creation via API.

• Rendered width check now shows image with the render.

• Fixed links in notifications e-mails.

• Improved look of plaintext e-mails.

• Display ignored checks and allow to make them active again.

• Display nearby keys on monolingual translations.

• 文字列整形のグループ化のサポートを追加しました。

• Recommend upgrade to new Weblate versions in the system checks.

• Provide more detailed analysis for duplicate language alert.

• Include more detailed license info on the project pages.

• Automatically unshallow local copies if needed.

• Fixed download of strings needing action.

• New alert to warn about using the same filemask twice.

• Improve XML placeables extraction.

• The SINGLE_PROJECT can now enforce redirection to chosen project.

• Added option to resolve comments.

• Added bulk editing of flags.

• Added support for String labels.

• Added bulk edit addon.

• Added option for 検査の強制.

• Increased default validity of confirmation links.

• Improved Matomo integration.

• Fixed 翻訳済み to correctly handle source string change.

• Extended automatic updates configuration by AUTO_UPDATE.

• LINGUAS addons now do full sync of translations in Weblate.

Weblate 3.10.3

Released on January 18th 2020.

• Support for translate-toolkit 2.5.0.

Weblate 3.10.2

Released on January 18th 2020.

• Add lock indication to projects.

• Fixed CSS bug causing flickering in some web browsers.

• Fixed searching on systems with non-English locales.

• Improved repository matching for GitHub and Bitbucket hooks.

• Fixed data migration on some Python 2.7 installations.

• Allow configuration of Git shallow cloning.

• Improved background notification processing.

• Fixed broken form submission when navigating back in web browser.

• New addon to configure YAML formatting.

• Fixed same plurals check to not fire on single plural form languages.

• Fixed regex search on some fields.

Weblate 3.10.1

Released on January 9th 2020.

• Extended API with translation creation.

• Fixed several corner cases in data migrations.

• Compatibility with Django 3.0.

• Improved data cleanup performance.

• Added support for customizable security.txt.

• Improved breadcrumbs in changelog.

• Improved translations listing on dashboard.

• Improved HTTP responses for webhooks.

• Added support for GitLab merge requests in Docker container.

Weblate 3.10

Released on December 20th 2019.

• Improved application user interface.

• Added doublespace check.

• Fixed creating new languages.

• Avoid sending auditlog notifications to deleted e-mails.

• Added support for read only strings.

• Added support for Markdown in comments.

• Allow placing translation instruction text in project info.

• Add copy to clipboard for secondary languages.

• Improved support for Mercurial.

• Improved Git repository fetching performance.

• Add search lookup for age of string.

• Show source language for all translations.

• Show context for nearby strings.

• Added support for notifications on repository operations.

• Improved translation listings.

• Extended search capabilities.

• Added support for automatic translation strings marked for editing.

• Avoid sending duplicate notifications for linked component alerts.

• Improve default merge request message.

• Better indicate string state in Zen mode.

• Added support for more languages in Yandex Translate.

• Improved look of notification e-mails.

• Provide choice for translation license.

Weblate 3.9.1

Released on October 28th 2019.

• Remove some unneeded files from backups.

• Fixed potential crash in reports.

• Fixed cross database migration failure.

• Added support for force pushing Git repositories.

• Reduced risk of registration token invalidation.

• Fixed account removal hitting rate limiter.

• Added search based on priority.

• Fixed possible crash on adding strings to JSON file.

• Safe HTML check and fixup now honor source string markup.

• Avoid sending notifications to invited and deleted users.

• Fix SSL connection to redis in Celery in Docker container.

Weblate 3.9

Released on October 15th 2019.

• Include Weblate metadata in downloaded files.

• Improved UI for failing checks.

• Indicate missing strings in format checks.

• Separate check for French punctuation spacing.

• Add support for fixing some of quality checks errors.

• Add separate permission to create new projects.

• Extend stats for char counts.

• Improve support for Java style language codes.

• Added new generic check for placeholders.

• Added support for WebExtension JSON placeholders.

• Added support for flat XML format.

• Extended API with project, component and translation removal and creation.

• Added support for Gitea and Gitee webhooks.

• Added new custom regex based check.

• Allow to configure contributing to shared translation memory.

• Added ZIP download for more translation files.

• Make XLIFF standard compliant parsing of maxwidth and font.

• Added new check and fixer for safe HTML markup for translating web applications.

• Add component alert on unsupported configuration.

• Added automatic translation addon to bootstrap translations.

• Extend automatic translation to add suggestions.

• Display addon parameters on overview.

• Sentry is now supported through modern Sentry SDK instead of Raven.

• Changed example settings to be better fit for production environment.

• Added automated backups using BorgBackup.

• Split cleanup addon for RESX to avoid unwanted file updates.

• Added advanced search capabilities.

• Allow users to download their own reports.

• Added localization guide to help configuring components.

• Added support for GitLab merge requests.

• Improved display of repository status.

• Perform automated translation in the background.

Weblate 3.8

Released on August 15th 2019.

• Added support for simplified creating of similar components.

• Added support for parsing translation flags from the XML based file formats.

• Log exceptions into Celery log.

• Improve performance of repository scoped addons.

• Improved look of notification e-mails.

• Fixed password reset behavior.

• Improved performance on most of translation pages.

• Fixed listing of languages not known to Weblate.

• Add support for cloning addons to discovered components.

• Add support for replacing file content with uploaded.

• Add support for translating non VCS based content.

• Added OpenGraph widget image to use on social networks.

• Added support for animated screenshots.

• Improved handling of monolingual XLIFF files.

• Avoid sending multiple notifications for single event.

• Add support for filtering changes.

• Extended predefined periods for reporting.

• Added webhook support for Azure Repos.

• New opt-in notifications on pending suggestions or untranslated strings.

• Add one click unsubscribe link to notification e-mails.

• Fixed false positives with Has been translated check.

• New management interface for admins.

• String priority can now be specified using flags.

• Added language management views.

• Add checks for Qt library and Ruby format strings.

• Added configuration to better fit single project installations.

• Notify about new string on source string change on monolingual translations.

• Added separate view for translation memory with search capability.

Weblate 3.7.1

Released on June 28th 2019.

• Documentation updates.

• Fixed some requirements constraints.

• Updated language database.

• Localization updates.

• Various user interface tweaks.

• Improved handling of unsupported but discovered translation files.

• More verbosely report missing file format requirements.

Weblate 3.7

Released on June 21st 2019.

• Added separate Celery queue for notifications.

• Use consistent look with application for API browsing.

• Include approved stats in the reports.

• Report progress when updating translation component.

• Allow to abort running background component update.

• Extend template language for filename manipulations.

• Use templates for editor link and repository browser URL.

• Indicate max length and current characters count when editing translation.

• 未翻訳の翻訳検査での省略形の処理を改善しました。

• Refreshed landing page for new contributors.

• Add support for configuring msgmerge addon.

• Delay opening SMTP connection when sending notifications.

• Improved error logging.

• Allow custom location in MO generating addon.

• Added addons to cleanup old suggestions or comments.

• Added option to enable horizontal mode in the Zen editor.

• Improved import performance with many linked components.

• Fixed examples installation in some cases.

• Improved rendering of alerts in changes.

• Added new horizontal stats widget.

• Improved format strings check on plurals.

• Added font management tool.

• New check for rendered text dimensions.

• Added support for subtitle formats.

• Include overall completion stats for languages.

• Added reporting at project and global scope.

• Improved user interface when showing translation status.

• New Weblate logo and color scheme.

• New look of bitmap badges.

Weblate 3.6.1

Released on April 26th 2019.

• Improved handling of monolingual XLIFF files.

• Fixed digest notifications in some corner cases.

• Fixed addon script error alert.

• Fixed generating MO file for monolingual PO files.

• Fixed display of uninstalled checks.

• Indicate administered projects on project listing.

• Allow update to recover from missing VCS repository.

Weblate 3.6

Released on April 20th 2019.

• Add support for downloading user data.

• Addons are now automatically triggered upon installation.

• Improved instructions for resolving merge conflicts.

• Cleanup addon is now compatible with app store metadata translations.

• Configurable language code syntax when adding new translations.

• Warn about using Python 2 with planned termination of support in April 2020.

• Extract special characters from the source string for visual keyboard.

• Extended contributor stats to reflect both source and target counts.

• Admins and consistency addons can now add translations even if disabled for users.

• Fixed description of toggle disabling Language-Team header manipulation.

• Notify users mentioned in comments.

• Removed file format autodetection from component setup.

• Fixed generating MO file for monolingual PO files.

• Added digest notifications.

• Added support for muting component notifications.

• Added notifications for new alerts, whiteboard messages or components.

• Notifications for administered projects can now be configured.

• Improved handling of three letter language codes.

Weblate 3.5.1

Released on March 10th 2019.

• Fixed Celery systemd unit example.

• Fixed notifications from HTTP repositories with login.

• Fixed race condition in editing source string for monolingual translations.

• Include output of failed addon execution in the logs.

• Improved validation of choices for adding new language.

• Allow to edit file format in component settings.

• Update installation instructions to prefer Python 3.

• Performance and consistency improvements for loading translations.

• Make Microsoft Terminology service compatible with current Zeep releases.

• Localization updates.

Weblate 3.5

Released on March 3rd 2019.

• Improved performance of built-in translation memory.

• Added interface to manage global translation memory.

• Improved alerting on bad component state.

• Added user interface to manage whiteboard messages.

• Addon commit message now can be configured.

• Reduce number of commits when updating upstream repository.

• Fixed possible metadata loss when moving component between projects.

• Improved navigation in the Zen mode.

• Added several new quality checks (Markdown related and URL).

• Added support for app store metadata files.

• Added support for toggling GitHub or Gerrit integration.

• Kashida 文字の検査の追加。

• Added option to squash commits based on authors.

• Improved support for XLSX file format.

• Compatibility with Tesseract 4.0.

• Billing addon now removes projects for unpaid billings after 45 days.

Weblate 3.4

Released on January 22nd 2019.

• Added support for XLIFF placeholders.

• Celery can now utilize multiple task queues.

• Added support for renaming and moving projects and components.

• Include characters counts in reports.

• Added guided adding of translation components with automatic detection of translation files.

• Customizable merge commit messages for Git.

• Added visual indication of component alerts in navigation.

• Improved performance of loading translation files.

• New addon to squash commits prior to push.

• Improved displaying of translation changes.

• Changed default merge style to rebase and made that configurable.

• Better handle private use subtags in language code.

• Improved performance of fulltext index updates.

• Extended file upload API to support more parameters.

Weblate 3.3

Released on November 30th 2018.

• Added support for component and project removal.

• Improved performance for some monolingual translations.

• Added translation component alerts to highlight problems with a translation.

• Expose XLIFF string resname as context when available.

• Added support for XLIFF states.

• Added check for non writable files in DATA_DIR.

• Improved CSV export for changes.

Weblate 3.2.2

Released on October 20th 2018.

• Remove no longer needed Babel dependency.

• Updated language definitions.

• Improve documentation for addons, LDAP and Celery.

• Fixed enabling new dos-eol and auto-java-messageformat flags.

• Fixed running setup.py test from PyPI package.

• Improved plurals handling.

• Fixed translation upload API failure in some corner cases.

• Fixed updating Git configuration in case it was changed manually.

Weblate 3.2.1

Released on October 10th 2018.

• Document dependency on backports.csv on Python 2.7.

• Fix running tests under root.

• Improved error handling in gitexport module.

• Fixed progress reporting for newly added languages.

• Correctly report Celery worker errors to Sentry.

• Fixed creating new translations with Qt Linguist.

• Fixed occasional fulltext index update failures.

• Improved validation when creating new components.

• Added support for cleanup of old suggestions.

Weblate 3.2

Released on October 6th 2018.

• Add install_addon management command for automated addon installation.

• Allow more fine grained ratelimit settings.

• Added support for export and import of Excel files.

• Improve component cleanup in case of multiple component discovery addons.

• Rewritten Microsoft Terminology machine translation backend.

• Weblate now uses Celery to offload some processing.

• Improved search capabilities and added regular expression search.

• Added support for Youdao Zhiyun API machine translation.

• Added support for Baidu API machine translation.

• Integrated maintenance and cleanup tasks using Celery.

• Improved performance of loading translations by almost 25%.

• Removed support for merging headers on upload.

• Removed support for custom commit messages.

• Configurable editing mode (zen/full).

• Added support for error reporting to Sentry.

• Added support for automated daily update of repositories.

• Added support for creating projects and components by users.

• Built in translation memory now automatically stores translations done.

• Users and projects can import their existing translation memories.

• Better management of related strings for screenshots.

• Added support for checking Java MessageFormat.

See 3.2 milestone on GitHub for detailed list of addressed issues.

Weblate 3.1.1

Released on July 27th 2018.

• Fix testsuite failure on some setups.

Weblate 3.1

Released on July 27th 2018.

• Upgrades from older version than 3.0.1 are not supported.

• Allow to override default commit messages from settings.

• Improve webhooks compatibility with self hosted environments.

• Added support for Amazon Translate.

• Compatibility with Django 2.1.

• Django system checks are now used to diagnose problems with installation.

• Removed support for soon shutdown libravatar service.

• 未翻訳の翻訳を、編集が必要なものとしてマークするための新しいアドオン。

• Add support for jumping to specific location while translating.

• Downloaded translations can now be customized.

• Improved calculation of string similarity in translation memory matches.

• Added support by signing Git commits by GnuPG.

Weblate 3.0.1

Released on June 10th 2018.

• Fixed possible migration issue from 2.20.

• Localization updates.

• Removed obsolete hook examples.

• Improved caching documentation.

• Fixed displaying of admin documentation.

• Improved handling of long language names.

Weblate 3.0

Released on June 1st 2018.

• Rewritten access control.

• Several code cleanups that lead to moved and renamed modules.

• New addon for automatic component discovery.

• The import_project management command has now slightly different parameters.

• Added basic support for Windows RC files.

• New addon to store contributor names in PO file headers.

• The per component hook scripts are removed, use addons instead.

• Add support for collecting contributor agreements.

• Access control changes are now tracked in history.

• New addon to ensure all components in a project have same translations.

• Support for more variables in commit message templates.

• Add support for providing additional textual context.

Weblate 2.x series

Weblate 2.20

Released on April 4th 2018.

• Improved speed of cloning subversion repositories.

• Changed repository locking to use third party library.

• Added support for downloading only strings needing action.

• Added support for searching in several languages at once.

• New addon to configure gettext output wrapping.

• New addon to configure JSON formatting.

• Added support for authentication in API using RFC 6750 compatible Bearer authentication.

• Added support for automatic translation using machine translation services.

• Added support for HTML markup in whiteboard messages.

• Added support for mass changing state of strings.

• Translate-toolkit at least 2.3.0 is now required, older versions are no longer supported.

• Added built in translation memory.

• ダッシュボードおよびコンポーネント リストのセットの概要ページにコンポーネント リストの概要を追加した。

• Added support for DeepL machine translation service.

• Machine translation results are now cached inside Weblate.

• コミットされた変更の並び替えのサポートを追加しました。

Weblate 2.19.1

Released on February 20th 2018.

• Fixed migration issue on upgrade from 2.18.

• Improved file upload API validation.

Weblate 2.19

Released on February 15th 2018.

• Fixed imports across some file formats.

• Display human friendly browser information in audit log.

• Added TMX exporter for files.

• Various performance improvements for loading translation files.

• Added option to disable access management in Weblate in favor of Django one.

• Improved glossary lookup speed for large strings.

• Compatibility with django_auth_ldap 1.3.0.

• Configuration errors are now stored and reported persistently.

• Honor ignore flags in whitespace autofixer.

• Improved compatibility with some Subversion setups.

• Improved built in machine translation service.

• Added support for SAP Translation Hub service.

• Added support for Microsoft Terminology service.

• Removed support for advertisement in notification e-mails.

• Improved translation progress reporting at language level.

• Improved support for different plural formulas.

• Added support for Subversion repositories not using stdlayout.

• Added addons to customize translation workflows.

Weblate 2.18

Released on December 15th 2017.

• Extended contributor stats.

• Improved configuration of special characters virtual keyboard.

• Added support for DTD file format.

• Changed keyboard shortcuts to less likely collide with browser/system ones.

• Improved support for approved flag in XLIFF files.

• Added support for not wrapping long strings in gettext PO files.

• Added button to copy permalink for current translation.

• Dropped support for Django 1.10 and added support for Django 2.0.

• Removed locking of translations while translating.

• Added support for adding new strings to monolingual translations.

• Added support for translation workflows with dedicated reviewers.

Weblate 2.17.1

Released on October 13th 2017.

• Fixed running testsuite in some specific situations.

• Locales updates.

Weblate 2.17

Released on October 13th 2017.

• Weblate by default does shallow Git clones now.

• Improved performance when updating large translation files.

• Added support for blocking certain e-mails from registration.

• Users can now delete their own comments.

• Added preview step to search and replace feature.

• Client side persistence of settings in search and upload forms.

• Extended search capabilities.

• More fine grained per project ACL configuration.

• Default value of BASE_DIR has been changed.

• Added two step account removal to prevent accidental removal.

• Project access control settings is now editable.

• Added optional spam protection for suggestions using Akismet.

Weblate 2.16

Released on August 11th 2017.

• Various performance improvements.

• Added support for nested JSON format.

• Added support for WebExtension JSON format.

• Fixed git exporter authentication.

• Improved CSV import in certain situations.

• Improved look of Other translations widget.

• The max-length checks is now enforcing length of text in form.

• Make the commit_pending age configurable per component.

• Various user interface cleanups.

• Fixed component/project/site wide search for translations.

Weblate 2.15

Released on June 30th 2017.

• Show more related translations in other translations.

• Add option to see translations of current string to other languages.

• Use 4 plural forms for Lithuanian by default.

• Fixed upload for monolingual files of different format.

• Improved error messages on failed authentication.

• Keep page state when removing word from glossary.

• Added direct link to edit secondary language translation.

• Added Perl format quality check.

• Added support for rejecting reused passwords.

• Extended toolbar for editing RTL languages.

Weblate 2.14.1

Released on May 24th 2017.

• Fixed possible error when paginating search results.

• Fixed migrations from older versions in some corner cases.

• Fixed possible CSRF on project watch and unwatch.

• The password reset no longer authenticates user.

• Fixed possible CAPTCHA bypass on forgotten password.

Weblate 2.14

Released on May 17th 2017.

• Add glossary entries using AJAX.

• The logout now uses POST to avoid CSRF.

• The API key token reset now uses POST to avoid CSRF.

• Weblate sets Content-Security-Policy by default.

• The local editor URL is validated to avoid self-XSS.

• The password is now validated against common flaws by default.

• Notify users about important activity with their account such as password change.

• The CSV exports now escape potential formulas.

• Various minor improvements in security.

• The authentication attempts are now rate limited.

• Suggestion content is stored in the history.

• Store important account activity in audit log.

• Ask for password confirmation when removing account or adding new associations.

• Show time when suggestion has been made.

• There is new quality check for trailing semicolon.

• Ensure that search links can be shared.

• Included source string information and screenshots in the API.

• Allow to overwrite translations through API upload.

Weblate 2.13.1

Released on Apr 12th 2017.

• Fixed listing of managed projects in profile.

• Fixed migration issue where some permissions were missing.

• Fixed listing of current file format in translation download.

• Return HTTP 404 when trying to access project where user lacks privileges.

Weblate 2.13

Released on Apr 12th 2017.

• Fixed quality checks on translation templates.

• Added quality check to trigger on losing translation.

• Add option to view pending suggestions from user.

• コンポーネント リストのセットを自動的に構築するオプションを追加した。

• Default dashboard for unauthenticated users can be configured.

• Add option to browse 25 random strings for review.

• History now indicates string change.

• Better error reporting when adding new translation.

• Added per language search within project.

• Group ACLs can now be limited to certain permissions.

• The per project ALCs are now implemented using Group ACL.

• Added more fine grained privileges control.

• Various minor UI improvements.

Weblate 2.12

Released on Mar 3rd 2017.

• Improved admin interface for groups.

• Added support for Yandex Translate API.

• Improved speed of site wide search.

• Added project and component wide search.

• Added project and component wide search and replace.

• Improved rendering of inconsistent translations.

• Added support for opening source files in local editor.

• Added support for configuring visual keyboard with special characters.

• Improved screenshot management with OCR support for matching source strings.

• Default commit message now includes translation information and URL.

• Added support for Joomla translation format.

• Improved reliability of import across file formats.

Weblate 2.11

Released on Jan 31st 2017.

• Include language detailed information on language page.

• Mercurial backend improvements.

• Added option to specify translation component priority.

• More consistent usage of Group ACL even with less used permissions.

• Added WL_BRANCH variable to hook scripts.

• Improved developer documentation.

• Better compatibility with various Git versions in Git exporter addon.

• Included per project and component stats.

• Added language code mapping for better support of Microsoft Translate API.

• Moved fulltext cleanup to background job to make translation removal faster.

• Fixed displaying of plural source for languages with single plural form.

• Improved error handling in import_project.

• Various performance improvements.

Weblate 2.10.1

Released on Jan 20th 2017.

• Do not leak account existence on password reset form (CVE-2017-5537).

Weblate 2.10

Released on Dec 15th 2016.

• Added quality check to check whether plurals are translated differently.

• Fixed GitHub hooks for repositories with authentication.

• Added optional Git exporter module.

• Support for Microsoft Cognitive Services Translator API.

• Simplified project and component user interface.

• Added automatic fix to remove control characters.

• Added per language overview to project.

• Added support for CSV export.

• Added CSV download for stats.

• Added matrix view for quick overview of all translations

• Added basic API for changes and strings.

• Added support for Apertium APy server for machine translations.

Weblate 2.9

Released on Nov 4th 2016.

• Extended parameters for createadmin management command.

• Extended import_json to be able to handle with existing components.

• Added support for YAML files.

• Project owners can now configure translation component and project details.

• Use "Watched" instead of "Subscribed" projects.

• Projects can be watched directly from project page.

• Added multi language status widget.

• Highlight secondary language if not showing source.

• Record suggestion deletion in history.

• Improved UX of languages selection in profile.

• Fixed showing whiteboard messages for component.

• 保存後も環境設定タブを選択したままにする。

• Show source string comment more prominently.

• Automatically install Gettext PO merge driver for Git repositories.

• Added search and replace feature.

• Added support for uploading visual context (screenshots) for translations.

Weblate 2.8

Released on Aug 31st 2016.

• Documentation improvements.

• Translations.

• Updated bundled javascript libraries.

• Added list_translators management command.

• Django 1.8 is no longer supported.

• Fixed compatibility with Django 1.10.

• Added Subversion support.

• Separated XML validity check from XML mismatched tags.

• Fixed API to honor HIDE_REPO_CREDENTIALS settings.

• Show source change in Zen mode.

• Alt+PageUp/PageDown/Home/End now works in Zen mode as well.

• Add tooltip showing exact time of changes.

• Add option to select filters and search from translation page.

• Added UI for translation removal.

• Improved behavior when inserting placeables.

• Fixed auto locking issues in Zen mode.

Weblate 2.7

Released on Jul 10th 2016.

• Removed Google web translate machine translation.

• Improved commit message when adding translation.

• Fixed Google Translate API for Hebrew language.

• Compatibility with Mercurial 3.8.

• Added import_json management command.

• Correct ordering of listed translations.

• Show full suggestion text, not only a diff.

• Extend API (detailed repository status, statistics, …).

• Testsuite no longer requires network access to test repositories.

Weblate 2.6

Released on Apr 28th 2016.

• Fixed validation of components with language filter.

• Improved support for XLIFF files.

• Fixed machine translation for non English sources.

• Added REST API.

• Django 1.10 compatibility.

• Added categories to whiteboard messages.

Weblate 2.5

Released on Mar 10th 2016.

• Fixed automatic translation for project owners.

• Improved performance of commit and push operations.

• New management command to add suggestions from command line.

• Added support for merging comments on file upload.

• Added support for some GNU extensions to C printf format.

• Documentation improvements.

• Added support for generating translator credits.

• Added support for generating contributor stats.

• Site wide search can search only in one language.

• Improve quality checks for Armenian.

• Support for starting translation components without existing translations.

• Support for adding new translations in Qt TS.

• Improved support for translating PHP files.

• Performance improvements for quality checks.

• サイト全体で検査で不合格となったものの検索を修正。

• Added option to specify source language.

• Improved support for XLIFF files.

• Extended list of options for import_project.

• Improved targeting for whiteboard messages.

• Support for automatic translation across projects.

• Optimized fulltext search index.

• Added management command for auto translation.

• Added placeables highlighting.

• Added keyboard shortcuts for placeables, checks and machine translations.

• Improved translation locking.

• Added quality check for AngularJS interpolation.

• Added extensive group based ACLs.

• 編集が必要な文字列に関する用語を明確にする（以前は「あいまい」）。

• Clarified terminology on strings needing action and not translated strings.

• Support for Python 3.

• Dropped support for Django 1.7.

• Dropped dependency on msginit for creating new gettext PO files.

• Added configurable dashboard views.

• Improved notifications on parse errors.

• Added option to import components with duplicate name to import_project.

• Improved support for translating PHP files

• Added XLIFF export for dictionary.

• Added XLIFF and gettext PO export for all translations.

• Documentation improvements.

• Added support for configurable automatic group assignments.

• Improved adding of new translations.

Weblate 2.4

Released on Sep 20th 2015.

• Improved support for PHP files.

• Ability to add ACL to anonymous user.

• Improved configurability of import_project command.

• Added CSV dump of history.

• Avoid copy/paste errors with whitespace characters.

• Added support for Bitbucket webhooks.

• Tighter control on fuzzy strings on translation upload.

• Several URLs have changed, you might have to update your bookmarks.

• Hook scripts are executed with VCS root as current directory.

• Hook scripts are executed with environment variables describing current component.

• Add management command to optimize fulltext index.

• Added support for error reporting to Rollbar.

• Projects now can have multiple owners.

• Project owners can manage themselves.

• Added support for javascript-format used in gettext PO.

• Support for adding new translations in XLIFF.

• Improved file format autodetection.

• Extended keyboard shortcuts.

• Improved dictionary matching for several languages.

• Improved layout of most of pages.

• Support for adding words to dictionary while translating.

• Added support for filtering languages to be managed by Weblate.

• Added support for translating and importing CSV files.

• Rewritten handling of static files.

• Direct login/registration links to third-party service if that's the only one.

• Commit pending changes on account removal.

• Add management command to change site name.

• Add option to configure default committer.

• Add hook after adding new translation.

• Add option to specify multiple files to add to commit.

Weblate 2.3

Released on May 22nd 2015.

• Dropped support for Django 1.6 and South migrations.

• Support for adding new translations when using Java Property files

• Allow to accept suggestion without editing.

• Improved support for Google OAuth 2.0

• Added support for Microsoft .resx files.

• Tuned default robots.txt to disallow big crawling of translations.

• Simplified workflow for accepting suggestions.

• Added project owners who always receive important notifications.

• Allow to disable editing of monolingual template.

• More detailed repository status view.

• Direct link for editing template when changing translation.

• Allow to add more permissions to project owners.

• Allow to show secondary language in Zen mode.

• Support for hiding source string in favor of secondary language.

Weblate 2.2

Released on Feb 19th 2015.

• Performance improvements.

• Fulltext search on location and comments fields.

• New SVG/javascript based activity charts.

• Support for Django 1.8.

• Support for deleting comments.

• Added own SVG badge.

• Added support for Google Analytics.

• Improved handling of translation filenames.

• Added support for monolingual JSON translations.

• Record component locking in a history.

• Support for editing source (template) language for monolingual translations.

• Added basic support for Gerrit.

Weblate 2.1

Released on Dec 5th 2014.

• Added support for Mercurial repositories.

• Replaced Glyphicon font by Awesome.

• Added icons for social authentication services.

• Better consistency of button colors and icons.

• Documentation improvements.

• Various bugfixes.

• Automatic hiding of columns in translation listing for small screens.

• Changed configuration of filesystem paths.

• Improved SSH keys handling and storage.

• Improved repository locking.

• Customizable quality checks per source string.

• Allow to hide completed translations from dashboard.

Weblate 2.0

Released on Nov 6th 2014.

• New responsive UI using Bootstrap.

• Rewritten VCS backend.

• Documentation improvements.

• Added whiteboard for site wide messages.

• Configurable strings priority.

• Added support for JSON file format.

• Fixed generating mo files in certain cases.

• Added support for GitLab notifications.

• Added support for disabling translation suggestions.

• Django 1.7 support.

• ACL projects now have user management.

• Extended search possibilities.

• Give more hints to translators about plurals.

• Fixed Git repository locking.

• Compatibility with older Git versions.

• Improved ACL support.

• Added buttons for per language quotes and other special characters.

• Support for exporting stats as JSONP.

Weblate 1.x series

Weblate 1.9

Released on May 6th 2014.

• Django 1.6 compatibility.

• No longer maintained compatibility with Django 1.4.

• Management commands for locking/unlocking translations.

• Improved support for Qt TS files.

• Users can now delete their account.

• Avatars can be disabled.

• Merged first and last name attributes.

• Avatars are now fetched and cached server side.

• Added support for shields.io badge.

Weblate 1.8

Released on November 7th 2013.

• Please check manual for upgrade instructions.

• Nicer listing of project summary.

• Better visible options for sharing.

• More control over anonymous users privileges.

• Supports login using third party services, check manual for more details.

• Users can login by e-mail instead of username.

• Documentation improvements.

• Improved source strings review.

• Searching across all strings.

• Better tracking of source strings.

• Captcha protection for registration.

Weblate 1.7

Released on October 7th 2013.

• Please check manual for upgrade instructions.

• Support for checking Python brace format string.

• Per component customization of quality checks.

• Detailed per translation stats.

• Changed way of linking suggestions, checks and comments to strings.

• Users can now add text to commit message.

• Support for subscribing on new language requests.

• Support for adding new translations.

• Widgets and charts are now rendered using Pillow instead of Pango + Cairo.

• Add status badge widget.

• Dropped invalid text direction check.

• Changes in dictionary are now logged in history.

• Performance improvements for translating view.

Weblate 1.6

Released on July 25th 2013.

• Nicer error handling on registration.

• Browsing of changes.

• Fixed sorting of machine translation suggestions.

• Improved support for MyMemory machine translation.

• Added support for Amagama machine translation.

• Various optimizations on frequently used pages.

• Highlights searched phrase in search results.

• Support for automatic fixups while saving the message.

• Tracking of translation history and option to revert it.

• Added support for Google Translate API.

• Added support for managing SSH host keys.

• Various form validation improvements.

• Various quality checks improvements.

• Performance improvements for import.

• Added support for voting on suggestions.

• Cleanup of admin interface.

Weblate 1.5

Released on April 16th 2013.

• Please check manual for upgrade instructions.

• Added public user pages.

• Better naming of plural forms.

• Added support for TBX export of glossary.

• Added support for Bitbucket notifications.

• Activity charts are now available for each translation, language or user.

• Extended options of import_project admin command.

• Compatible with Django 1.5.

• Avatars are now shown using libravatar.

• Added possibility to pretty print JSON export.

• Various performance improvements.

• Indicate failing checks or fuzzy strings in progress bars for projects or languages as well.

• Added support for custom pre-commit hooks and committing additional files.

• Rewritten search for better performance and user experience.

• New interface for machine translations.

• Added support for monolingual po files.

• Extend amount of cached metadata to improve speed of various searches.

• Now shows word counts as well.

Weblate 1.4

Released on January 23rd 2013.

• Fixed deleting of checks/comments on string deletion.

• Added option to disable automatic propagation of translations.

• Added option to subscribe for merge failures.

• Correctly import on projects which needs custom ttkit loader.

• Added sitemaps to allow easier access by crawlers.

• Provide direct links to string in notification e-mails or feeds.

• Various improvements to admin interface.

• Provide hints for production setup in admin interface.

• Added per language widgets and engage page.

• Improved translation locking handling.

• Show code snippets for widgets in more variants.

• Indicate failing checks or fuzzy strings in progress bars.

• More options for formatting commit message.

• Fixed error handling with machine translation services.

• Improved automatic translation locking behaviour.

• Support for showing changes from previous source string.

• Added support for substring search.

• Various quality checks improvements.

• Support for per project ACL.

• Basic string tests coverage.

Weblate 1.3

Released on November 16th 2012.

• Compatibility with PostgreSQL database backend.

• Removes languages removed in upstream git repository.

• Improved quality checks processing.

• Added new checks (BB code, XML markup and newlines).

• Support for optional rebasing instead of merge.

• Possibility to relocate Weblate (for example to run it under /weblate path).

• Support for manually choosing file type in case autodetection fails.

• Better support for Android resources.

• Support for generating SSH key from web interface.

• More visible data exports.

• New buttons to enter some special characters.

• Support for exporting dictionary.

• Support for locking down whole Weblate installation.

• Checks for source strings and support for source strings review.

• Support for user comments for both translations and source strings.

• Better changes log tracking.

• Changes can now be monitored using RSS.

• Improved support for RTL languages.

Weblate 1.2

Released on August 14th 2012.

• Weblate now uses South for database migration, please check upgrade instructions if you are upgrading.

• Fixed minor issues with linked git repos.

• New introduction page for engaging people with translating using Weblate.

• Added widgets which can be used for promoting translation projects.

• Added option to reset repository to origin (for privileged users).

• Project or component can now be locked for translations.

• Possibility to disable some translations.

• Configurable options for adding new translations.

• Configuration of git commits per project.

• Simple antispam protection.

• Better layout of main page.

• Support for automatically pushing changes on every commit.

• Support for e-mail notifications of translators.

• 使用している言語のみを環境設定に一覧表示します。

• Improved handling of not known languages when importing project.

• Support for locking translation by translator.

• Optionally maintain Language-Team header in po file.

• Include some statistics in about page.

• Supports (and requires) django-registration 0.8.

• Caching of counted strings with failing checks.

• Checking of requirements during setup.

• Documentation improvements.

Weblate 1.1

Released on July 4th 2012.

• Improved several translations.

• Better validation while creating component.

• Added support for shared git repositories across components.

• Do not necessary commit on every attempt to pull remote repo.

• Added support for offloading indexing.

Weblate 1.0

Released on May 10th 2012.

• Improved validation while adding/saving component.

• Experimental support for Android component files (needs patched ttkit).

• Updates from hooks are run in background.

• Improved installation instructions.

• Improved navigation in dictionary.

Weblate 0.x series

Weblate 0.9

Released on April 18th 2012.

• Fixed import of unknown languages.

• Improved listing of nearby messages.

• Improved several checks.

• Documentation updates.

• Added definition for several more languages.

• Various code cleanups.

• Documentation improvements.

• Changed file layout.

• Update helper scripts to Django 1.4.

• Improved navigation while translating.

• Better handling of po file renames.

• Better validation while creating component.

• Integrated full setup into syncdb.

• Added list of recent changes to all translation pages.

• Check for not translated strings ignores format string only messages.

Weblate 0.8

Released on April 3rd 2012.

• Replaced own full text search with Whoosh.

• Various fixes and improvements to checks.

• New command updatechecks.

• Lot of translation updates.

• Added dictionary for storing most frequently used terms.

• Added /admin/report/ for overview of repositories status.

• Machine translation services no longer block page loading.

• Management interface now contains also useful actions to update data.

• Records log of changes made by users.

• Ability to postpone commit to Git to generate less commits from single user.

• Possibility to browse failing checks.

• Automatic translation using already translated strings.

• New about page showing used versions.

• Django 1.4 compatibility.

• Ability to push changes to remote repo from web interface.

• Added review of translations done by others.

Weblate 0.7

Released on February 16th 2012.

• Direct support for GitHub notifications.

• Added support for cleaning up orphaned checks and translations.

• Displays nearby strings while translating.

• Displays similar strings while translating.

• Improved searching for string.

Weblate 0.6

Released on February 14th 2012.

• Added various checks for translated messages.

• Tunable access control.

• Improved handling of translations with new lines.

• Added client side sorting of tables.

• Please check upgrading instructions in case you are upgrading.

Weblate 0.5

Released on February 12th 2012.

• Support for machine translation using following online services:

  • Apertium

  • Microsoft Translator

  • MyMemory

• Several new translations.

• Improved merging of upstream changes.

• Better handle concurrent git pull and translation.

• Propagating works for fuzzy changes as well.

• Propagating works also for file upload.

• Fixed file downloads while using FastCGI (and possibly others).

Weblate 0.4

Released on February 8th 2012.

• Added usage guide to documentation.

• Fixed API hooks not to require CSRF protection.

Weblate 0.3

Released on February 8th 2012.

• Better display of source for plural translations.

• New documentation in Sphinx format.

• Displays secondary languages while translating.

• Improved error page to give list of existing projects.

• New per language stats.

Weblate 0.2

Released on February 7th 2012.

• Improved validation of several forms.

• Warn users on profile upgrade.

• Remember URL for login.

• Naming of text areas while entering plural forms.

• Automatic expanding of translation area.

Weblate 0.1

Released on February 6th 2012.

• Initial release.

目次と索引

• 索引

• HTTP Routing Table

• Pythonモジュール索引