Mozilla Thunderbird アドオンの作り方 ~ アドオンのひな形

Posted by
ぴろり
Posted at
2014/03/21 13:28
Trackbacks
関連記事 (0)
Post Comment
コメントできます
Category
開発メモ カテゴリ
カバーイメージ

 開発環境の準備ができたので、雷鳥アドオンの開発に進みます。とりあえず、まだ何の動作も機能も持たず、雷鳥にアドオンとして認識されるところまで、最低限のものを作ってみます。

この記事を Delicious に追加する   このエントリーをはてなブックマークに追加  

スクラップ帳 » Mozilla Thunderbird アドオンの作り方

 Mozilla Thunderbird 用アドオン開発を始めるための開発環境の準備から、公式サイトで配布するために、少なくとも英語で多言語化するまでの手順を解説しています。

  1. Mozilla Thunderbird アドオンの作り方 ~ 開発環境の準備 2014/03/16
  2. Mozilla Thunderbird アドオンの作り方 ~ アドオンのひな形 2014/03/21 今ココ
  3. Mozilla Thunderbird アドオンの作り方 ~ 独自UIの追加 2014/04/05
  4. Mozilla Thunderbird アドオンの作り方 ~ UI動作の追加 2014/04/12
  5. Mozilla Thunderbird アドオンの作り方 ~ 多言語化 2014/04/20

アドオンの ID を決める

 アドオンを識別する一意な文字列を決めます。UUID/ GUID 形式でしたが任意文字列で良いようです。アドオン名と独自ドメイン名を組み合わせて、メール アドレスに似た形式で記述するのが判りやすくて良いと思います。メール アドレスに似ていますが、実際にメールが届く訳ではないので心配はいりません。例えば、TagSequenceArrangerの場合、tagsequencearranger@thunderbird.magicvox.net としていますが、このアドレス宛にメールを送ってもエラーになります。とにかく、他と衝突せず、判りやすい文字列であれば良いのです。この記事では

my-addon@my.example.com

と決めて話を進めます。

開発中のアドオンの配置方法

 完成したアドオンを配布するには形式が決まっていますが、開発中のアドオンはそこそこ自由に配置することができます。開発スタイルに応じて適当に選択してください。ここで、先に決めたアドオンの ID が必要になります。

方法1. プロファイル内に開発ディレクトリを置く

 開発用プロファイルのディレクトリ({PROFILE_DIR})を開き、先に決めた ID 名で開発用ディレクトリ({DEV_DIR})を作成します。

\{PROFILE_DIR}
+- \extensions
   +- \my-addon@my.example.com

方法2. ポインタ ファイルを置く

 任意の場所にある開発用ディレクトリを雷鳥に読み込ませる方法です。開発用プロファイルのディレクトリ({PROFILE_DIR})を開き、先に決めた ID 名でテキスト ファイルを作成します。

\{PROFILE_DIR}
+- \extensions
   +- my-addon@my.example.com

 そして、例えば、開発用ディレクトリが X:\My Project\MyAddon だった場合、my-addon@my.example.com ファイルを開き、開発用ディレクトリのパスを書き入れます。

X:\My Project\MyAddon

アドオンの雛形

 開発用ディレクトリ直下に次の内容で install.rdf を作成し、開発用プロファイルで雷鳥を起動してみます。"My First Addon" がインストールされるはずです。"My First Addon" アドオンは何の機能もありませんが、雷鳥に小指が掛かるところまで進みました!

<?xml version="1.0"?>
<RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
     xmlns:em="http://www.mozilla.org/2004/em-rdf#">

  <Description about="urn:mozilla:install-manifest">
    <em:id>my-addon@my.example.com</em:id>
    <em:version>0.1.$Rev: 96 $</em:version>
    <em:type>2</em:type>

    <!-- Thunderbird -->
    <em:targetApplication>
        <Description>
            <em:id>{3550f703-e582-4d05-9a08-453d09bdfdc6}</em:id>
            <em:minVersion>3.0</em:minVersion>
            <em:maxVersion>24.*</em:maxVersion>
        </Description>
    </em:targetApplication>

    <!-- Front End MetaData -->
    <em:name>My First Addon</em:name>
    <em:description>I've began to learn the addon for Thunderbird</em:description>
    <em:creator>Piroli YUKARINOMIYA</em:creator>
    <em:homepageURL>http://www.magicvox.net/</em:homepageURL>
  </Description>
</RDF>

install.rdf の解説

 各自で弄ることが多そうな箇所のみ解説します。解説がない項目や詳細は Install Manifests | MDN を参照してください。

  • 6 行目 em:id ... アドオンを識別する ID で、先に決めたものと同じにします。
  • 7 行目 em:version ... アドオンのバージョン番号です。数字以外にも記号を入れられたり、結構いい加減かも?
  • 20 行目 em:name ... アドオン一覧に表示されるアドオンの名前です。
  • 21 行目 em:description ... アドオンの簡単な説明文です。
  • 22 行目 em:creator ... アドオンの情報に表示される作成者の名前。
  • 23 行目 em:homepageURL ... アドオンの情報からアクセスできるホームページアドレス。

 以上です。次回はこの雛形を土台にして独自のユーザ インタフェース要素を追加してみます。

この記事を Delicious に追加する   このエントリーをはてなブックマークに追加  


この記事を読んだ人はこんな記事も読んでいます記事リコメンデーションについて

カバー画像:Mozilla Thunderbird アドオンの作り方 ~ 独自UIの追加

関連記事/トラックバック

関連記事/トラックバックはまだありません

この記事にトラックバックを送るには?

コメントを投稿する

 
 (必須, 匿名可, 公開, トリップが使えます)
 (必須, 匿名可, 非公開, Gravatar に対応しています)
 (必須)
スパム コメント防止のため「投稿確認」欄に ランダムな数字 CAPTCHAについて を入力してから送信してください。お手数ですがご協力のほど宜しくお願いいたします。