From 77eb0e8e3f9e58e2dda0d9b123ac565b81e9394d Mon Sep 17 00:00:00 2001 From: TAKAHASHI Kyohei Date: Fri, 20 May 2016 21:20:53 +0900 Subject: [PATCH] Japanese manual: Update tutorials and api [ci skip] --- .../jp/api/chrome-command-line-switches.md | 30 ++++--- .../jp/api/environment-variables.md | 5 +- docs-translations/jp/api/process.md | 75 ++++++++++++++--- docs-translations/jp/api/synopsis.md | 39 +++++---- .../desktop-environment-integration.md | 50 ++++++------ .../jp/tutorial/online-offline-events.md | 22 ++--- docs-translations/jp/tutorial/quick-start.md | 80 +++++++++++-------- 7 files changed, 185 insertions(+), 116 deletions(-) diff --git a/docs-translations/jp/api/chrome-command-line-switches.md b/docs-translations/jp/api/chrome-command-line-switches.md index b3359eb322ce..b041cf3baffb 100644 --- a/docs-translations/jp/api/chrome-command-line-switches.md +++ b/docs-translations/jp/api/chrome-command-line-switches.md @@ -1,29 +1,32 @@ #サポートしているChromeコマンドラインスイッチ -ElectronでサポートしているChromeブラウザーで使用できるコマンドラインスイッチをこのページで一覧にしています。[app][app]モジュールの[ready][ready]イベントが出力される前にアプリのメインスクリプトに追加するために[app.commandLine.appendSwitch][append-switch]を使えます。 +> Electronでサポートされているコマンドラインスイッチ + +アプリケーションのメインスクリプトで[app.commandLine.appendSwitch][append-switch]を使うことで、[app][app]モジュールの[ready][ready]イベントが発行される前にコマンドラインスイッチを追加できます。 ```javascript -const app = require('electron').app; +const {app} = require('electron'); app.commandLine.appendSwitch('remote-debugging-port', '8315'); app.commandLine.appendSwitch('host-rules', 'MAP * 127.0.0.1'); -app.on('ready', function() { +app.on('ready', () => { // Your code here }); ``` -## --client-certificate=`path` - -クライアントの証明書ファイルの`path`を設定します。 ## --ignore-connections-limit=`domains` -接続数の制限を無視する`,`で分割した`domains`リスト +`domains`で指定されたリストは接続数制限を無視します。リストは`,`で区切られます。 ## --disable-http-cache HTTPリクエストのディスクキャッシュの無効化。 +## --disable-http2 + +HTTP/2 と SPDY/3.1 プロトコルを無効にします。 + ## --remote-debugging-port=`port` `port`で指定したHTTP越しのリモートデバッグの有効化。 @@ -42,7 +45,8 @@ $ electron --js-flags="--harmony_proxies --harmony_collections" your-app ## --proxy-bypass-list=`hosts` -ホスト一覧をセミコロンで分割したプロキシサーバーをバイパスしてするためにElectronに指示します。このフラグは、`--proxy-server`と同時に使われるときのみに影響します。 +プロキシを使用しないサーバーをセミコロンで区切って指定します。 +このフラグは、`--proxy-server`と同時に使われるときのみに影響します。 例: @@ -50,7 +54,7 @@ $ electron --js-flags="--harmony_proxies --harmony_collections" your-app app.commandLine.appendSwitch('proxy-bypass-list', ';*.google.com;*foo.com;1.2.3.4:5678') ``` -ロカールアドレス（`localhost`や`127.0.0.1`など）、`google.com`サブドメイン、`foo.com` サフィックスを含むホスト、`1.2.3.4:5678`を除いてすべてのホストでプロキシサーバーが使われます。 +ローカルアドレス（`localhost`や`127.0.0.1`など）、`google.com`サブドメイン、`foo.com` サフィックスを含むホスト、`1.2.3.4:5678`を除いてすべてのホストでプロキシサーバーが使われます。 ## --proxy-pac-url=`url` @@ -58,7 +62,7 @@ app.commandLine.appendSwitch('proxy-bypass-list', ';*.google.com;*foo.com ## --no-proxy-server -プロキシサーバーを使わず、常に直接接続します。遠輝ほかのプロキシサーバーフラグを上書きします。 +プロキシサーバーを使わず、常に直接接続します。ほかのプロキシサーバーフラグを上書きします。 ## --host-rules=`rules` @@ -105,17 +109,17 @@ TLSフォールバックを許可する最小のSSL/TLSバージョン ("tls1" 不可視のページのレンダラープロセスの優先度を下げることからChromiumを防ぎます。 -このフラグは、グローバルですべてのレンダラープロセスに有効で、一つのウィンドウだけで無効化したい場合、[playing silent audio][play-silent-audio]をハックして対応します。 +このフラグは、グローバルですべてのレンダラープロセスに有効で、一つのウィンドウだけで無効化したい場合、[無音を再生する][play-silent-audio]というハックで対応します。 ## --enable-logging コンソールにChromiumのログを出力します。 -このスイッチは`app.commandLine.appendSwitch` で使えず、アプリがロードされるよりもパースしますが、同じ効果を受けるために`ELECTRON_ENABLE_LOGGING`を環境変数に設定します。 +ユーザーのアプリが読み込まれる前に解析されるため、`app.commandLine.appendSwitch`では使用できませんが、`ELECTRON_ENABLE_LOGGING`を環境変数に設定すると同じ効果を得ることができます。 ## --v=`log_level` -既定の最大アクティブなV-loggingレベルが付与されています。0が既定です。通常、正の値はV-loggingレベルに使用されます。 +標準のloggingレベルを設定します。0が既定です。通常、V-loggingレベルには正の値が使用されます。 `--enable-logging` が渡された時だけ、このスイッチは動作します。 diff --git a/docs-translations/jp/api/environment-variables.md b/docs-translations/jp/api/environment-variables.md index f5277f146591..75c0ab0c2a9a 100644 --- a/docs-translations/jp/api/environment-variables.md +++ b/docs-translations/jp/api/environment-variables.md @@ -1,5 +1,7 @@ # 環境変数 +> アプリケーションの設定や動作を、コードの変更なしで制御します。 + コマンドラインやアプリのコードよりも早く初期化されるために、Electronのいくつかの挙動は環境変数がコントロールしています。 POSIX shellでの例: @@ -47,6 +49,3 @@ Electronがクラッシュしたとき、Windowsのクラッシュダイアロ Linuxでグローバルメニューバーを使用できません。 -## `ELECTRON_HIDE_INTERNAL_MODULES` - -`require('ipc')`のような古い組み込みモジュールとの互換モードを無効にします。 diff --git a/docs-translations/jp/api/process.md b/docs-translations/jp/api/process.md index 6ad3c32d76fe..0f9d60f5a3ad 100644 --- a/docs-translations/jp/api/process.md +++ b/docs-translations/jp/api/process.md @@ -1,20 +1,16 @@ # process -Electronの`process`オブジェクトは上流nodeの1つから次のような違いがあります。 +> processオブジェクトの拡張。 -* `process.type` String - プロセスの種類で、`browser` (例　メインプロセス)または `renderer`を設定できます。 -* `process.versions.electron` String - Electronのバージョン -* `process.versions.chrome` String - Chromiumのバージョン -* `process.resourcesPath` String - JavaScriptのソースコードのパスを設定します。 -* `process.mas` Boolean - Mac app Store用のビルドで、値は`true`です。ほかのビルドの場合は`undefined`です。 +Electronの`process`オブジェクトは次のようなAPIで拡張されています。 ## イベント ### イベント: 'loaded' -Electronは内部の初期化スクリプトをロードしたとき出力され、ウェブページまたはメインスクリプトのロードが始まります。 +このイベントはElectronが内部の初期化スクリプトをロードし、ウェブページまたはメインスクリプトのロードが始まるときに発行されます。 -Node統合がオフになっているとき、削除したNodeグローバルシンボルをグローバルスコープへ戻してプリロードスクリプトで使用できます。 +Node統合がオフになっているとき、削除したNodeグローバルシンボルをグローバルスコープへ戻すために、プリロードスクリプトで使用できます。 ```js // preload.js @@ -32,16 +28,73 @@ process.once('loaded', function() { これを`true`に設定すると、Nodeのビルトインモジュールで、`asar`アーカイブのサポートを無効にできます。 +### `process.type` + +現在のプロセスのタイプで、`"browser"`(例: メインプロセス) または `"renderer"`の値をとります。 + +### `process.versions.electron` + +Electronのバージョン文字列です。 + +### `process.versions.chrome` + +Chromeのバージョン文字列です。 + +### `process.resourcesPath` + +リソースディレクトリのパスです。 + +### `process.mas` + +Mac app Store用のビルドでは値は`true`になります。ほかのビルドの場合は`undefined`です。 + +### `process.windowsStore` + +Windows Store App (appx)として動作中の場合は、値は`true`になります。それ以外では`undefined`です。 + +### `process.defaultApp` + +アプリがdefault appのパラメータとして渡されて起動された場合は、値は`true`になります。 + +訳注: [issue #4690](https://github.com/electron/electron/issues/4690)が参考になります。 + + ## メソッド -`process`オブジェクトは次のめっそどを持ちます。 +`process`オブジェクトは次のメソッドを持ちます。 + + +### `process.crash()` + +このプロセスのメインスレッドをクラッシュさせます。 ### `process.hang()` -現在のプロセスがハングしているメインスレッドが原因で発生します。 +このプロセスのメインスレッドをハングさせます。 ### `process.setFdLimit(maxDescriptors)` _OS X_ _Linux_ * `maxDescriptors` Integer -現在のプロセスで、`maxDescriptors`またはOSハード制限のどちらか低いほうで、ソフトファイルディスクリプターを設定します。 +ファイルデスクリプタの最大数のソフトリミットを、`maxDescriptors`かOSのハードリミットの、どちらか低い方に設定します。 + +### `process.getProcessMemoryInfo()` + +本プロセスのメモリ使用統計に関する情報を得ることのできるオブジェクトを返します。全ての報告値はキロバイト単位であることに注意してください。 + +* `workingSetSize` - 実際の物理メモリに固定されているメモリサイズです。 +* `peakWorkingSetSize` - これまでに実際の物理メモリに固定された最大のメモリサイズです。 +* `privateBytes` - JS heapやHTML contentなど、他のプロセスに共有されていないメモリサイズです。 +* `sharedBytes` - プロセス間で共有されているメモリサイズです。例えばElectronそのものにより使用されたメモリがこれに当たります。 + +### `process.getSystemMemoryInfo()` + +システム全体で使用されているメモリ使用統計に関する情報を得ることのできるオブジェクトを返します。全ての報告値はキロバイト単位であることに注意してください。 + +* `total` - システムで使用可能な全ての物理メモリのサイズ(KB)です。 +* `free` - アプリケーションやディスクキャッシュで使用されていないメモリのサイズです。 + +Windows / Linux用: + +* `swapTotal` - システムで使用可能なスワップメモリの総サイズです。 +* `swapFree` - システムで使用可能なスワップメモリの空きサイズです。 diff --git a/docs-translations/jp/api/synopsis.md b/docs-translations/jp/api/synopsis.md index 89d8973a14ba..fdbdb1605903 100644 --- a/docs-translations/jp/api/synopsis.md +++ b/docs-translations/jp/api/synopsis.md @@ -1,5 +1,7 @@ # 概要 +> どうやってNode.jsとElectronのAPIを使うか。 + Electron では全ての [Node.js のビルトインモジュール](http://nodejs.org/api/) 利用可能です。また、サードパーティの Node モジュール ([ネイティブモジュール](../tutorial/using-native-node-modules.md)も含む) も完全にサポートされています。 Electron はネイティブのデスクトップアプリケーション開発のための幾つかの追加のビルトインモジュールも提供しています。メインプロセスでだけ使えるモジュールもあれば、レンダラプロセス(ウェブページ)でだけ使えるモジュール、あるいはメインプロセス、レンダラプロセスどちらでも使えるモジュールもあります。 @@ -9,15 +11,13 @@ Electron はネイティブのデスクトップアプリケーション開発 メインプロセススクリプトは普通の Node.js スクリプトのようなものです： ```javascript -const electron = require('electron'); -const app = electron.app; -const BrowserWindow = electron.BrowserWindow; +const {app, BrowserWindow} = require('electron'); -var window = null; +let win = null; -app.on('ready', function() { - window = new BrowserWindow({width: 800, height: 600}); - window.loadURL('https://github.com'); +app.on('ready', () => { + win = new BrowserWindow({width: 800, height: 600}); + win.loadURL('https://github.com'); }); ``` @@ -28,8 +28,8 @@ app.on('ready', function() { @@ -39,28 +39,25 @@ app.on('ready', function() { ## 分割代入 -CoffeeScript か Babel を使っているなら、[分割代入][desctructuring-assignment]でビルトインモジュールの使用をより簡単にできます： +0.37の時点で、 、[分割代入][desctructuring-assignment]でビルトインモジュールの使用をより簡単にできます： ```javascript -const {app, BrowserWindow} = require('electron') +const {app, BrowserWindow} = require('electron'); ``` -しかし、素の JavaScript を使っている場合、Chrome が ES6 を完全サポートするまで待たなければいけません。 - -## Disable old styles of using built-in modules - -v0.35.0 以前は全てのビルトインモジュールは `require('module-name')` の形式で使われなければいけません。この形式は[多くの欠点][issue-387]がありますが、古いアプリケーションとの互換性のためにまだサポートしています。 - -古い形式を完全に無効にするために、環境変数 `ELECTRON_HIDE_INTERNAL_MODULES` を設定できます： +もし`electron`モジュール全体が必要であれば、requireして、それぞれのモジュールを`electron`からアクセスすることができます。 ```javascript -process.env.ELECTRON_HIDE_INTERNAL_MODULES = 'true' +const electron = require('electron'); +const {app, BrowserWindow} = electron; ``` -もしくは `hideInternalModules` API を呼んでください： +これは、次のコードと同じ意味を持ちます。 ```javascript -require('electron').hideInternalModules() +const electron = require('electron'); +const app = electron.app; +const BrowserWindow = electron.BrowserWindow; ``` [gui]: https://en.wikipedia.org/wiki/Graphical_user_interface diff --git a/docs-translations/jp/tutorial/desktop-environment-integration.md b/docs-translations/jp/tutorial/desktop-environment-integration.md index 96bf76d73709..6cd838afa7d7 100644 --- a/docs-translations/jp/tutorial/desktop-environment-integration.md +++ b/docs-translations/jp/tutorial/desktop-environment-integration.md @@ -8,14 +8,17 @@ 3つのオペレーティングシステム全てで、アプリケーションからユーザーに通知を送る手段が提供されています。通知を表示するためにオペレーティングシステムのネイティブ通知APIを使用しする[HTML5 Notification API](https://notifications.spec.whatwg.org/)で、Electronは、開発者に通知を送ることができます。 +**注意:** これはHTML5 APIですので、レンダラプロセス内のみで有効です。 + + ```javascript -var myNotification = new Notification('Title', { +let myNotification = new Notification('Title', { body: 'Lorem Ipsum Dolor Sit Amet' }); -myNotification.onclick = function () { - console.log('Notification clicked') -} +myNotification.onclick = () => { + console.log('Notification clicked'); +}; ``` オペレーティングシステム間でコードとユーザ体験は似ていますが、細かい違いがあります。 @@ -88,8 +91,8 @@ const electron = require('electron'); const app = electron.app; const Menu = electron.Menu; -var dockMenu = Menu.buildFromTemplate([ - { label: 'New Window', click: function() { console.log('New Window'); } }, +const dockMenu = Menu.buildFromTemplate([ + { label: 'New Window', click() { console.log('New Window'); } }, { label: 'New Window with Settings', submenu: [ { label: 'Basic' }, { label: 'Pro'} @@ -153,24 +156,24 @@ __Windows Media Playerの縮小表示ツールバー:__ アプリケーションに縮小表示ツールバーを設定するために、[BrowserWindow.setThumbarButtons][setthumbarbuttons]を使えます: ```javascript -const BrowserWindow = require('electron').BrowserWindow; +const {BrowserWindow} = require('electron'); const path = require('path'); -var win = new BrowserWindow({ +let win = new BrowserWindow({ width: 800, height: 600 }); win.setThumbarButtons([ { - tooltip: "button1", + tooltip: 'button1', icon: path.join(__dirname, 'button1.png'), - click: function() { console.log("button2 clicked"); } + click() { console.log("button2 clicked"); } }, { - tooltip: "button2", + tooltip: 'button2', icon: path.join(__dirname, 'button2.png'), - flags:['enabled', 'dismissonclick'], - click: function() { console.log("button2 clicked."); } + flags: ['enabled', 'dismissonclick'], + click() { console.log("button2 clicked."); } } ]); ``` @@ -189,25 +192,22 @@ __Audaciousのランチャーショートカット:__ ![audacious](https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles?action=AttachFile&do=get&target=shortcuts.png) -## タスクバーの進行状況バー (Windows & Unity) +## タスクバーの進行状況バー (Windows, OS X, Unity) Windowsでは、タスクバーボタンは、進行状況バーを表示するのに使えます。ウィンドウを切り替えることなくウィンドウの進行状況情報をユーザーに提供することができます。 +OS Xではプログレスバーはドックアイコンの一部として表示されます。 Unity DEは、ランチャーに進行状況バーの表示をするのと同様の機能を持っています。 __タスクバーボタン上の進行状況バー:__ ![Taskbar Progress Bar](https://cloud.githubusercontent.com/assets/639601/5081682/16691fda-6f0e-11e4-9676-49b6418f1264.png) -__Unityランチャーでの進行状況バー:__ - -![Unity Launcher](https://cloud.githubusercontent.com/assets/639601/5081747/4a0a589e-6f0f-11e4-803f-91594716a546.png) - ウィンドウに進行状況バーを設定するために、[BrowserWindow.setProgressBar][setprogressbar] APIを使えます: ```javascript -var window = new BrowserWindow({...}); -window.setProgressBar(0.5); +let win = new BrowserWindow({...}); +win.setProgressBar(0.5); ``` ## タスクバーでアイコンをオーバーレイする (Windows) @@ -223,8 +223,8 @@ __タスクバーボタンでのオーバーレイ:__ ウィンドウでオーバーレイアイコンを設定するために、[BrowserWindow.setOverlayIcon][setoverlayicon] APIを使用できます。 ```javascript -var window = new BrowserWindow({...}); -window.setOverlayIcon('path/to/overlay.png', 'Description for overlay'); +let win = new BrowserWindow({...}); +win.setOverlayIcon('path/to/overlay.png', 'Description for overlay'); ``` ## Windowのファイル表示 (OS X) @@ -240,9 +240,9 @@ __Represented file ポップアップメニュー:__ ウィンドウにrepresented fileを設定するために、[BrowserWindow.setRepresentedFilename][setrepresentedfilename] と [BrowserWindow.setDocumentEdited][setdocumentedited] APIsを使えます: ```javascript -var window = new BrowserWindow({...}); -window.setRepresentedFilename('/etc/passwd'); -window.setDocumentEdited(true); +let win = new BrowserWindow({...}); +win.setRepresentedFilename('/etc/passwd'); +win.setDocumentEdited(true); ``` [addrecentdocument]: ../api/app.md#appaddrecentdocumentpath-os-x-windows diff --git a/docs-translations/jp/tutorial/online-offline-events.md b/docs-translations/jp/tutorial/online-offline-events.md index 92503b04dfcb..6e0cbfb55981 100644 --- a/docs-translations/jp/tutorial/online-offline-events.md +++ b/docs-translations/jp/tutorial/online-offline-events.md @@ -9,10 +9,11 @@ const electron = require('electron'); const app = electron.app; const BrowserWindow = electron.BrowserWindow; -var onlineStatusWindow; -app.on('ready', function() { +let onlineStatusWindow; + +app.on('ready', () => { onlineStatusWindow = new BrowserWindow({ width: 0, height: 0, show: false }); - onlineStatusWindow.loadURL('file://' + __dirname + '/online-status.html'); + onlineStatusWindow.loadURL('file://${__dirname}/online-status.html'); }); ``` @@ -23,7 +24,7 @@ _online-status.html_