Firefox拡張のローカライズのバックアップ差分(No.13)

追加された行はこの色です。
削除された行はこの色です。
ｆ[[FireVox]]にもどる

このコンテンツは現在執筆中です。

* 目次 [#o870cb0c]

#contents

* 目的 [#x6e30939]
FireVoxを日本語化したときの工程や、資料をまとめます。
日本語ロケールファイルを付け加える作業だけではなく、
ローカリゼーション機構のない拡張にlocalフォルダを作り多言語対応にする方法です。
一からローカリゼーション対応の拡張を作るときにも役に立つでしょう。

これは私がこのようにやったという報告であって、正攻法ではないかもしれません。
実際にやるときは、概略だけを参考にして、自分でスクリプトを書いて自動化したり、いろいろやってみてください。

* 参考ページ [#c74ae3a7]
主に以下のサイトを参考にしました。他にも記録していないページを参考。

ここにあるページの情報を見れば、自分がまとめる必要もないかもしれない。

ここにあるサイトは古い情報が含まれている可能性があります。事実そのために手こずったところもあります。

-Firefoxまとめサイト
--[[拡張の作成:http://firefox.geckodev.org/index.php?%B3%C8%C4%A5%A4%CE%BA%EE%C0%AE]]

-[[How to create Firefox extensions:http://roachfiend.com/archives/2004/12/08/how-to-create-firefox-extensions/]]
上記の原文

-Mozilla Japan
--[[ローカライズセンター:http://www.mozilla-japan.org/jp/l10n/]]

-[[もじふぉ:http://forums.firehacks.org/l10n/index.php]]
日本語化に関する総合フォーラム

--[[拡張の日本語版:http://forums.firehacks.org/l10n/viewtopic.php?t=41&start=0&postdays=0&postorder=asc&highlight=&sid=6243ddc810a4d2c73d13f336ac81d05a]]

--[[ 拡張の日本語化に挑戦したい！？:http://forums.firehacks.org/l10n/viewtopic.php?t=355&start=0&postdays=0&postorder=asc&highlight=&sid=2675915a0faf56621f2234926077ec8c]]

-takanory.net 
--[[拡張機能の日本語化:http://takanory.net/firefox/japanize/]]

-[[XULplanet.com:http://www.xulplanet.com/]]
--[[Localization:http://www.xulplanet.com/references/xpcomref/group_Localization.html]]

-[[Creating Applications with Mozilla:http://books.mozdev.org/html/]]

* 準備するソフト [#odffead2]
* パッケージの展開 [#i03a14cc]
* ローカリゼーションへの対応 [#d85861c3]
** パッケージのローカリゼーション対応 [#g6009011]
*** install.rdfの記述 [#nbe6b58b]
*** フォルダの構成 [#z78b5a5e]
*** contents.rdf [#w2742035]

** XULのローカリゼーション対応 [#b570dcd9]
拡張機能のユーザーインターフェイス部分、つまりメニューの項目やウィンドウ上のボタンの配置、そして処理の指定など、そういうものを記述してあるのが、XULファイルです。書式はXMLです
拡張機能のユーザーインターフェイス部分、つまりメニューの項目やウィンドウ上のボタンの配置、そして処理の指定など、そういうものを記述してあるのが、XULファイルです。

このXULファイルには、ウィンドウやメニューの項目など、翻訳の対象となる文字列があります。
このXULファイルには、ウィンドウのラベルやメニューの項目など、翻訳の対象となる文字列があります。

*** XULファイルの記述 [#c2eb8505]
*** XULファイル中の翻訳箇所 [#i1826ed8]
このファイルはXMLで書かれています。
ウィンドウ上の言葉や、メニューの項目名がどのような形で、XULファイル上に記載されているかは、XML言語の文法、XUL言語の表記法の知識が必要になってきます。
ウィンドウ上の言葉や、メニューの項目名がどのような形でXULファイル上に記載されているかは、XML言語の文法、XUL言語の要素や属性についての知識が必要になってきます。

*** DTDファイルの記述 [#q60ced65]
DTDは文書型定義で、XMLでの要素や属性を定義しているファイルです。詳しくはXMLの入門書などを参考にしてもらうとして、XULファイルで使われる文字列を定義するファイルとして使われています。
翻訳の可能性があるのは、次の箇所です。
-要素の label 属性
-要素の accesskey 属性
-window 要素の title 属性
-label 要素の value 属性
-textbox 要素の value 属性
-description 要素の内容
-html 要素が使用できるなら適宜その内容もしくは属性

accesskey 属性は、日本語においては英語のものを訳に関係なくそのまま利用していますが、ヨーロッパの言語などでは、訳に伴い置き換えられる可能性がありますので、置き換え可能な対象にしておく必要があります。

上記の属性を眺めてみて、翻訳の必要なものを探していきます。
そしてその文字列をDTDファイルに記述していきます。

*** DTDファイルの作成 [#gdb76ad2]
DTDは日本語で文書型定義と呼ばれるもので、XMLでの要素や属性を定義しているファイルです。詳しくはXMLの入門書などを参考にしてもらうとして、ここではXULファイルで使われる文字列を定義するファイルとして使われています。

DTDファイルはlocaleフォルダ内に作成します。install.rdfで記述されているその言語のロケール指定の階層にファイルを作ります。

次の記述がinstall.rdfファイル内にあるならば、
 <em:locale>locale/en-US/</em:locale>
この場合は、localeフォルダ内のen-USフォルダに作ります。
次の場合ならば、
 <em:locale>locale/en-US/hoge/</em:locale>
localeフォルダ内のen-USフォルダのhogeフォルダに作ります。

DTDファイルの名前はその拡張の名前に、".dtd"を付けたものが分かりやすいでしょう。
XULファイルが複数あるときはXULファイルに合わせ分割する方法もわかりやすいでしょう。

なお、DTDファイルは、非ASCII文字列を含む場合、UTF-8形式を指定して保存します。

DTDファイルを作成したら、その内容を参照するXULファイル内には DOCUTYPE宣言を追加しておきます。

拡張foo で foo.dtd というDTDファイルを指定する場合、
 <!DOCTYPE hoge SYSTEM "chrome://foo/locale/foo.dtd">
のようになります。hogeの文書タイプ名には、このあとに記述される window, overlay, dialog, wizard 要素名のどれかがきます。

*** DTDファイルの記述と、XULファイルの修正 [#jbbb1fb5]
各翻訳対象の文字列は、次の実体宣言形式で書いていきます。
 <!ENTITY 要素名 "文字列">
文字列が実際に表示される文字列そのもので、要素名がその文字列を参照するための名前です。文字列の部分を別の言語に翻訳したDTDファイルを用意することで、ウィンドウやメニューに現れる言葉を各言語に対応させていくことができます。
 <!ENTITY 名前 "文字列">
文字列が実際に表示される文字列そのもので、名前がその文字列を参照するための名前です。この文字列の部分を別の言語に翻訳したDTDファイルを用意することで、ウィンドウやメニューに現れる言葉を各言語に対応させていくことができます。

ここで宣言された名前をXULファイル中で参照するには、その名前を &と;で挟んで指定します。

DTDファイルで次のように定義された場合、
 <!ENTITY hoge "click me">
XULファイル内のとある部分では、次のように参照できます。
 <button label="&hoge;"/>

このENTITY名には、'.'を入れた記法が使えるので、拡張名、XUL要素名、要素のidなどを組み合わせて、わかりやすい一意の名前を付けていきます。

このようにして、XULファイルをローカリゼーション対応にします。

** Javascriptのローカリゼーション対応 [#f08a5c51]
拡張の動作内容を記述しているのがJS拡張子を持つJavascriptファイルです。このJavascriptで出力される文字列もローカリゼーションの対象となります。

作業の対象は、以下の３種類のファイルです。
-XULファイル
-JSファイル
-PROPERTIESファイル

おおまかな手順は次の通りです。
-localeフォルダに、PROPERTIESファイルを作成する。
-対象となるJavascriptを呼び出しているXULファイルにPROPERTIESファイルを登録する。
-Javascript内の文字列を見渡し、翻訳の対象とすべき文字列がどれかを調べる。
-翻訳対象の文字列に英数字で名前をつけ、それをPROPERTIESファイルに後述の書式に従って、その名前と文字列との対応表を作る。
-JSファイル内の文字列をPROPERTIESファイルの文字列を参照する形式に置き換える。


それでは、細かな手順を示します。

*** PROPERTIESファイルはどこに作るのか。 [#k5f3ea78]

PROPERTIESファイルはlocaleフォルダ内に作ります。これはJavascript内で記述されている文字列の言語のロケールフォルダ内です。例えば英語で記述してありメッセージが英語で出力されるプログラムを作業の対象にする場合は英語ロケールとなり、その言語のinstall.rdfで記述しているロケール指定の階層にファイルを作ります。

例えば、以下のような記述がinstall.rdfファイル内にあるとき、

 <em:locale>locale/en-US/</em:locale>

この場合は、localeフォルダ内のen-USフォルダに作ります。次の場合は、

 <em:locale>locale/en-US/hoge/</em:locale>

localeフォルダ内のen-USフォルダ内のhogeフォルダ内に作ります。


*** PROPERTIESファイルに名前を付ける。 [#wb34d6c9]

名前は任意ですが、その拡張機能の名前にしたほうがわかりやすいでしょう。そして拡張子にpropertiesを付けます。

例えば、拡張機能hogeを作っているときは、hoge.properites とします。

またXULファイル毎にPROPERTIESファイルを用意したり、わかりやすいように複数に分類してもかまわないでしょう。

*** XULファイルへ登録する。 [#f20a8266]

PROPERTIESファイルの登録はそれが使われるXULファイル内で、stringbundleset要素とstringbundle要素を使って登録します。

以下のように登録することで、Javascriptのプログラム内からPROPERTIESファイルの内容を参照することができるようになります。

利用するPROPERTIESファイル毎にわかりやすい任意のidを決めてstringbundle要素を作ります。

例えば、idがhoge-bundle、PROPERTIESファイルがhoge.propertiesのときは、
 <stringbundle id="hoge-bundle" src="chrome://hoge/locale/hoge.properties"/>
となります。

これを、PROPERTIESファイルの数だけ用意して（通常は一つでOK）、全体をstringbundleset要素で囲みます。このstringbundleset要素にも任意のid属性を指定しておきます。

 <stringbundleset id="hoge-bundle-set">
    <stringbundle id="hoge-bundle" src="chrome://hoge/locale/hoge.properties"/>
 </stringbundleset>

*** どの文字列を翻訳対象にするか。 [#z25063be]

Javascriptの書かれているjsファイル内から、文字列の部分を探し出します。これにはJavascriptの文法が分かっていなくてはいけません。また文字列をすべて抜き出してしまえばいいというものでもありません。表示もしくは音声による出力に関連するものや、外部からの入力に対するものなど、プログラムの動作を詳しく分析しながら、判断していきます。

このとき便利なのは、Javascriptの構文を認識し着色してくれるエディタですね。文字列部分を容易に見つけ出せます。もしくは検索で該当箇所を着色してくれる機能があるエディタです。検索には次のような正規表現を使えばいいでしょう。

 ("[^"]*"|'[^']*')


*** PROPERTIESファイルの書き方 [#l3b4882e]
XULファイル内で呼び出されているJavascriptファイルに対して、一つずつ翻訳対象の文字列がないか調べていきます。見つかったら、その情報を先ほどXULファイルに登録したPROPERTIESファイルに、記述していきます。

記述の仕方ですが、文字列を見つけたらそれを指し示す名前を決めます。万人のために英語的な名前にします。この名前の後に'='記号を置いて、さらにその文字列そのものを置きます。文字列を囲む引用符はいりません。

例えば、"Hello,World!"という文字列が見つかったら、PROPERTIESファイルに、
 HelloWorld=Hello,World!
という行を追加します。

既に同じ文字列を示しているものがある場合は追加する必要はありません。ただし、同じ文字列だからといって、同じ意味で使われていないこともあります。

文字列の名前はそのXULファイルに登録してある複数のPROPERTIESファイル間で重複がないように決めていきます。

さて、このときの各行の細かな記法ですが（mozillaのコードを読んだわけでなく経験則です）、
 左辺=右辺
とおくと、

左辺は
-行頭以降で空白以外の文字から始まり、=の左側で空白以外の文字で終わる文字列です。
-この文字列の内部（文字列の最初、最後以外）に空白を含むことができます。
-この文字列に=を含むことはできません。
-この文字列にエスケープコードを含むことはできません。
-左辺がない場合（=が行頭、もしくは左側に空白文字以外無いとき）は、左辺は""と見なされます。

右辺は、
-=以降で空白以外の文字から始まり、空白を含んでもよく、空白以外の文字で終わる文字列です。
-この文字列の内部（文字列の最初、最後以外）に空白を含むことができます。
-この文字列には=を含むことができます。
-行末に\がこない場合は、行末が終端になります。
-行末に\がくる場合は次の行へ継続します。継続されるのは先頭の空白以外の文字からとなります。
-この文字列にはエスケープコードを含むことができます。
-右辺が無い場合、右辺は""と見なされます。

コメント行も作ることができます。

コメント行
-継続されていない行の、行頭（もしくは行頭のいくつかの空白文字のあと）に#のある行はコメント行になります。
-それ以外の場所の#は文字と見なされます。
-コメント行の行末に\を置いても、次の行に継続はされません。

右辺の文字列には変換指定を含むことができます。オリジナルのJSファイルで文字列の足し算を使って処理している部分などをこれを使って表現します。

*** PROPERTIESファイル内の変換指定について [#a5babf10]
文字列中に含むことができる変換指定は、%S です。%dや%xなども用意されているようですが、思い通りの値は出力されないようです。

%S は、文字列の式の値も、数値の式の値も表示してくれますので、実用上問題ないでしょう。なお小文字sを使った %s は最初の一文字だけを表示しました。

翻訳をする上で問題となるのは、語順の問題です。
原文と同じパラメータの順序で文章を作ることはできなくもありませんが、素直な翻訳文を作るためにはパラメータの順序を変えたいなという場面も多々あります。
そんなときは、%とSとの間に「数値$」を入れ、何番目のパラメータを対象にするのかを指定します。
 %S, %S
は
 %1$S, %2$S
と同じです。
これの逆に並べたものは、
 %2$S,  %1$S
となります。


変換指定ではありませんが、mozillaのソース内で見つけたgetStringメソッドを用いた手法があります。それは、PROPERTIESファイルの右辺文字列中に%title%というふうな部分を作っておき、Javascriptのソースの方でそれをgetStringで取り込んだ後、文字列のreplaceメソッドを使って置き換えて使用する方法です。

例えば、プロパティ定義ファイルで
 title=新規ファイル
 message=%title%を作りました。
と定義して、Javascriptファイルで次のように使います。
 var ttl = document.getElementById("foo").getString("title");
 var mes = document.getElementById("foo").getString("message").replace(/%title%/,ttl);
プロパティ定義ファイルで何度も出てくる文字列に名前を付け定数化したり、いろんな応用法が考えられます。


*** PROPERTIESファイルでの漢字等非ASCII文字の保存形式 [#z93e9f54]
現在、この手順は英語のプログラムの改造を書いているので問題はないのですが、
日本語のプログラムなど非ASCII文字の言語をローカリゼーション対応にしているときは、PROPERTIESファイルの保存形式が問題になってきます。

PROPERTIESファイル内の文字には非ASCII文字は使えません。
では、どうやってASCII文字列だけを使いながら、非ASCII文字列を表示するのかというと、
ユニコードエスケープシーケンスという表記法を使います。各文字に割り当てられた文字コードを直接表記していく方法です。
例えば
 文書
は
 \u6587\u66F8
となります。

ではこの変換はどうするのか、対応表を手に入れて手作業で置き換えるのは大変です。これには、RsoureceEditorというJavaで書かれたエディタを使うと便利です。保存するときにASCII（UNICODE\uxxxx）を選べば、この形式で保存できます。
再び編集するときも、ちゃんとした文字の形に自動的に変換して見せてくれるので、人間はまったくこの変換に気をつかう必要はありません。


*** JSファイルの文字列を置き換える。 [#m9d33417]

PROPERTIESファイルに文字列の対応リストができたら、この文字列を参照するようにJSファイルの内容を書き換えていきます。

注意：この作業はJavascriptの内容を直接書き換えていくので、より慎重におこなってください。引用符を消し間違えただけで、この拡張機能は使い物にならなくなってしまいます。一度に多くの文字列を書き換えずに、少しずつ動作を確認しながら、おこなった方が賢明です。

単純な文字列の場合と、文字列や数値のパラメータを実行時に組み込む文字列の場合があります。

***まず、単純な文字列の場合 [#ac8394b1]
getStringメソッドを使います。このメソッドは文字列を引数としてとり、stringbundle内から名前としてさがし、対応する値を文字列で返します。

stringbundleを特定するためにgetElementByIdメソッドを利用して、次のような式になります。

 document.getElementById("foo").getString("bar")

stringbundleのidがfooで、PROPERTIESリスト内の要素名がbarであるときの例です。
これを対象の文字列と置き換えていきます。

PROPERTIESリスト内で次のように名前と文字列が対応しているとき、
 bar=Hello,World！

そしてオリジナルのコードが次のとき、
 shout("Hello,World！")

書き換え後はこのようになります。
 shout( document.getElementById("foo").getString("bar") );

同じ文字列が繰り返し現れるときなどは、エディタについている確認付きの置換コマンドを利用したりしながら、丁寧にやっていきます。しかし一文字違っただけでプログラムは動かなくなったり望んでいる動作ができなくなりますので、とにかく慎重にします。

また、行が長くなるので、document.getElementById("foo")を大域変数に代入しておき、それを活用するなど適宜自分のスタイルに書き換えてください。


***パラメータ付き文字列の場合 [#l7b87d10]
パラメータ付きの文字列の場合、メソッドgetFormattedString利用します。配置の仕方はgetStringと同じで、対象の文字列と置き換えるのですが、引数が一つ多くなります。第二引数に文字列に対するパラメータの配列がきます。パラメータは文字列もしくは数値をとることができます。

PROPERTIESファイルにおいて
 message = %S means %S.

JSファイルにおいて次のように用います。
 var number = 3;
 var word   = "three";
 shout( document.getElementById("foo").getFormattedString("message",[number,word]) );


*** プログラムの変更 [#jfd6a860]
プログラムによっては文字列の置き換えだけでは対応しきれない場合もあるかもしれません。その場合はロケールで条件分岐できるようにプログラムを作りかえて対処します。しかしこの方法だと新たにロケールを追加する毎に、プログラムを書き換えていかなくてはいけないので、あまりおすすめはできません。

PROPERTIESファイルの項目に、ロケールを表す文字列をフラグとして定義することで、簡易的に現在のロケールを獲得できます。

* ローカライズ [#ie062245]
以上の手順でローカリゼーション対応の機能拡張パッケージを作成できたら、翻訳したい言語（今回は当然日本語）で、ローカライズをしていきます。

何をなすべきかが分かっていれば、上記のローカリゼーション対応作業の中で同時並行で、以下の作業をおこなってもかまいません。
**install.rdfへの追加 [#jcd283b4]
**ロケールフォルダの作成 [#a5c56de7]
**DTDファイルの作成 [#x55735a1]
**PROPERTIESファイルの作成 [#w6d33fa5]

* パッケージの仕方 [#be313edc]
Firefox拡張のローカライズ のバックアップ差分(No.13)

Firefox拡張のローカライズのバックアップ差分(No.13)
