技術資料

Movable Type のプラグインの作り方の解説記事、第六回です。

過去の記事は、

• Movable Typeプラグイン開発入門：第一回 基本的なプラグインの作成方法
• Movable Typeプラグイン開発入門：第二回 設定画面の実装と動作確認
• Movable Typeプラグイン開発入門：第三回 管理画面サイドメニューの変更と追加方法
• Movable Typeプラグイン開発入門：第四回 管理画面へのモード追加と設定表示の実装
• Movable Typeプラグイン開発入門：第五回 独立CGIスクリプトで設定表示機能を実装

今回は、プラグインのローカライゼーションについて解説します。

ローカライゼーションとは

ローカライゼーションとは、ソフトウェアやプログラムのメッセージやテキストを異なる言語に対応させるプロセスです。これにより、ユーザーは自分の母国語でプログラムを利用できるようになります。たとえば、英語で書かれたプラグインを日本語に翻訳することで、日本のユーザーにとってより親しみやすく、使いやすいものになります。

config.yaml でのローカライゼーションの実装

Movable Type のプラグインで、ローカライゼーションを実装するためには、config.yaml に以下のような辞書設定を追加します。

l10n_lexicon:
    ja:
      This plugin is just for adding a mode to show the settings.: 設定を表示するモードを追加するだけのプラグインです。
      Tatsuya Abe: 阿部辰也
      SamplePlugin: サンプルプラグイン
      SamplePlugin Settings: サンプルプラグインの設定
      API Key: APIキー
      API Enable Setting: API有効化
      Enable API: APIを有効化する
      Disable API: APIを無効化する
      SamplePlugin Settings Confirmation: サンプルプラグイン 設定確認

この設定は、プラグインのメッセージやテキストを日本語に対応させるためのものです。

辞書設定に合わせて、前回までで作成した config.yaml 全体を以下のように変更します。

id: SamplePlugin
    name: SamplePlugin
    version: 0.6
    description: <__trans phrase="This plugin is just for adding a mode to show the settings.">
    author_name: <__trans phrase="Tatsuya Abe">
    author_link: https://www.abe-tatsuya.com/
    doc_link: https://www.abe-tatsuya.com/document_url/
    
    l10n_lexicon:
      ja:
        This plugin is just for adding a mode to show the settings.: 設定を表示するモードを追加するだけのプラグインです。
        Tatsuya Abe: 阿部辰也
        SamplePlugin: サンプルプラグイン
        SamplePlugin Settings: サンプルプラグインの設定
        API Key: APIキー
        API Enable Setting: API有効化
        Enable API: APIを有効化する
        Disable API: APIを無効化する
        SamplePlugin Settings Confirmation: サンプルプラグイン 設定確認
        Failed to retrieve plugin settings.: プラグインの設定の取得に失敗しました。
    
    system_config_template: sampleplugin_setting.tmpl
    settings:
        sample_api_key:
            default:
            scope: system
        sample_api_enable:
            default: 0
            scope: system
    
    applications:
        cms:
            menus:
                sampleplugin:
                    label: SamplePlugin
                    icon: ic_tool
                    order: 1550
                    system_permission: administer
                sampleplugin:setting:
                    label: SamplePlugin Settings
                    order: 10
                    mode: sampleplugin_setting
                    view: system
                    condition: sub { return 1;}
            methods:
                sampleplugin_setting: $SamplePlugin::SamplePlugin::PluginSetting::show_setting

多言語対応したいテキストを <__trans phrase="テキスト"> で囲むことで、プラグインのメッセージやテキストが日本語に対応します。

ただし、サイドメニュー部分のラベルなどは、MTのコアが自動で多言語対応しているため、<__trans phrase="テキスト"> で囲む必要はありません。

テンプレートでのローカライゼーションの実装

前回までで作成したテンプレートファイルについて、ローカライゼーションを実装します。

まずは、sampleplugin_setting.tmpl を以下のように<__trans phrase="テキスト">を使って変更します。

<mtapp:setting id="sample_api_key" label="<__trans phrase="API Key">">
    <input type="text" name="sample_api_key" id="sample_api_key" class="form-control w-100"
        value="<mt:GetVar name="sample_api_key" escape="html">">
</mtapp:setting>


<mtapp:setting id="sample_api_enable" label="<__trans phrase="API Enable Setting">">
    <br>
    <label>
        <input type="radio" name="sample_api_enable" id="sample_api_enable_yes" class="custom-control-input"
         value="1"<mt:if name="sample_api_enable" eq="1"> checked="checked"</mt:if> >
         <__trans phrase="Enable API">
    </label>
    <br>
    <label>
        <input type="radio" name="sample_api_enable" id="sample_api_enable_no" class="custom-control-input"
         value="0"<mt:if name="sample_api_enable" ne="1"> checked="checked"</mt:if> >
         <__trans phrase="Disable API">
    </label>
</mtapp:setting>

同様に、sample_plugin_showsetting.tmpl も以下のように変更します。

<mt:include name="include/header.tmpl" page_title="<__trans phrase="SamplePlugin Settings Confirmation">">
    <p><__trans phrase="API Key">: <mt:var name="api_key" encode_html="1"></p>
    <p><__trans phrase="API Enable Setting">:
        <mt:if name="api_enable" eq="1">
            <__trans phrase="Enable">
        <mt:else>
            <__trans phrase="Disable">
        </mt:if>
    </p>
<mt:include name="include/old_footer.tmpl">

これで、テンプレートのローカライゼーションも完了です。

Perlコード内でのローカライゼーションの実装

Perlコード内でのローカライゼーションの実装は、translate メソッドを使用します。

前回までで作成した SamplePlugin::PluginSetting::show_setting を以下のように変更します。

sub show_setting {
    my $app = shift;
    my $plugin = MT->component('SamplePlugin');

    my %param;
    eval{
	    # プラグイン設定を取得
	    $param{api_key} = $plugin->get_config_value('sample_api_key', 'system');
	    $param{api_enable} = $plugin->get_config_value('sample_api_enable', 'system');
    };
    if($@){
        # エラーメッセージを日本語に変換
        my $err_msg = $plugin->translate('Failed to retrieve plugin settings.');
        print "Content-Type: text/html;charset=UTF-8\n\n";
        print "$err_msg: $@";
        exit;
    }

    $app->load_tmpl('sampleplugin_showsetting.tmpl', \%param);
}

これで、Perlコード内でのローカライゼーションも完了です。

まとめ

この記事では、以下のポイントを中心に解説しました。

config.yaml でのローカライゼーションの実装

辞書設定を追加することで、プラグイン内のメッセージを簡単に翻訳できます。

テンプレートでのローカライゼーションの実装

テンプレートファイル内では<__trans phrase="テキスト">を使うことで、メッセージを翻訳できます。

Perlコード内でのローカライゼーションの実装

Perlコード内ではtranslateメソッドを使うことで、メッセージを翻訳できます。