Extension Etiquette

出典: MDC

この記事は拡張機能を作る際の慣行について述べます。あなたは既に拡張機能の作り方について詳しいだろうと仮定します。

これは公式な文章ではありません。トークページで自由に議論してください。

目次 1 ツールメニュー項目 2 その他の UI 要素 3 About ダイアログ 4 テーマ 5 拡張機能のアイコン 6 名前の付け方 7 説明 8 ID 9 バージョン番号 10 ロケール 11 設定の内部名 12 依存 13 ドキュメンテーション

[編集] ツールメニュー項目

拡張機能作者はこの点について最も多くの選択肢をもっています。拡張機能の項目がツールメニューの先頭、あるいは最後、あるいは中間のどこかにあるべきかは作者の考えの問題です。しかし、理想的には、拡張機能が追加するメニュー項目は、他の拡張機能が追加するコマンドと同様に、「アドオン」項目の下の位置に置くべきです。サブメニューは、一つの拡張機能が複数のメニュー項目を必要とする場合に使うべきです。「ツール」メニューに対しては、オプションや設定のための項目を作るべきではありません (オプションや設定については、アドオンマネージャを使ってください)。メニュー項目を加える時は、できれば、最もふさわしいメニューの中に項目を作りましょう。例えば、ブックマークを共有するような拡張機能は、ブックマークメニューの中から呼ばれるべきです。標準的なテーマの外観を維持するために、メニュー項目のアイコンの使用は避けてください。

[編集] その他の UI 要素

一般に、ツールバー項目はエンドユーザにとって とても便利です。なぜなら必要に応じてそれらを様々なツールバーに追加したり削除できるからです。ステータスバー項目は、広告ブロックやページランク、クッキー管理などのように、状態を常に監視するような種類の拡張機能だけが追加すべきです。同様に、コンテキストメニューの項目も慎重に使ってください。コンテキストメニューの項目は、頻繁に行われる動作やウェブページの特定の要素で行われる動作に対してのみ提供されるべきです。

[編集] About ダイアログ

install.rdf のデータによって作られる、標準のポップアップ About ダイアログ があります。普通は、XUL を使って新しい About ボックスを作る必要はありません。カスタマイズされた About ボックスをやめることでダウンロードサイズを減らすことができます。(カスタムアップデータのような) 特別な機能を含めなくてはならない場合のみ、独自の About ボックスを作ってください。

[編集] テーマ

もしあなたの拡張機能に XUL 製のボタンが含まれていて、それがブラウザに元々ある機能と似た機能 (例えば、フィードリーダの再読み込みと読み込み中止のような) である場合は、ブラウザのテーマに含まれているアイコンを使用してください。これによって拡張機能のファイルサイズを削減して軽くできますし、(特に異なったテーマを使用しているユーザのために) より外観の一貫性を高めることもできます。

[編集] 拡張機能のアイコン

独自のアイコンは普通、ダウンロードするファイル容量が増えたとしても、加えるだけの価値があります。それらによってアドオンマネージャで他の拡張機能の中から簡単に識別できるようになります。

[編集] 名前の付け方

創造的なものにしてください! 名前に「拡張」、「Mozilla/Firefox/Thunderbird」またはバージョン番号を含めないでください。余分です。

[編集] 説明

拡張機能マネージャの初期状態のウィンドウ幅に収まるように、うまく説明する文章を作ってください。 Mozilla の拡張機能 (DOM インスペクタ、障害のレポータ、Talkback) は、「ブラウザで動作を実行します。」のように、動詞から書き始めるのが最も良い方法だと信じているようです。【訳注: 英語では「does an action in the browser. (……は、ブラウザの中で何かします)」という風に、文章としてそれ単体では完結しておらず、拡張機能の名前に続けて読んだ場合に自然な文章になるような説明文がよく使われるようです。】

[編集] ID

Firefox/Thunderbird 1.5 以降は拡張機能の ID の書き方について 1.0 の頃よりも厳密に扱うようになりました。それらが正しい形式になっているかどうか確認してください。

[編集] バージョン番号

Mozilla のパターンに従ってください。つまり(「1.0.7」のように)、このような形式です：「<メジャーバージョン>.<より具体的な現在のバージョン>.<セキュリティ/バグ修正のリリース番号>」

[編集] ロケール

もしあなたの拡張機能が一つの言語だけを提供していたとしても、常にロケール DTD と プロパティファイル を使ってください。これは拡張機能を他の言語に翻訳しやすくします (実際、拡張機能を他の人が他の言語に訳してくれるのはよくある事です)。

[編集] 設定の内部名

拡張機能の Firefox の内部設定 (つまり、about:config に表示される設定の名前) は全て "extensinons." で始まり、次に拡張機能の内部名(「.」を付けて)、その次に設定の名前であるべきです。例えばプライバシポリシを表示しないようにする Reporter 拡張機能の真偽値型のオションは "extensions.reporter.hidePrivacyStatement" です。

[編集] 依存

自分の拡張機能を使うために他の拡張機能のダウンロードを要求することは良いことではありません。jsLib は例外にあたるでしょうが、他の拡張機能、特にあなたが開発していない拡張機能への依存は避けるように常に努力してください。

[編集] ドキュメンテーション

あなたのユーザの大多数は Mozilla の内側の仕組みについて、あなた程の知識はないと仮定してください。あなたの拡張機能のホームページが当り前のことを書いているか確認してください。