PrefBar の使い方
これは PrefBar のユーザーガイドです。PrefBar を使用するのに必要な情報はすべてこのページに収められています。
PrefBar を表示する
ほかのツールバーに PrefBar ボタンを表示する
PrefBar をメニューボタンとして表示する
PrefBar をカスタマイズする
プリセットされたボタンを編集するべきではないのはなぜですか?
ボタンの編集方法
ボタンのインポートとエクスポート
隠された設定
PrefBar を表示する
PrefBar を表示するには [表示] -> [表示/非表示] メニュー (Firefox の場合は [表示] -> [ツールバー] メニュー) で PrefBar を選択するか、キーボードの [F8] キーを押してください。
ほかのツールバーに PrefBar ボタンを表示する
PrefBar は新しいツールバーの形でインストールされますが、それはそのツールバー上でしか PrefBar のボタンを使用する事ができない、ということではありません。PrefBar は "カスタマイズ可能なツールバー" になっています。この事は PrefBar のツールバーに他の拡張機能のボタンを配置することや、逆に PrefBar のボタンを他のツールバーに配置できることを意味しています。実際に他のツールバーで PrefBar を表示する時はツールバー上で右クリックをして "カスタマイズ..." を選択し、移動したい項目をドラッグ & ドロップしてください。
PrefBar をメニューボタンとして表示する
PrefBar はメニューボタン形式でも使用出来ます。このメニューボタンは "PrefBar メニュー" と呼ばれ、ツールバーのカスタマイズダイアログ (詳しくは次を参照: ほかのツールバーに PrefBar ボタンを表示する ) から使用する事ができます。このボタンには PrefBar のすべての機能が収められているのでツールバーを使用したくない場合に便利です。
PrefBar をカスタマイズする
PrefBar をカスタマイズする場合は PrefBar を右クリックし "カスタマイズ..." を選択してください(ツールバー形式のみ)。ブラウザのアドオンマネージャー等からもカスタマイズする事はできますが、コンテキストメニュー経由でカスタマイズダイアログを開く方が簡単でしょう。
カスタマイズウィンドウの左側に使用可能なボタンが、右側に現在ツールバーに表示中のボタンが表示されます。ボタンをツールバーに表示するには表示するボタンを左から右にドラッグ & ドロップしてください。逆にボタンをツールバーから削除する時は、削除するボタンを右から左へドラッグ & ドロップします。またドラッグ & ドロップすることによって表示される順番を変更することも可能です。ボタンの編集などさらなる機能はコンテキストメニューから使用できます。
新しいボタンの作成や編集をするさい次の属性を使用してボタンをカスタマイズできます:
- ID
- すべてのボタンには重複しない固有の ID を割り振る必要があります。ID の長さや使用できる文字に特に制限はありませんが、作成したボタンをインターネット上で公開する場合、すでに存在するボタンの ID と競合しないよう注意する必要があります。
- 表示名
- これはボタンの表示名です。
- onClick
- この属性はボタン形式でのみ使用出来ます。マルチラインエディターを使用して実行したいコードを入力します。ここで書かれたコードはボタンがクリックされると実行されます
- Prefstring
- 制御したいブラウザの設定名を入力します。一般的にブラウザで使用可能な設定名を見つけるにはオプション画面等のソースコードをみるか about:config を調べる必要があります。
- fromPref & topPref
-
この属性はチェックボックスでのみ使用出来ます。ブラウザの設定は (整数値、真偽値、文字列など) 複数の形式にくわえ、そのうちの幾つかは特殊な値を使用します。fromPref & toPref 属性はそれら設定の状態をチェックボックスに表示します。
fromPref 属性はチェックボックスの状態 (true か false) を返します。また JavaScript 形式である必要があります。変数 "value" はチェックボックスの値を返します。そして fromPref 属性に用意されている値は "value" と "!value" です。(あるいは設定の値が整数値の場合 "Boolean(value)" と "Boolean(!value)" が使用されます。いずれの場合にしても最終的な出力は真偽値になります。) また設定の値が文字列の場合、特殊な toPref および fromPref の値を要求します。)
toPref 属性は fromPref 属性の逆の動作をします。つまりチェックボックスの状態をブラウザの設定に反映します。fromPref 属性同様 JavaScript 形式でなくてはならず、ブラウザの設定が使用するのと同じ形式の値である必要があります。変数 "value" にはチェックボックスの状態が "true" か "false" で出力されます。そして toPref 属性に用意されている値は "value" と "!value" に "2*Number(!value)" です。
ブラウザの設定名とその値はドキュメント化されていないため、それらを探すには設定項目を制御するための UI のソースコードを見るのが最善の方法です。もし探している設定が UI 化されていないなら根気が必要となるでしょう。 - Get-function & Set-function
-
この属性はボタンと拡張チェックボックスに拡張メニューリストでのみ使用出来ます。この属性を使用すると指定された PrefBar ボタンがクリックしたりチェックボックスやリストに変更があった時に JavaScript を使用してブラウザの設定の変更や取得を行います。
Get-function は JavaScript を使用してブラウザの設定を PrefBar ボタンに読み込みます。この機能は PrefBar が最新の状態にするたびに実行されます。PrefBar がブラウザの設定値を PreBar ボタンに反映させるために必ず "value" という変数に現在の値を代入してください。
Set-function は JavaScript を使用して PrefBar ボタンの値をブラウザの設定値に代入します。この機能は PrefBar のボタンの状態が変更されるたびに (リストの項目が選択されたりチェックボックスのチェックが付いたり外されたりする) 実行されいます。PrefBar ボタンの値は "value" という名前の変数に収納されています。 - Init-function
- Init-function は JavaScript を入力して使用します。ここで入力されたコードはボタンの初期化時に実行されます。ここでいうボタンの初期化時にはブラウザの起動時だけでなく PrefBar のボタンデータベースへの変更時も含まれます。ですからここに入力されたコードはセッション中に1回だけ実行されるものではない事に気をつけるべきです。
- Framescript
- Framescript が必要とされる状況は限りなく少ないでしょう。そのためこの機能に関する情報はこの文章だけです。簡単に説明すると Framescript は分離プロセス上のタブで PrefBar を使用するためのものです。"Framescript" は "content - process" で動作します。Framescript だけを使用している場合 event - functions で "CallFrameScript" を使用して呼び出すことができます。関数は変数を通して "Framescript" に渡されます。"CallFrameScript" 関数の最初の引数は変数として Framescript に送られます。複数以上の値を扱うために配列やオブジェクトを使用したいと思うかもしれません。"CallFrameScript" 関数の2番目の引数には Framescript が実行後に呼び出されるコールバック関数を使用します。あなたが Framescript に戻り値を指定するなら、その変数はコールバック関数に送られます。非同期処理を行いたい時は "SetValue" を使用します。戻り値を必要としないのであれば "CallFrameScript" の2番目の引数に直接 "SetValue" を指定することもできます。
- 表示名 & 値
- メニューリスト形式のボタンでのみ使用出来ます。Prefstring で指定したブラウザへの設定の値と表示名を入力します。値に "!RESET!" と入れるならその設定はリセット (about:config で [リセット] を選択するのと同じ効果) が得られます。また表示名が入力されていない場合、その項目は無視され表示されません。
- URL
- クリックした時に表示するページの URL を入力します(これはリンクタイプでのみ使用できます)。
- ホットキー
- PrefBar ボタンに "ホットキー" を設定することで、キーボードからそのボタンの機能を呼び出せます。
プリセットされたボタンを編集するべきではないのはなぜですか?
カスタマイズの一環としてプリセットされているボタンに変更を加えるべきではありません。仮にプリセットされたボタンに変更を加えたとしても PrefBar のアップデート時にプリセットされたボタンも最新のものへ上書きされるので、変更はすべて元に戻ってしまいます。もしプリセットされたボタンに変更を加えたい場合は、カスタマイズウィンドウで変更を加えたいボタンを右クリックしコンテキストメニュー内にある "コピー" をクリックして作られた複製に変更を加えて使用してください。
ただし次の場合は除きます:
- ボタンの編集方法 にある、使用するのにボタンの編集を前提としているもの。
- ボタンの表示名。ボタンの表示名は、短くしたり、あなたが覚えやすいものといったように、好みに応じて自由に変更してください。
- もちろんあなたが自分で作ったボタンやインポートしたボタンはその対象ではありません。
編集すべきでないボタンはヘルプページ内にあるボタンの一覧で知ることができます。もしボタンにバグを発見した場合は私に連絡をください。自分で修正して使い続けるべきではありません。PrefBar ボタンの修正は PrefBar チームが責任をもってやります。
ボタンの編集方法
いくつかのボタンの中には特殊な入力形式やプリセットされた変数を使用するものがあります。ここではそれら特殊なボタンの編集方法について説明します。
- 画面の大きさ
-
画面の解像度を追加したい場合は次の形式で入力してください:
$WIDTHx$HEIGHT
ウィンドウの横幅と高さのどちらか片方だけを指定したい場合は、片方の値だけを入力する事で設定できます。例えば横幅だけを設定したい時は "1024x" と入力してください。
- ユーザーエージェント
-
次のふたつの方法でユーザーエージェントを追加できます:
- 文字列を入力してユーザーエージェントを追加する
-
ユーザーエージェント文字列を入力することで、新しいユーザーエージェントを追加できます。例えば Linux 版 Mozilla 1.7.12 を追加する場合は次のように入力します:
Mozilla/5.0 (X11; U; Linux i686; de-AT; rv:1.7.12) Gecko/20050923
- JavaScript を使用してユーザーエージェントを追加する
-
JavaScript を使用することでブラウザのユーザーエージェントや名前にバージョン、さらに使用している OS を分割して入力できます。
JavaScript を使用してユーザーエージェントを追加する場合、文字列の先頭は必ず "js:" で始めます。例えば Windows XP 版の Internet Explorer を追加する場合は次のように入力します:
js:useragent="Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)"; appname="Microsoft Internet Explorer"; appversion="4.0 (compatible; MSIE 6.0; Windows NT 5.1)"; platform="Win32";
- プロキシを選択
-
[プロキシを選択] ボタンは、あなたが使用するプロキシサーバーを設定しないと使用することができません。次の形式で設定してください:
$SERVER:$PORT
次の形式で SOCKS プロキシサーバーを使用出来ます:
socks:$SERVER:$PORT
"$SERVER" にはサーバーの名前か IP アドレスが "$PORT" にはポート番号が入ります。 FTP/HTTP と SOCKS プロキシサーバー をリストに加えることができます。
- 言語識別子
-
言語識別子を自由に追加したり削除できます。
ボタンのインポートとエクスポート
"インポート" と "エクスポート" 機能を使って PrefBar ボタンを "btn" ファイルとして保存したり、逆に PrefBar へボタンをインポートできます。エクスポートしたファイルをインターネット上で配布することであなたが作ったボタンを多くの PrefBar ユーザーに配ることも可能です。
- エクスポート
- PrefBar ボタンをエクスポートするにはカスタマイズダイアログでエクスポートしたいボタンを右クリックし "エクスポート" を選択してください。保存先とファイル名を指定して "保存" をクリックすると指定した保存先に "btn" 拡張子のファイルが作成されます。
- インポート
- "btn" 拡張子のファイルを簡単にインポートするにはカスタマイズダイアログで適当な PrefBar ボタンを右クリックし "インポート" を選択して下さい。ファイルの選択画面でインポートしたい btn ファイルを選択し "開く" をクリックするとインポートが開始されます。もしインポートするボタンの "Id" が既に PrefBar で使用されている場合は上書きを行うか確認します。
隠された設定
PrefBar の動作に影響を与えるいくつかの設定があります。今後この設定を変更するための GUI が用意されるかもしれませんが、about:config を使用して設定を変更する事ができます。
extensions.prefbar.plugintoggle.mode
-
これは Firefox 23 以降のプラグインの動作を切り替えるチェックボックス (例えば PrefBar に標準で付属する Flash や Java 等のチェックボックス) 用のオプションです。
- 0
- "動作させない" と "常に動作させる" を切り替えます (初期設定)
- 1
- "動作させない" と "毎回確認する" を切り替えます
- 2
- "毎回確認する" と "常に動作させる" を切り替えます