言語ファイル（.po）の msgctxt と間違いやすい点

アドオンの .po ファイルで使う msgctxt のプレフィックス一覧と、書き間違えやすい例。

アドオンの言語ファイルは、var/langs/ja/addons/<アドオンID>.po に置きます。基本的な仕組みは .poファイルによる言語ファイルの作成を参照してください。ここでは、msgctxt の使い分けと、間違いやすい点をまとめます。

ヘッダー

msgid ""
msgstr ""
"Project-Id-Version: cs-cart-latest\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Language-Team: Japanese\n"
"Language: ja_JP\n"

msgctxt のプレフィックス一覧

プレフィックス	用途
`Addons::name::`	アドオン名
`Addons::description::`	アドオンの説明
`SettingsSections::`	設定のセクション
`SettingsOptions::`	設定のオプション
`SettingsTooltips::`	設定オプションのツールチップ
`SettingsVariants::`	設定オプションの選択肢
`Languages::`	上記以外の一般の言語変数

形式

# アドオン名・説明（必須）
msgctxt "Addons::name::my_addon"
msgid "My Addon"
msgstr "マイアドオン"

msgctxt "Addons::description::my_addon"
msgid "Addon description"
msgstr "アドオンの説明"

# 設定のセクション
msgctxt "SettingsSections::my_addon::general"
msgid "General"
msgstr "一般"

# 設定のオプション
msgctxt "SettingsOptions::my_addon::option_id"
msgid "Option label"
msgstr "オプションのラベル"

# 設定オプションのツールチップ
msgctxt "SettingsTooltips::my_addon::option_id"
msgid "Tooltip text"
msgstr "ツールチップのテキスト"

# 設定オプションの選択肢
msgctxt "SettingsVariants::my_addon::option_id::variant_id"
msgid "Variant label"
msgstr "選択肢のラベル"

# 一般の言語変数
msgctxt "Languages::my_addon.some_key"
msgid "Text"
msgstr "テキスト"

アドオン固有の言語変数の名前

一般の言語変数は、ほかのアドオンやコアの変数と名前が衝突しないようにします。次のどちらかの形にすると整理しやすくなります。

アドオンIDとドット区切り：Languages::my_addon.some_key
アドオンの略称とアンダースコア：Languages::my_addon_some_key（略称の例：my_vendor_refunds に対する mvr_）

.po ファイルの中は、コメントで「Settings」「Menu items」「Notifications」のように区切ると読みやすくなります。

よくある間違い

アドオン名に Languages を使わない

アドオン名は Addons::name:: で定義します。Languages:: では定義しません。

# 間違い
msgctxt "Languages::my_addon"
msgid "my_addon"
msgstr "マイアドオン"

# 正しい
msgctxt "Addons::name::my_addon"
msgid "My Addon"
msgstr "マイアドオン"

ツールチップに SettingsOptions を使わない

設定オプションのツールチップは SettingsTooltips:: で定義します。

# 間違い
msgctxt "SettingsOptions::my_addon::option_tooltip"

# 正しい
msgctxt "SettingsTooltips::my_addon::option_id"