Skip to content
This repository has been archived by the owner on Apr 15, 2019. It is now read-only.

Updated Japanese documents. Please merge it. #19

Merged
merged 1 commit into from
Jul 28, 2011
Merged

Updated Japanese documents. Please merge it. #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions doc/ja/TODO
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,3 @@
3. Rewrite bandwidth testing code to be pretty and clean

4. Create a yui-gallery module

5. Add plugin to pull all timing information from native WebTiming API
http://dev.w3.org/2006/webapi/WebTiming/
69 changes: 68 additions & 1 deletion doc/ja/api/BOOMR.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,66 @@ <h2 id="properties">プロパティ</h2>

</dl>

<h2 id="config">設定</h2>
<p>
boomerang の設定については <a href="../howtos/howto-6.html">使用方法 #6 &mdash; boomerang を設定する</a> に記載されています。<code>BOOMR</code> オブジェクトに関係があるパラメーターは:
</p>
<dl>
<dt>beacon_url</dt>
<dd>
<strong>[強く推奨]</strong>
ビーコンの結果を送る URL 。全てのパラメーターはこの URL の QueryString に追加されます。この URL は QueryString 部分を事前に持っておく必要はありません。このパラメーターには初期値はありません。もし設定されていなければビーコンは送信されません。
</dd>

<dt>site_domain</dt>
<dd>
<strong>[推奨]</strong>
全ての Cookie がセットされるドメイン。boomerang はこれを自動判別しようとしますが、あなたのサイトが foo.com の形式の場合を除き、実際には取得に失敗します。これはドメイン間で共有する帯域幅やパフォーマンスを測定したいときに役立ちます。もし複数のドメインを持っている場合はうまくいきません。別々に測定しなければなりません。
</dd>

<dt>user_ip</dt>
<dd>
<strong>[推奨]</strong>
この名前にもかかわらず、これはユーザーのコネクションをユニークに区別するために使われる自由な文字列です。これは主にユーザーの帯域幅を再測定するかどうかの判断に使われるか、または Cookie に格納される値に使われます。IPv4 アドレスや IPv6 アドレスまたはそれ以外のユーザーのコネクションを区別できるものを使うことになります。
</dd>

<dt>log</dt>
<dd>
<strong>[オプション]</strong>
初期値では boomerang は YUI のロガーコンポーネントが見つかればそれを、Firebug が見つかれば代わりにそれを使おうと試みます。どちらもない場合は、初期状態では何もログに残しません。ログメッセージ用の関数のために log パラメーターを設定することで自身のロガーを定義することができます。<br>
この関数については:
<pre>
function log(oMessage, sLevel, sSource);
</pre>
どこに:<dl>
<dt>oMessage</dt> <dd>記録されるオブジェクトまたはメッセージ。記録するオブジェクトを決定するだけです。<dd>
<dt>sLevel</dt> <dd>"error"、"warn"、"info"、"debug" などのログレベル。</dd>
<dt>sSource</dt> <dd>ログメッセージのソース。通常はプラグインの名前がついた "boomerang" の文字列になります。</dd>
</dl>
<code>log</code> に <code>null</code> を設定することでログの記録を無効にできます。
</dd>

<dt>autorun</dt>
<dd>
<strong>[オプション]</strong>
初期値では boomerang は自動的に実行され <code>window.onload</code> イベントに <code>page_ready</code> ハンドラーが登録されます。もし <code>autorun</code> を <code>false</code> にすると、これは起こらず、<code>BOOMR.page_ready()</code> を自分で呼び出す必要があります。
</dd>

<dt>&lt;plugin_name&gt;<dt>
<dd>
それぞれのプラグインは設定オブジェクトのサブオブジェクトを通して設定を行ないます。キーはプラグインの名前になります。ビルトインのプラグインの設定方法については次の各セクションをご覧ください。
</dd>

</dl>

<h2 id="methods">メソッド</h2>

<dl class="api">

<dt>init(oConfig)</dt>
<dd>
<p>
boomerang を初期化するために呼び出すのが init メソッドです。boomerang の JavaScript の読み込みが終わったあとにこのメソッドを一度だけ呼び出します。一つの設定オブジェクトをパラメーターとして受け取ります。設定オブジェクトについては <a href="../howtos/howto-6.html">使用方法 #6 &mdash; Configuring boomerang</a> に記述しています。
boomerang を初期化するために呼び出すのが init メソッドです。boomerang の JavaScript の読み込みが終わったあとにこのメソッドを一度だけ呼び出します。一つの設定オブジェクトをパラメーターとして受け取ります。詳細は <a href="#config">設定項目の説明</a> をご覧ください。
</p>
<h3>返り値</h3>
<p>
Expand Down Expand Up @@ -244,7 +296,22 @@ <h3>コールバック</h3>

</dl>

<h2 id="beacon">ビーコンパラメーター</h2>
<p>
独自のプラグインがない場合、boomerang はビーコンを通して次のパラメーターを送ります:
</p>
<dl>
<dt>v</dt>
<dd>使用している boomerang ライブラリーのバージョン。</dd>
<dt>u</dt>
<dd>ビーコンを送るページの URL 。</dd>
</dl>

<p>
プラグインによってはそれぞれのプラグインの API ドキュメントに記述されている独自のパラメーターを追加するかもしれません。
</p>

<p class="perma-link">
最新のソースコードとドキュメントは <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a> に公開されています。
</p>

Expand Down
2 changes: 1 addition & 1 deletion doc/ja/api/BOOMR.utils.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ <h3>返り値</h3>

</dl>

<p>
<p class="perma-link">
最新のソースコードとドキュメントは <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a> に公開されています。
</p>

Expand Down
59 changes: 58 additions & 1 deletion doc/ja/api/BW.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,59 @@ <h1>帯域幅/遅延 プラグイン API</h1>
帯域幅プラグインはサーバーへのユーザーのネットワークコネクションの帯域幅と遅延を測定します。帯域幅 API は <code>BOOMR.plugins.BW</code> に内包されます。
</p>

<h2 id="config">Configuration</h2>
<p>
bandwidth プラグインの全ての設定は <code>BW</code> の名前空間の下に入ります。設定オブジェクトについては <a href="../howtos/howto-6.html">使用方法 #6 &mdash; boomerang の設定</a> をご覧ください。
</p>
<dl>
<dt>base_url</dt>
<dd>
<strong>[推奨]</strong>
初期値では、bandwidth プラグインは帯域幅測定用の画像を現在のページのディレクトリーの <code>images/</code> サブディレクトリーから見つけます。これはあなたのサイト上の全てのページで正しいとは限りません。画像があるディレクトリーのパスを <code>base_url</code> パラメーターで設定ができます。絶対 URL または相対 URL で指定ができます。相対パスの場合、JavaScript ファイルからではなく boomerang が読み込まれたページからの相対パスになることを覚えておいてください。
</dd>

<dt>cookie</dt>
<dd>
<strong>[オプション]</strong>
ユーザーのコネクションの帯域幅と遅延の測定結果を格納する Cookie の名前。初期値は <code>BA</code> です。詳細は <a href="howto-3.html">使用方法 #3</a> をご覧ください。Cookie を無視して開始時間を完全に WebTiming API に依存させるには、ここに <code>null</code> のような偽の値か空文字を指定します。
</dd>

<dt>cookie_exp</dt>
<dd>
<strong>[オプション]</strong>
秒で表した Cookie の有効期限。初期値は7日間です。これはユーザーの帯域幅テストを再度行うまでにどれくらい空けるかを記述します。IP アドレスをもとにその間は変更されません。ネットワークコネクションの帯域幅は通常は定期的に大きくは変わらないため、実際はこの設定を何も変更する必要はありません。<br>
もしあなたがレアルタイムストリーミングのようなことを行っている場合、帯域幅のテストは適切ではなく、Cookie に短い値を設定するのは正しい方法ではありません。
</dd>

<dt>timeout</dt>
<dd>
<strong>[オプション]</strong>
ミリ秒で表した帯域幅のテスト全体のタイムアウト値。初期値は15秒です。帯域幅のテストは長時間実行できるため、時々ネットワークエラーが発生し終了しないかもしれません。タイムアウトは強制的にテストを終了させます。これはハードリミットです。もしタイムアウトになると、テストの続行を停止してこの時点で取得できているデータから帯域幅を計算しようとします。タイムアウトを長くすればさらに多くのデータを取得し精度を向上できますが、長くした分、ユーザーがページを離れる前にテストが終了しないリスクも増えます。
</dd>

<dt>nruns</dt>
<dd>
<strong>[オプション]</strong>
帯域幅のテストを実行する回数。初期値は5回です。初回のテストは常に残りのテストを続行するためにベストな計算をするための試験的なものです。この回数が増えるとテストの精度も向上していきますが、増やした分、テストがタイムアウトするリスクも増えます。これは実行毎に約2秒から4秒かかるため、この値は <code>timeout</code> の値よりも超えるように考慮しなければなりません。
</dd>

</dl>


<h2 id="methods">メソッド</h2>

<dl class="api">

<dt>init(oConfig)</dt>
<dd>
<p>
帯域幅プラグインを設定するために <a href="BOOMR.html#init">BOOMR.init()</a> メソッドによって呼び出されます。設定オブジェクトについては <a href="../howtos/howto-6.html">使用方法 #6 &mdash; boomerang の設定</a> をご覧ください。
帯域幅プラグインを設定するために <a href="BOOMR.html#init">BOOMR.init()</a> メソッドによって呼び出されます。
</p>
<h3>パラメーター</h3>
<dl>
<dt>oConfig</dt>
<dd><code>BOOMR.init()</code> を通して渡された設定オブジェクト。詳しくは <a href="#config">設定項目の説明</a> をご覧ください。
</dl>
<h3>返り値</h3>
<p>
<code>BOOMR.plugins.BW</code> オブジェクトへの参照。メソッドチェーンをサポートします。
Expand Down Expand Up @@ -64,7 +108,20 @@ <h3>返り値</h3>

</dl>

<h2 id="beacon">ビーコンパラメーター</h2>
<p>
このプラグインはビーコンに次のパラメーターを追加します:
</p>
<dl>
<dt>bw</dt> <dd>秒間のバイト数にしたユーザーの測定された帯域幅</dd>
<dt>bw_err</dt> <dd>測定したユーザーの帯域幅でエラーを除いた95%信頼できる値</dd>
<dt>lat</dt> <dd>ミリ秒にしたユーザーの HTTP 遅延</dd>
<dt>lat_err</dt> <dd>測定したユーザーの HTTP 遅延でエラーを除いた95%信頼できる値</dd>
<dt>bw_time</dt> <dd>帯域幅と遅延を測定したときのユーザーのブラウザーのタイムスタンプ</dd>
</dl>


<p class="perma-link">
最新のソースコードとドキュメントは <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a> に公開されています。
</p>

Expand Down
9 changes: 9 additions & 0 deletions doc/ja/api/DNS.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,16 @@ <h3>返り値</h3>

</dl>

<h2 id="beacon">ビーコンパラメーター</h2>
<p>
このプラグインはビーコンに次のパラメーターを追加します:
</p>
<dl>
<dt>dns</dt>
<dd>ユーザーのブラウザーから DNS サーバーまでの最も遅い DNS 遅延。</dd>
</dl>

<p class="perma-link">
最新のソースコードとドキュメントは <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a> に公開されています。
</p>

Expand Down
50 changes: 49 additions & 1 deletion doc/ja/api/RT.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,49 @@ <h1>Roundtrip プラグイン API</h1>
roundtrip プラグインはページの読み込み時間を測定したりページにタイマーを連動させたりします。この API は <code>BOOMR.plugins.RT</code> に内包されます。
</p>

<h2 id="config">Configuration</h2>

<p>
roundtrip プラグインの全ての設定は <code>RT</code> の名前空間の下に入ります。設定オブジェクトについては <a href="../howtos/howto-6.html">使用方法 #6 &mdash; boomerang の設定</a> に記載しています。
</p>
<dl>

<dt>cookie</dt>
<dd>
<strong>[オプション]</strong>
ページの読み込み時間を測定するための開始時間を格納する Cookie の名前。初期値は <code>RT</code> になります。
</dd>

<dt>cookie_exp</dt>
<dd>
<strong>[オプション]</strong>
秒で表した Cookie の有効期間。これは1つのページの読み込みに負荷がかかるためできるだけ長くする必要があります。10秒以上にすればほとんどの場合は問題ありませんが、念のため遅いコネクションのユーザーをカバーするためや、地理的に遠いユーザーのために、数分は維持します。初期値は10分です。
</dd>

<dt>strict_referrer</dt>
<dd>
<strong>[オプション]</strong>
初期値では boomerang は現在のページの <code>document.referrer</code> に <code>RT</code> Cookie が一致しなければページの往復時間は測定しません。これは <code>RT</code> Cookie がまだ有効な状態で3番目のページを訪れたからということを意味し、ページの読み込み時間は無効となる可能性があります。<br>
このようなこともあるかもしれませんが、こういった場合は有効です &mdash; 例えば、SSL のページ間でリファラーが渡されません。この場合は、<code>strict_referrer</code> を <code>false</code> にすればいいでしょう。
</dd>

</dl>


<h2 id="methods">メソッド</h2>

<dl class="api">

<dt>init(oConfig)</dt>
<dd>
<p>
roundtrip プラグインを設定するために呼び出される <a href="BOOMR.html#init">BOOMR.init()</a> メソッドです。設定オブジェクトについては <a href="../howtos/howto-6.html">使用方法 #6 &mdash; boomerang の設定</a> に記載しています。
roundtrip プラグインを設定するために呼び出される <a href="BOOMR.html#init">BOOMR.init()</a> メソッドです。
</p>
<h3>パラメーター</h3>
<dl>
<dt>oConfig</dt>
<dd><code>BOOMR.init()</code> を通して渡された設定オブジェクト。詳しくは <a href="#config">設定項目の説明</a> をご覧ください。
</dl>
<h3>返り値</h3>
<p>
<code>BOOMR.plugins.RT</code> オブジェクトへの参照。メソッドチェーンをサポートします。
Expand Down Expand Up @@ -144,7 +178,21 @@ <h3>Returns</h3>

</dl>

<h2 id="beacon">ビーコンパラメーター</h2>
<p>
このプラグインはビーコンに次のパラメーターを追加します:
</p>
<dl>
<dt>t_done</dt> <dd><strong>[オプション]</strong>ページの往復時間。</dd>
<dt>t_page</dt> <dd><strong>[オプション]</strong>ページの先頭から page_ready までにかかった時間。開発を加える必要があります。</dd>
<dt>t_other</dt> <dd><strong>[オプション]</strong>ページの開発者によって設定されたコンマ区切りのタイマーのリスト。それぞれのタイマーのフォーマットは <code>name|value</code> になります。</dd>
<dt>r</dt> <dd>ビーコンの開始時間を設定したページの URL 。</dd>
<dt>r2</dt> <dd><strong>[オプション]</strong>現在のページのリファラーの URL 。<code>r</code> と異なり、<code>strict_referrer</code> が明示的にオフになっている場合のみ設定されます。</dd>
</dl>



<p class="perma-link">
最新のソースコードとドキュメントは <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a> に公開されています。
</p>

Expand Down
6 changes: 5 additions & 1 deletion doc/ja/api/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,13 @@ <h2>コアプラグイン</h2>
<h2>追加プラグイン</h2>
<ul>
<li><a href="DNS.html">BOOMR.plugins.DNS</a> &mdash; ユーザーの DNS の遅延を測定するプラグイン</li>

<li><a href="ipv6.html">BOOMR.plugins.IPv6</a> &mdash; IPv6 関連のさまざまな測定を行う IPv6 レイテンシープラグイン</li>

<li><a href="navtiming.html">BOOMR.plugins.NavigationTiming</a> &mdash; W3C Navigation Timing 仕様を実装しているユーザーエージェントからパフォーマンスデータを収集するプラグイン</li>
</ul>

<p>
<p class="perma-link">
最新のソースコードとドキュメントは <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a> に公開されています。
</p>

Expand Down
Loading