Merge pull request #4231 from yamatoya/master

📝Add Japanes translated docs.
2016-01-26 20:32:01 +08:00 · 2016-01-26 20:32:01 +08:00 · f87edba7fb
commit f87edba7fb
parent 4c43be2148 ab8e6650bd
3 changed files with 403 additions and 0 deletions
--- a/docs-translations/jp/api/content-tracing.md
+++ b/docs-translations/jp/api/content-tracing.md
@ -0,0 +1,129 @@
+# contentTracing
+
+`content-tracing`モジュールは、Chromiumコンテンツモジュールによって生成されるトーレスデータを収集するのに使われます。このモジュールはウェブインターフェイスを含んでいないので、Chromeブラウザーで `chrome://tracing/`を開いて、結果を表示するために生成されたファイルを読み込む必要があります。
+
+```javascript
+const contentTracing = require('electron').contentTracing;
+
+const options = {
+  categoryFilter: '*',
+  traceOptions: 'record-until-full,enable-sampling'
+}
+
+contentTracing.startRecording(options, function() {
+  console.log('Tracing started');
+
+  setTimeout(function() {
+    contentTracing.stopRecording('', function(path) {
+      console.log('Tracing data recorded to ' + path);
+    });
+  }, 5000);
+});
+```
+
+## メソッド
+
+`content-tracing`モジュールは次のメソッドを持っています。
+
+### `contentTracing.getCategories(callback)`
+
+* `callback` Function
+
+カテゴリグループ一式を取得します。新しいコードパスに到達しているとしてカテゴリグループを変更できます。
+
+一度、全ての子プロセスが`getCategories`リクエストを認識すると、カテゴリグループの配列で`callback`が呼び出されます。
+
+### `contentTracing.startRecording(options, callback)`
+
+* `options` Object
+  * `categoryFilter` String
+  * `traceOptions` String
+* `callback` Function
+
+全てのプロセスで記録を開始します。
+
+EnableRecordingリクエストを受信するとすぐに、子プロセス上でただちに非同期にローカルに記録を始めます。全ての子プロセスが`startRecording`リクエストを認識すると、`callback`が呼び出されます。
+
+`categoryFilter`はどのカテゴリグループをトレースすべきかをフィルタリングします。フィルターは、マッチしたカテゴリーを含むカテゴリグループを除外する`-`プレフィックスをオプションうぃ持っています。同じリストでの、対象カテゴリパターンと、除外カテゴリーパターンの両方を持つことはサポートしていません。
+
+例:
+
+* `test_MyTest*`,
+* `test_MyTest*,test_OtherStuff`,
+* `"-excluded_category1,-excluded_category2`
+
+`traceOptions` は、どの種類のトレースを有効にするかを制御し、コンマ区切りのリストです。
+
+取りうるオプション:
+
+* `record-until-full`
+* `record-continuously`
+* `trace-to-console`
+* `enable-sampling`
+* `enable-systrace`
+
+最初の3つのオプションは、トレースの記録モードで、そのため相互排他的です。`traceOptions`文字列に1つ以上のトレース記録モードが現れると、最後のモードが優先されます。トレース記録モードが指定されていない場合、記録モードは、`record-until-full`です。
+
+適用される`traceOptions`からオプションをパースする前に、トレースオプションは最初に既定のオプションにリセットされます（`record_mode`は、`record-until-full`を設定し、 `enable_sampling`と `enable_systrace` は `false`に設定します）。
+
+### `contentTracing.stopRecording(resultFilePath, callback)`
+
+* `resultFilePath` String
+* `callback` Function
+
+全てのプロセスで記録を止めます。
+
+子プロセスは基本的にトレースデータをキャッシュし、まれにフラッシュし、メインプロセスにトレースデータを送り返します。IPC越しにトレースデータを送信するのは高コストな操作なので、トレースのランタイムオーバーヘッドを最小限にするのに役立ちます。トレースが終了すると、保留されているトレースデータのフラッシュをするためにすべての子プロセスに非道に問い合わせすべきです。
+
+
+一度、すべての子プロセスが`stopRecording` リクエストを認識すると、トレースデータを含んだファイルで`callback`が呼び出されます。
+
+トレースデータは`resultFilePath`が空でなければ、そこに書き込まれ、空の場合は一時ファイルに書き込まれます。実際のファイルパスは`null`でなければ `callback` に通します。
+
+### `contentTracing.startMonitoring(options, callback)`
+
+* `options` Object
+  * `categoryFilter` String
+  * `traceOptions` String
+* `callback` Function
+
+全てのプロセス上で監視を開始します。
+
+`startMonitoring`リクエスト受信するとすぐに、子プロセス上でローカルに非同期にただちに監視を始めます。
+
+全ての子プロセスが`startMonitoring`リクエストを認識すると、`callback`がコールされます。
+
+### `contentTracing.stopMonitoring(callback)`
+
+* `callback` Function
+
+全てのプロセス上で監視を止めます。
+
+全ての子プロセスが`stopMonitoring`リクエスト認識すると、`callback`がコールされます。
+
+### `contentTracing.captureMonitoringSnapshot(resultFilePath, callback)`
+
+* `resultFilePath` String
+* `callback` Function
+
+現在の監視トレースデータを取得します。子プロセスは基本的にトレースデータをキャッシュし、まれにフラッシュし、メインプロセスにトレースデータを送り返します。IPC越しにトレースデータを送信するのは高コストな操作なので、トレースによる不必要なランタイムオーバーヘッドを避けるます。トレースが終了するために、保留されているトレースデータのフラッシュをするためにすべての子プロセスに非道に問い合わせすべきです。
+
+全ての子プロセスが`captureMonitoringSnapshot`リクエストを認識すると、トレースデータを含んだファイルで`callback`が呼び出されます。
+
+### `contentTracing.getTraceBufferUsage(callback)`
+
+* `callback` Function
+
+プロセスのトレースバッファのプロセス間で最大使用量をフルの状態の何%かで取得します。TraceBufferUsage値が設定されていると、 `callback`がコールされます。
+
+### `contentTracing.setWatchEvent(categoryName, eventName, callback)`
+
+* `categoryName` String
+* `eventName` String
+* `callback` Function
+
+プロセス上でイベント発生すると、その度に`callback`がコールされます。
+
+### `contentTracing.cancelWatchEvent()`
+
+イベントウオッチをキャンセルします。トレースが有効になっていると、監視イベントのコールバックとの競合状態になる可能性があります。
--- a/docs-translations/jp/api/protocol.md
+++ b/docs-translations/jp/api/protocol.md
@ -0,0 +1,150 @@
+# protocol
+
+`protocol`モジュールはカスタムプロトコルを登録したり、または既存のプロトコルをインターセプタ―することができます。
+
+`file://`プロトコルの同様の効果をもつプロトコルを実装した例です。
+
+```javascript
+const electron = require('electron');
+const app = electron.app;
+const path = require('path');
+
+app.on('ready', function() {
+    var protocol = electron.protocol;
+    protocol.registerFileProtocol('atom', function(request, callback) {
+      var url = request.url.substr(7);
+      callback({path: path.normalize(__dirname + '/' + url)});
+    }, function (error) {
+      if (error)
+        console.error('Failed to register protocol')
+    });
+});
+```
+
+**Note:** このモジュールは、`app`モジュールで`ready`イベントが出力された後のみ使うことができます。
+
+## メソッド
+
+`protocol`モジュールは、次のメソッドを持ちます。
+
+### `protocol.registerStandardSchemes(schemes)`
+
+* `schemes` Array - 標準的なスキーマーを登録するためのカスタムスキーマー
+
+標準的な`scheme`は、RFC 3986で策定している[generic URI syntax](https://tools.ietf.org/html/rfc3986#section-3)に準拠しています。これには`file:` と `filesystem:`を含んでいます。
+
+### `protocol.registerServiceWorkerSchemes(schemes)`
+
+* `schemes` Array - サービスワーカーをハンドルするために登録されたカスタムスキーマー
+
+### `protocol.registerFileProtocol(scheme, handler[, completion])`
+
+* `scheme` String
+* `handler` Function
+* `completion` Function (optional)
+
+レスポンスとしてファイルを送信する`scheme`のプロトコルを登録します。`scheme`で`request`が生成された時、`handler`は`handler(request, callback)`で呼び出されます。`scheme` 登録が成功したり、`completion(error)`が失敗したときに、`completion` は`completion(null)`で呼び出されます。
+
+`request`をハンドルするために、`callback`はファイルパスまたは`path`プロパティを持つオブジェクトで呼び出すべきです。例えば、`callback(filePath)` または`callback({path: filePath})`です。
+
+何もなし、数字、`error`プロパティを持つオブジェクトで、`callback`が呼び出された時、 `request`は指定した`error`番号で失敗します。使用できる提供されているエラー番号は、[net error list](https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h)を参照してください。
+
+既定では、`scheme`は、`file:`のような一般的なURIの構文に続くプロトコルと違う解析がされ、`http:`のように扱われます。なので、恐らく標準的なスキーマーのように扱われるスキーマーを持つために、`protocol.registerStandardSchemes` を呼び出したくなります。
+
+### `protocol.registerBufferProtocol(scheme, handler[, completion])`
+
+* `scheme` String
+* `handler` Function
+* `completion` Function (optional)
+
+レスポンスとして`Buffer`を送信する`scheme`プロトコルを登録します。`callback`は、`Buffer`オブジェクトまたは`data`と `mimeType`、`chart`プロパティを持つオブジェクトを呼び出す必要があります。
+
+例:
+
+```javascript
+protocol.registerBufferProtocol('atom', function(request, callback) {
+  callback({mimeType: 'text/html', data: new Buffer('<h5>Response</h5>')});
+}, function (error) {
+  if (error)
+    console.error('Failed to register protocol')
+});
+```
+
+### `protocol.registerStringProtocol(scheme, handler[, completion])`
+
+* `scheme` String
+* `handler` Function
+* `completion` Function (optional)
+
+レスポンスとして`String`を送信する`scheme`プロトコルを登録します。`callback`は、`String`または`data`と `mimeType`、`chart`プロパティを持つオブジェクトを呼び出す必要があります。
+
+### `protocol.registerHttpProtocol(scheme, handler[, completion])`
+
+* `scheme` String
+* `handler` Function
+* `completion` Function (optional)
+
+レスポンスとしてHTTPリクエストを送信する`scheme`プロトコルを登録します。`callback`は、`url`と`method`、`referrer`、`uploadData`、`session`プロパティを持つオブジェクトを呼び出す必要があります。
+
+既定では、HTTPリクエストは現在のセッションを再利用します。別のセッションでリクエストをしたい場合、`session` に `null`を設定する必要があります。
+
+POSTリクエストは`uploadData`オブジェクトを提供する必要があります。
+* `uploadData` object
+  * `contentType` String - コンテンツのMIMEタイプ
+  *  `data` String - 送信されるコンテンツ
+
+### `protocol.unregisterProtocol(scheme[, completion])`
+
+* `scheme` String
+* `completion` Function (optional)
+
+`scheme`のカスタムプロトコルを解除します。
+
+### `protocol.isProtocolHandled(scheme, callback)`
+
+* `scheme` String
+* `callback` Function
+
+`scheme`のハンドラーがあるかないかを示すブーリアン値で`callback`がコールされます。
+
+### `protocol.interceptFileProtocol(scheme, handler[, completion])`
+
+* `scheme` String
+* `handler` Function
+* `completion` Function (optional)
+
+`scheme`プロトコルをインターセプタ―し、レスポンスとしてファイルを送信するプロトコルの新しいハンドラーとして`handler`を使います。
+
+### `protocol.interceptStringProtocol(scheme, handler[, completion])`
+
+* `scheme` String
+* `handler` Function
+* `completion` Function (optional)
+
+`scheme`プロトコルをインターセプタ―し、レスポンスとして`String`を送信するプロトコルの新しいハンドラーとして`handler`を使います。
+
+### `protocol.interceptBufferProtocol(scheme, handler[, completion])`
+
+* `scheme` String
+* `handler` Function
+* `completion` Function (optional)
+
+`scheme`プロトコルをインターセプタ―し、レスポンスとして`Buffer`を送信するプロトコルの新しいハンドラーとして`handler`を使います。
+
+### `protocol.interceptHttpProtocol(scheme, handler[, completion])`
+
+* `scheme` String
+* `handler` Function
+* `completion` Function (optional)
+
+`scheme`プロトコルをインターセプタ―し、レスポンスとして新しいHTTPリクエストを送信するプロトコルの新しいハンドラーとして`handler`を使います。
+
+Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
+which sends a new HTTP request as a response.
+
+### `protocol.uninterceptProtocol(scheme[, completion])`
+
+* `scheme` String
+* `completion` Function
+
+インターセプタ―したインストールされた`scheme`を削除し、オリジナルハンドラーをリストアします。
--- a/docs-translations/jp/api/remote.md
+++ b/docs-translations/jp/api/remote.md
@ -0,0 +1,124 @@
+# remote
+
+ `remote`モジュールは、レンダラープロセス（ウェブページ）とメインプロセス間でインタープロセスコミュニケーション（IPC）をする簡単な方法を提供します。
+
+Electronでは、GUI関連モジュール（`dialog`や`menu`など）はメインプロセスのみに提供されており、レンダラープロセスには提供されていません。レンダラープロセスからそれらを使うために、`ipc`モジュールはメインプロセスにインタープロセスメッセージを送信するのに必要です。`remote`モジュールで、Javaの[RMI][rmi]と同じように、はっきりとインタープロセスメッセージを送信しなくてもメインプロセスオブジェクトのメソッドを呼び出せます。
+
+レンダラープロセスからブラウザーウィンドウを作成する例：
+
+```javascript
+const remote = require('electron').remote;
+const BrowserWindow = remote.BrowserWindow;
+
+var win = new BrowserWindow({ width: 800, height: 600 });
+win.loadURL('https://github.com');
+```
+
+**Note:** 逆には（メインプロセスからレンダラープロセスにアクセスする）、[webContents.executeJavascript](web-contents.md#webcontentsexecutejavascriptcode-usergesture)が使えます。
+
+## Remote オブジェクト
+
+`remote`モジュールから返されるそれぞれのオブジェクト（関数含む）はメインプロセスでオブジェクトを示します（リモートオブジェクトまたはリモート関数と呼ばれます）。リモートプロジェクトのメソッドを実行したり、リモート関数をコールしたり、リモートコンストラクター（関数）で新しいオブジェクトを生成したりしたとき、実際に非同期にインタープロセスメッセージが送信されます。
+
+上の例では、`BrowserWindow` と `win` はリモートオブジェクトで、`new BrowserWindow`はレンダラープロセスで `BrowserWindow`を作成しません。代わりに、メインプロセスで`BrowserWindow` オブジェクトが作成され、レンダラープロセスで対応するリモートオブジェクトを返し、すなわち`win`オブジェクトです。
+
+リモート経由でのみアクセスできる [enumerable properties](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Enumerability_and_ownership_of_properties)に注意してください。
+
+## Remote オブジェクトのライフタイム
+
+Electronは、レンダラープロセスのリモートオブジェクトが生きている限り（言い換えれば、ガベージコレクションされません）、対応するメインプロセスのオブジェクトは解放されないことを確認してください。リモートオブジェクトがガベージコレクションされたとき、対応するメインプロセスのオブジェクトが間接参照されます。
+
+レンダラープロセスでリモートオブジェクトがリークした場合（マップに格納されているが解放されない）、メインプロセスで対応するオブジェクトもリークするので、リモートオブジェクトがリークしないように細心の注意を払うべきです。
+
+文字列や数字のようなプライマリ値は、コピーして送信します。
+
+## メインプロセスにコールバックを通す
+
+メインプロセスのコードは、レンダラーからコールバックを受け取ることができます。例えば、`remote`モジュールです。この機能をとても慎重に使うべきです。
+
+最初に、デッドロックを避けるために、メインプロセスに渡されたコールバックは非同期に呼び出されます。メインプロセスは、渡されたコールバックの戻り値を取得することを期待すべきではありません。
+
+例えば、メインプロセスでコールされた`Array.map`で、レンダラープロセスから関数を使用することはできません。:
+
+```javascript
+// main process mapNumbers.js
+exports.withRendererCallback = function(mapper) {
+  return [1,2,3].map(mapper);
+}
+
+exports.withLocalCallback = function() {
+  return exports.mapNumbers(function(x) {
+    return x + 1;
+  });
+}
+```
+
+```javascript
+// renderer process
+var mapNumbers = require("remote").require("./mapNumbers");
+
+var withRendererCb = mapNumbers.withRendererCallback(function(x) {
+  return x + 1;
+})
+
+var withLocalCb = mapNumbers.withLocalCallback()
+
+console.log(withRendererCb, withLocalCb) // [true, true, true], [2, 3, 4]
+```
+
+見ることができるように、レンダラーコールバックの同期戻り値は予想されなかったとして、メインプロセスで生きている同一のコールバックの戻り値と一致しません。
+
+第二に、メインプロセスに渡されるコールバックはメインプロセスがガベージコレクトするまで存続します。
+
+例えば、次のコードは一目で無害なコードのように思えます。リモートオブジェクト上で`close`イベントのコールバックをインストールしています。
+
+```javascript
+remote.getCurrentWindow().on('close', function() {
+  // blabla...
+});
+```
+
+りかし、明確にアンインストールするまでメインプロセスによってコールバックは参照されることを覚えておいてください。アンインストールしない場合、ウィンドウをリロードするたびに、コールバックは再度インストールされ、それぞれの再起動時にコールバックあリークします。
+
+さらに悪いことに、前にインストールされたコールバックのコンテキストは解放されるので、`close`イベントを出力されると、メインプロセスで例外が発生します。
+
+この問題を避けるために、メインプロセスに渡されたレンダラーコールバックへの参照をクリーンアップを確認します。これにはイベントハンドラーのクリンアップも含まれ、存在しているレンダラープロセスから来るコールバックを確実にメインプロセスが守るように確認します。
+
+## メインプロセスで組み込みモジュールにアクセスする
+
+メインプロセスの組み込みモジュールは、`remote`モジュールでゲッターとして追加されるので、`electron`モジュールのように直接それらを使用できます。
+
+```javascript
+const app = remote.app;
+```
+
+## メソッド
+
+`remote`モジュールは次のメソッドを持ちます。
+
+### `remote.require(module)`
+
+* `module` String
+
+メインプロセスで、`require(module)`で返されるオブジェクトを返します。
+
+### `remote.getCurrentWindow()`
+
+このウェブページに属する[`BrowserWindow`](browser-window.md) オブジェクトを返します。
+
+### `remote.getCurrentWebContents()`
+
+このウェブページの[`WebContents`](web-contents.md) オブジェクトを返します。
+
+### `remote.getGlobal(name)`
+
+* `name` String
+
+メインプロセスで、`name`のグローバル変数（例えば、`global[name]`）を返します。
+
+
+### `remote.process`
+
+メインプロセスで`process`オブジェクトを返します。これは`remote.getGlobal('process')`と同様ですが、キャッシュされます。
+
+[rmi]: http://en.wikipedia.org/wiki/Java_remote_method_invocation