Add Japanes translated docs.

This commit is contained in:
Takahito Yamatoya 2016-01-18 23:38:44 +09:00
parent 7842a657d0
commit fc42e97144
3 changed files with 216 additions and 0 deletions

View file

@ -0,0 +1,103 @@
# clipboard
`clipboard`モジュールは、コピーとペースト操作を実行するメソッドを提供します。次の例は、クリップボードに文字列を書き込む方法を示しています:
```javascript
const clipboard = require('electron').clipboard;
clipboard.writeText('Example String');
```
X Windowsシステム上では、セレクションクリップボードがあります。それを操作するために、それぞれのメソッドで、`selection`を通す必要があります。
```javascript
clipboard.writeText('Example String', 'selection');
console.log(clipboard.readText('selection'));
```
## メソッド
`clipboard`モジュールには、次のメソッドがあります:
**Note:** 実験的APIには、そのようにマークしてあり、将来的には削除される可能性があります。
### `clipboard.readText([type])`
* `type` String (optional)
プレーンテキストとしてクリップボードの内容を返します。
### `clipboard.writeText(text[, type])`
* `text` String
* `type` String (optional)
プレーンテキストとしてクリップボードに`text`を書き込みます。
### `clipboard.readHtml([type])`
* `type` String (optional)
HTMLマークアップとして、クリップボードの内容を返します。
### `clipboard.writeHtml(markup[, type])`
* `markup` String
* `type` String (optional)
クリップボードにHTMLマークアップとして書き込みます。
### `clipboard.readImage([type])`
* `type` String (optional)
[NativeImage](native-image.md)としてクリップボードの内容を返します。
### `clipboard.writeImage(image[, type])`
* `image` [NativeImage](native-image.md)
* `type` String (optional)
`image` としてクリップボードに書き込みます。
### `clipboard.clear([type])`
* `type` String (optional)
クリップボードの内容をクリアします。
### `clipboard.availableFormats([type])`
* `type` String (optional)
`type`のクリップボードがサポートしているフォーマット配列を返します。
### `clipboard.has(data[, type])` _実験_
* `data` String
* `type` String (optional)
`data`で指定したフォーマットをクリップボードがサポートしているかどうかを返します。
```javascript
console.log(clipboard.has('<p>selection</p>'));
```
### `clipboard.read(data[, type])` _実験_
* `data` String
* `type` String (optional)
クリップボードから`data`を読み込みます。
### `clipboard.write(data[, type])`
* `data` Object
* `text` String
* `html` String
* `image` [NativeImage](native-image.md)
* `type` String (optional)
```javascript
clipboard.write({text: 'test', html: "<b>test</b>"});
```
クリップボードに`data`を書き込みます。

View file

@ -0,0 +1,66 @@
# crashReporter
`crash-reporter`モジュールはアプリのクラッシュレポートを送信することができます。
リモートサーバーに自動的にクラッシュレポートを登録する例です。
```javascript
const crashReporter = require('electron').crashReporter;
crashReporter.start({
productName: 'YourName',
companyName: 'YourCompany',
submitURL: 'https://your-domain.com/url-to-submit',
autoSubmit: true
});
```
## メソッド
`crash-reporter`モジュールは次のメソッドを持ちます:
### `crashReporter.start(options)`
`options` Object, properties:
* `productName` String, デフォルト: Electron.
* `companyName` String (**必須**)
* `submitURL` String, (**必須**)
* クラッシュレポートがPOSTで送信されるURL
* `autoSubmit` Boolean, デフォルト: `true`.
* ユーザーの判断なくクラッシュレポートを送信します
* `ignoreSystemCrashHandler` Boolean, デフォルト: `false`.
* `extra` Object
* あなたが定義できるオブジェクトは、レポートと一緒に送信されます。
* 文字列プロパティのみが正しく送信されます。
* オブジェクトのネストはサポートしていません。
他の`crashReporter`APIを使用する前にこのメソッドをコールする必要があります。
**Note:** OS Xでは、Electronは、WindowsとLinux上の`breakpad` とは異なる、新しい`crashpad`クライアントを使用します。クラッシュ収集機能を有効にするために、メインプロセスや、クラッシュレポートを収集したいそれぞれのレンダラープロセスで、`crashpad`を初期化するために`crashReporter.start`APIをコールする必要があります。
### `crashReporter.getLastCrashReport()`
日付と最後のクラッシュレポートのIDを返します。もしなんのクラッシュレポートも送信されていないか、クラッシュレポーターが起動していない場合、`null`を返します。
### `crashReporter.getUploadedReports()`
滑ってのアップロードされたクラッシュレポートが返されます。それぞれのレポートには日付とアップロードされたIDが含まれます。
## crash-reporter Payload
クラッシュレポーターは`POST`で`submitURL` に次のデーターが送信されます。
* `ver` String - Electronのバージョン
* `platform` String - 例: 'win32'.
* `process_type` String - 例: 'renderer'.
* `guid` String - 例: '5e1286fc-da97-479e-918b-6bfb0c3d1c72'
* `_version` String - `package.json`でのバージョン
* `_productName` String - `crashReporter`でのプロダクト名 `オプション`
object.
* `prod` String - 基盤となる製品の名前。この場合は、Electronです。
* `_companyName` String - `crashReporter`での会社名 `オプション`
object.
* `upload_file_minidump` File - ファイル形式のクラッシュレポート
* `crashReporter`での`extra`オブジェクトのすべてのレベル1のプロパティ
`オプション` object

View file

@ -0,0 +1,47 @@
# 環境変数
コマンドラインやアプリのコードよりも早く初期化されるために、Electronのいくつかの挙動は環境変数がコントロールしています。
POSIX shellでの例:
```bash
$ export ELECTRON_ENABLE_LOGGING=true
$ electron
```
Windows コンソール上:
```powershell
> set ELECTRON_ENABLE_LOGGING=true
> electron
```
## `ELECTRON_RUN_AS_NODE`
通常のNode.jsプロセスでプロセスを開始します。
## `ELECTRON_ENABLE_LOGGING`
Chromeのインターナルログをコンソールに出力します。
## `ELECTRON_ENABLE_STACK_DUMPING`
Electronがクラッシュしたとき、コンソールにスタックとレースを出力します。
`crashReporter`が開始していないと、この環境変数は動作しません。
## `ELECTRON_DEFAULT_ERROR_MODE` _Windows_
Electronがクラッシュしたとき、Windowsのクラッシュダイアログを表示します。
`crashReporter`が開始していないと、この環境変数は動作しません。
## `ELECTRON_NO_ATTACH_CONSOLE` _Windows_
現在のコンソールセッションにはアタッチできません。
## `ELECTRON_FORCE_WINDOW_MENU_BAR` _Linux_
Linuxでグローバルメニューバーを使用できません。
## `ELECTRON_HIDE_INTERNAL_MODULES`
`require('ipc')`のような古い組み込みモジュールとの互換モードを無効にします。