Weblate のカスタマイズ

Django と Python を使用して拡張およびカスタマイズします。変更を上流に還元して、誰もが恩恵を受けられるようにしてください。これにより、あなたの保守コストが削減されます。Weblate に入ったコードは、内部インターフェイスの変更やコードのリファクタリング時に考慮されます。

警告

内部インターフェイスもテンプレートも、安定した API とはいえません。インターフェイスまたはそのセマンティクスは予告なく変更されますので、アップグレードごとに独自のカスタマイズを見直してください。

参考

Weblate に貢献

Python モジュールの作成

Python に慣れていない場合は、Python For Beginners を調べて、基本の説明とチュートリアルを参考にしてください。

（モジュールと呼ばれる）Python のカスタムコードを含むファイルを作成するには、それを格納する場所が必要です。システムパス（通常は /usr/lib/python3.9/site-packages/ など）か、インタプリタ検索パスに追加された Weblate ディレクトリのどちらかになります。

バージョン 3.8-5 で追加: Docker を使用したインストールの場合、Python モジュールを /app/data/python/`（参照: :ref:`docker-volume）配置できるます。たとえば上書き設定ファイルから Weblate で読み込めます。

カスタマイズしたものを適切な Python パッケージに変更すると、さらに良くなります。

パッケージ用のフォルダを作成する（weblate_customization を使用する）。

その中に、パッケージを記述するための setup.py ファイルを作成する。作成方法:

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"],
)

カスタマイズコード用の Python モジュール（``weblate_customization``とも呼ばれる）用のフォルダーを作成する。
その中に __init__.py ファイルを作成し、Python がモジュールをインポートできることを確認する。
このパッケージは、pip install -e を使用してインストールできるようになりました。詳細については、Editable installs を確認してください。
インストールが完了すると、モジュールは Weblate の設定から使用できるようになります（weblate_customization.checks.FooCheck など）。

出来上がったパッケージ構造:

weblate_customization
├── setup.py
└── weblate_customization
    ├── __init__.py
    ├── addons.py
    └── checks.py

Weblate のカスタマイズ例は、<https://github.com/WeblateOrg/customize-example> にあります。ここでは、次に説明するすべてのトピックについて説明します。カスタマイズ例は、以下に説明するトピックをすべて網羅しています。

ロゴの変更

上書きしたい静的ファイルを含む単純な Django アプリケーションを作成します（参照: Python モジュールの作成）。

表示するロゴのファイル:

icons/weblate.svg
ナビゲーションバーに表示するロゴ。

logo-*.png
画面の解像度と Web ブラウザに応じた Web アイコン。

favicon.ico
従来のブラウザーで使用する Web アイコン。

weblate-*.png
ボットまたは匿名ユーザー用のアバター。一部の Web ブラウザでは、これをショートカットアイコンとして使用する。

email-logo.png
通知メールに使用する。

これを、INSTALLED_APPS に追加する方法:

INSTALLED_APPS = (
    # Add your customization as first
    "weblate_customization",
    # Weblate apps are here…
)

weblate collectstatic --noinput を実行し、クライアントに提供する静的ファイルをまとめます。

参考

How to manage static files (e.g. images, JavaScript, CSS)、静的ファイルの提供

品質検査、アドオン、自動修正のカスタマイズ

自動修正のカスタマイズ、独自の検査項目の作成、またはアドオンの作成のコードを Weblate にインストールする方法:

Weblate のカスタマイズを含む、Python モジュール内にファイルを置く（参照: Python モジュールの作成）。
Python クラスへの完全修飾パスを専用設定に追加する（WEBLATE_ADDONS、CHECK_LIST または AUTOFIX_LIST):

# Checks
CHECK_LIST += ("weblate_customization.checks.FooCheck",)

# Autofixes
AUTOFIX_LIST += ("weblate_customization.autofix.FooFixer",)

# Add-ons
WEBLATE_ADDONS += ("weblate_customization.addons.ExamplePreAddon",)

参考

自動修正のカスタマイズ、独自の検査項目の作成、アドオンの作成、アドオンから実行するスクリプト