📝 Update Korean docs as upstream

[ci skip]
This commit is contained in:
Plusb Preco 2016-04-04 00:56:07 +09:00
parent fdb138f79c
commit 6e9c27fdaa
16 changed files with 81 additions and 29 deletions

View file

@ -5,8 +5,8 @@ Accelerator는 키보드 단축키를 표현하는 문자열입니다, 여러
예제: 예제:
* `Command+A` * `CommandOrControl+A`
* `Ctrl+Shift+Z` * `CommandOrControl+Shift+Z`
## 플랫폼에 관련하여 주의할 점 ## 플랫폼에 관련하여 주의할 점
@ -14,6 +14,9 @@ Linux와 Windows에서는 `Command`키가 없으므로 작동하지 않습니다
`CommandOrControl`을 사용하면 OS X의 `Command`와 Linux, Windows의 `Control` 모두 `CommandOrControl`을 사용하면 OS X의 `Command`와 Linux, Windows의 `Control` 모두
지원할 수 있습니다. 지원할 수 있습니다.
`Option` 대신 `Alt`을 사용하는게 좋습니다. `Option` 키는 OS X에만 있으므로
모든 플랫폼에서 사용할 수 있는 `Alt` 키를 권장합니다.
`Super`키는 Windows와 Linux 에서는 `윈도우`키를, OS X에서는 `Cmd`키로 맵핑됩니다. `Super`키는 Windows와 Linux 에서는 `윈도우`키를, OS X에서는 `Cmd`키로 맵핑됩니다.
## 사용 가능한 혼합키 ## 사용 가능한 혼합키

View file

@ -353,6 +353,10 @@ npm 모듈 규칙에 따라 대부분의 경우 `package.json`의 `name` 필드
현재 어플리케이션의 [로케일](https://ko.wikipedia.org/wiki/%EB%A1%9C%EC%BC%80%EC%9D%BC)을 현재 어플리케이션의 [로케일](https://ko.wikipedia.org/wiki/%EB%A1%9C%EC%BC%80%EC%9D%BC)을
반환합니다. 반환합니다.
**참고:** 패키징된 앱을 배포할 때, `locales` 폴더도 같이 배포해야 합니다.
**참고:** Windows에선 `ready` 이벤트가 발생한 이후에 이 메서드를 사용해야 합니다.
### `app.addRecentDocument(path)` _OS X_ _Windows_ ### `app.addRecentDocument(path)` _OS X_ _Windows_
* `path` String * `path` String

View file

@ -81,8 +81,7 @@ win.show();
* `enableLargerThanScreen` Boolean - 윈도우 크기가 화면 크기보다 크게 재조정 될 * `enableLargerThanScreen` Boolean - 윈도우 크기가 화면 크기보다 크게 재조정 될
수 있는지 여부. 기본값은 `false`입니다. 수 있는지 여부. 기본값은 `false`입니다.
* `backgroundColor` String - `#66CD00``#FFF`, `#80FFFFFF` (알파 지원됨) 같이 * `backgroundColor` String - `#66CD00``#FFF`, `#80FFFFFF` (알파 지원됨) 같이
16진수로 표현된 윈도우의 배경 색. 기본값은 Linux와 Windows에선 `#000` (검정)이며, 16진수로 표현된 윈도우의 배경 색. 기본값은 `#FFF` (white).
Mac에선 `#FFF` (또는, transparent(투명)일 경우 clear(색 없음)로 설정)
* `hasShadow` Boolean - 윈도우가 그림자를 가질지 여부를 지정합니다. 이 속성은 * `hasShadow` Boolean - 윈도우가 그림자를 가질지 여부를 지정합니다. 이 속성은
OS X에서만 구현되어 있습니다. 기본값은 `true`입니다. OS X에서만 구현되어 있습니다. 기본값은 `true`입니다.
* `darkTheme` Boolean - 설정에 상관 없이 무조건 어두운 윈도우 테마를 사용합니다. * `darkTheme` Boolean - 설정에 상관 없이 무조건 어두운 윈도우 테마를 사용합니다.
@ -296,11 +295,20 @@ __참고__: OS X에선 이 이벤트가 그저 `moved` 이벤트의 별칭(alias
### Event: 'app-command' _Windows_ ### Event: 'app-command' _Windows_
Returns:
* `event` Event
* `command` String
[App Command](https://msdn.microsoft.com/en-us/library/windows/desktop/ms646275(v=vs.85).aspx)가 [App Command](https://msdn.microsoft.com/en-us/library/windows/desktop/ms646275(v=vs.85).aspx)가
호출됐을 때 발생하는 이벤트입니다. 이 이벤트는 일반적으로 키보드 미디어 키 또는 호출됐을 때 발생하는 이벤트입니다. 이 이벤트는 일반적으로 키보드 미디어 키 또는
브라우저 커맨드(기본 동작 키)에 관련되어 있습니다. 예를 들어 Windows에서 작동하는 브라우저 커맨드(기본 동작 키)에 관련되어 있습니다. 예를 들어 Windows에서 작동하는
몇몇 마우스는 "뒤로가기" 같은 동작을 포함하고 있습니다. 몇몇 마우스는 "뒤로가기" 같은 동작을 포함하고 있습니다.
반환되는 커맨드들은 모두 소문자화되며 언더스코어(`_`)는 하이픈(`-`)으로 변경되며
`APPCOMMAND_` 접두어는 제거됩니다.
e.g. `APPCOMMAND_BROWSER_BACKWARD``browser-backward`와 같이 반환됩니다.
```javascript ```javascript
someWindow.on('app-command', function(e, cmd) { someWindow.on('app-command', function(e, cmd) {
// 마우스의 뒤로가기 버튼을 눌렀을 때 뒤로가기 탐색을 실행합니다 // 마우스의 뒤로가기 버튼을 눌렀을 때 뒤로가기 탐색을 실행합니다

View file

@ -12,6 +12,13 @@ const dialog = require('electron').dialog;
console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', 'multiSelections' ]})); console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', 'multiSelections' ]}));
``` ```
대화 상자는 Electron의 메인 스레드에서 열립니다. 만약 랜더러 프로세스에서 대화 상자
객체를 사용하고 싶다면, `remote`를 통해 접근하는 방법을 고려해야 합니다:
```javascript
const dialog = require('electron').remote.dialog;
```
**OS X 참고**: 대화 상자를 시트처럼 보여지게 하려면 `browserWindow` 인자에 **OS X 참고**: 대화 상자를 시트처럼 보여지게 하려면 `browserWindow` 인자에
`BrowserWindow` 객체의 참조를 제공하면 됩니다. `BrowserWindow` 객체의 참조를 제공하면 됩니다.

View file

@ -14,9 +14,9 @@ const app = electron.app;
const globalShortcut = electron.globalShortcut; const globalShortcut = electron.globalShortcut;
app.on('ready', function() { app.on('ready', function() {
// 'ctrl+x' 단축키를 리스너에 등록합니다. // 'CommandOrControl+X' 단축키를 리스너에 등록합니다.
var ret = globalShortcut.register('ctrl+x', function() { var ret = globalShortcut.register('CommandOrControl+X', function() {
console.log('ctrl+x is pressed'); console.log('CommandOrControl+X is pressed');
}); });
if (!ret) { if (!ret) {
@ -24,12 +24,12 @@ app.on('ready', function() {
} }
// 단축키가 등록되었는지 확인합니다. // 단축키가 등록되었는지 확인합니다.
console.log(globalShortcut.isRegistered('ctrl+x')); console.log(globalShortcut.isRegistered('CommandOrControl+X'));
}); });
app.on('will-quit', function() { app.on('will-quit', function() {
// 단축키의 등록을 해제합니다. // 단축키의 등록을 해제합니다.
globalShortcut.unregister('ctrl+x'); globalShortcut.unregister('CommandOrControl+X');
// 모든 단축키의 등록을 해제합니다. // 모든 단축키의 등록을 해제합니다.
globalShortcut.unregisterAll(); globalShortcut.unregisterAll();

View file

@ -71,7 +71,7 @@
메인 프로세스는 `ipcMain` 모듈을 통해 `channel` 이벤트를 리스닝 할 수 있고, 메인 프로세스는 `ipcMain` 모듈을 통해 `channel` 이벤트를 리스닝 할 수 있고,
`event.returnValue`로 회신 할 수 있습니다. `event.returnValue`로 회신 할 수 있습니다.
__참고:__ 동기 메서드는 모든 랜더러 프로세스의 작업을 일시 중단시킵니다. 사용 목적이 **참고:** 동기 메서드는 모든 랜더러 프로세스의 작업을 일시 중단시킵니다. 사용 목적이
확실하지 않다면 사용하지 않는 것이 좋습니다. 확실하지 않다면 사용하지 않는 것이 좋습니다.
### `ipcRenderer.sendToHost(channel[, arg1][, arg2][, ...])` ### `ipcRenderer.sendToHost(channel[, arg1][, arg2][, ...])`

View file

@ -14,7 +14,7 @@
* `options` Object * `options` Object
* `click` Function - 메뉴 아이템이 클릭될 때 `click(menuItem, browserWindow)` * `click` Function - 메뉴 아이템이 클릭될 때 `click(menuItem, browserWindow)`
형태로 호출 되는 콜백 함수 형태로 호출 되는 콜백 함수
* `role` String - 메뉴 아이템의 액션을 정의합니다. 이 속성을 지정하면 `click` * `role` String - 메뉴 아이템의 액션을 정의합니다; 이 속성을 지정하면 `click`
속성이 무시됩니다. 속성이 무시됩니다.
* `type` String - `MenuItem`의 타입 `normal`, `separator`, `submenu`, * `type` String - `MenuItem`의 타입 `normal`, `separator`, `submenu`,
`checkbox` 또는 `radio`를 사용할 수 있습니다. 만약 값이 `Menu`가 아니면 `checkbox` 또는 `radio`를 사용할 수 있습니다. 만약 값이 `Menu`가 아니면
@ -23,18 +23,22 @@
* `sublabel` String * `sublabel` String
* `accelerator` [Accelerator](accelerator.md) * `accelerator` [Accelerator](accelerator.md)
* `icon` [NativeImage](native-image.md) * `icon` [NativeImage](native-image.md)
* `enabled` Boolean * `enabled` Boolean - 만약 `false`로 설정되면, 메뉴 아이템이 회색으로 변하며
* `visible` Boolean 클릭할 수 없게 됩니다.
* `checked` Boolean * `visible` Boolean - 만약 `false`로 설정되면, 메뉴 아이템이 완전히 숨겨집니다.
* `submenu` Menu - 보조메뉴를 설정합니다. `type``submenu`일 경우 반드시 * `checked` Boolean - 반드시 `checkbox` 또는 `radio` 타입의 메뉴 아이템에만
설정해야 합니다. 일반 메뉴 아이템일 경우 생략할 수 있습니다. 지정해야 합니다.
* `submenu` Menu - 반드시 `submenu` 타입의 메뉴 아이템에만 지정해야 합니다. 만약
`submenu`가 지정되면 `type: 'submenu'`는 생략될 수 있습니다. 만약 값이 `Menu`
아닐 경우 `Menu.buildFromTemplate`을 통해 자동적으로 변환됩니다.
* `id` String - 현재 메뉴 아이템에 대해 유일키를 지정합니다. 이 키는 이후 * `id` String - 현재 메뉴 아이템에 대해 유일키를 지정합니다. 이 키는 이후
`position` 옵션에서 사용할 수 있습니다. `position` 옵션에서 사용할 수 있습니다.
* `position` String - 미리 지정한 `id`를 이용하여 메뉴 아이템의 위치를 세밀하게 * `position` String - 미리 지정한 `id`를 이용하여 메뉴 아이템의 위치를 세밀하게
조정합니다. 조정합니다.
메뉴 아이템을 생성할 때, 다음 목록과 일치하는 표준 동작은 수동으로 직접 구현하는 대신 어떠한 메뉴 아이템이 표준 롤에 일치한다면, `role`을 지정하는 것이 동작을 `click`
`role` 속성을 지정하여 고유 OS 경험을 최대한 살릴 수 있습니다. 함수로 일일이 구현하려 시도하는 것 보다 더 좋을 수 있습니다. 빌트-인 `role` 동작은
더 좋은 네이티브 경험을 제공할 것입니다.
`role` 속성은 다음 값을 가질 수 있습니다: `role` 속성은 다음 값을 가질 수 있습니다:
@ -57,3 +61,21 @@ OS X에서의 `role`은 다음 값을 추가로 가질 수 있습니다:
* `window` - 부 메뉴를 가지는 "Window" 메뉴 * `window` - 부 메뉴를 가지는 "Window" 메뉴
* `help` - 부 메뉴를 가지는 "Help" 메뉴 * `help` - 부 메뉴를 가지는 "Help" 메뉴
* `services` - 부 메뉴를 가지는 "Services" 메뉴 * `services` - 부 메뉴를 가지는 "Services" 메뉴
## Instance Properties
다음 속성들은 존재하는 `MenuItem`에서 계속 변경될 수 있습니다:
* `enabled` Boolean
* `visible` Boolean
* `checked` Boolean
이 속성들의 의미는 위 옵션에서 설명한 것과 같습니다.
`checkbox` 메뉴 아이템은 선택될 때 해당 아이템의 `checked` 속성을 통해 활성화 그리고
비활성화 상태인지를 표시합니다. 또한 `click` 함수를 지정하여 추가적인 작업을 할 수도
있습니다.
`radio` 메뉴 아이템은 클릭되었을 때 `checked` 속성을 활성화 합니다. 그리고 같은
메뉴의 인접한 모든 다른 아이템은 비활성화됩니다. 또한 `click` 함수를 지정하여 추가적인
작업을 할 수도 있습니다.

View file

@ -74,7 +74,7 @@ appIcon.setContextMenu(contextMenu);
트레이 아이콘이 클릭될 때 발생하는 이벤트입니다. 트레이 아이콘이 클릭될 때 발생하는 이벤트입니다.
__주의:__ `bounds`는 OS X 와 Windows에서만 작동합니다. **참고:** `bounds`는 OS X 와 Windows에서만 작동합니다.
### Event: 'right-click' _OS X_ _Windows_ ### Event: 'right-click' _OS X_ _Windows_

View file

@ -80,6 +80,9 @@
"on"으로 지정하면 `webview` 페이지 내에서 `require``process 객체`같은 node.js "on"으로 지정하면 `webview` 페이지 내에서 `require``process 객체`같은 node.js
API를 사용할 수 있습니다. 이를 지정하면 내부에서 로우레벨 리소스에 접근할 수 있습니다. API를 사용할 수 있습니다. 이를 지정하면 내부에서 로우레벨 리소스에 접근할 수 있습니다.
**참고:** Node 통합 기능은 `webview`에서 부모 윈도우가 해당 옵션이 비활성화되어있는
경우 항상 비활성화됩니다.
### `plugins` ### `plugins`
```html ```html
@ -595,7 +598,10 @@ Returns:
```javascript ```javascript
webview.addEventListener('new-window', function(e) { webview.addEventListener('new-window', function(e) {
require('electron').shell.openExternal(e.url); var protocol = require('url').parse(e.url).protocol;
if (protocol === 'http:' || protocol === 'https:') {
require('electron').shell.openExternal(e.url);
}
}); });
``` ```

View file

@ -22,6 +22,9 @@
`features` 문자열은 표준 브라우저의 포맷을 따르고 있지만, 각 기능은 `BrowserWindow` `features` 문자열은 표준 브라우저의 포맷을 따르고 있지만, 각 기능은 `BrowserWindow`
옵션이어야 합니다. 옵션이어야 합니다.
**참고:** Node 통합 기능은 열린 `window`에서 부모 윈도우가 해당 옵션이
비활성화되어있는 경우 항상 비활성화됩니다.
### `window.opener.postMessage(message, targetOrigin)` ### `window.opener.postMessage(message, targetOrigin)`
* `message` String * `message` String

View file

@ -23,8 +23,7 @@ C++ 코드는 많은 Chromium의 추상화와 타입을 사용합니다. 따라
## JavaScript ## JavaScript
* 하드 탭(hard tabs) 대신 소프트 탭(2 spaces) 들여쓰기를 사용합니다. * [표준](http://npm.im/standard) JavaScript 코딩 스타일을 사용합니다.
* 항상 구문의 끝은 `;`으로 마쳐야 합니다.
* Google의 코딩 스타일에도 맞추기 위해 파일의 끝에는 **절대** 개행을 삽입해선 안됩니다. * Google의 코딩 스타일에도 맞추기 위해 파일의 끝에는 **절대** 개행을 삽입해선 안됩니다.
* 파일 이름의 공백은 `_`대신에 `-`을 사용하여야 합니다. 예를 들어 * 파일 이름의 공백은 `_`대신에 `-`을 사용하여야 합니다. 예를 들어
`file_name.js``file-name.js`로 고쳐야합니다. 왜냐하면 `file_name.js``file-name.js`로 고쳐야합니다. 왜냐하면

View file

@ -21,7 +21,7 @@ http://54.249.141.255:8086/atom-shell/symbols 입니다. 일단 이 URL에 직
## Windbg에서 심볼 서버 사용하기 ## Windbg에서 심볼 서버 사용하기
Windbg 심볼 경로는 구분자와 `*` 문자로 설정되어 있습니다. Electron 심볼 서버만 Windbg 심볼 경로는 구분자와 `*` 문자로 설정되어 있습니다. Electron 심볼 서버만
사용하려면 심볼 경로의 엔트리를 추가해야 합니다. (__참고:__ `c:\code\symbols` 사용하려면 심볼 경로의 엔트리를 추가해야 합니다. (**참고:** `c:\code\symbols`
디렉터리 경로를 PC가 원하는 경로로 수정할 수 있습니다): 디렉터리 경로를 PC가 원하는 경로로 수정할 수 있습니다):
``` ```

View file

@ -19,7 +19,7 @@
## node-inspector로 디버깅 하기 ## node-inspector로 디버깅 하기
__참고:__ Electron은 현재 node-inspector 유틸리티와 호환성 문제가 있습니다. 따라서 **참고:** Electron은 현재 node-inspector 유틸리티와 호환성 문제가 있습니다. 따라서
node-inspector 콘솔 내에서 메인 프로세스의 `process` 객체를 탐색할 경우 크래시가 node-inspector 콘솔 내에서 메인 프로세스의 `process` 객체를 탐색할 경우 크래시가
발생할 수 있습니다. 발생할 수 있습니다.

View file

@ -14,7 +14,7 @@ Windows, Linux, OS X 운영체제 모두 기본적으로 어플리케이션에
통해 개발자가 편리하게 데스크톱 알림을 사용할 수 있는 기능을 제공합니다. 데스크톱 알림은 통해 개발자가 편리하게 데스크톱 알림을 사용할 수 있는 기능을 제공합니다. 데스크톱 알림은
운영체제의 네이티브 알림 API를 사용하여 표시합니다. 운영체제의 네이티브 알림 API를 사용하여 표시합니다.
__참고:__ 이 API는 HTML5 API이기 때문에 랜더러 프로세스에서만 사용할 수 있습니다. **참고:** 이 API는 HTML5 API이기 때문에 랜더러 프로세스에서만 사용할 수 있습니다.
```javascript ```javascript
var myNotification = new Notification('Title', { var myNotification = new Notification('Title', {

View file

@ -4,11 +4,11 @@ Electron은 v0.34.0 버전부터 앱 패키지를 Mac App Store(MAS)에 제출
되었습니다. 이 가이드는 어플리케이션을 앱 스토어에 등록하는 방법과 빌드의 한계에 대한 되었습니다. 이 가이드는 어플리케이션을 앱 스토어에 등록하는 방법과 빌드의 한계에 대한
설명을 제공합니다. 설명을 제공합니다.
__참고:__ v0.36.0 버전부터 어플리케이션이 샌드박스화 된 상태로 실행되면 GPU 작동을 **참고:** v0.36.0 버전부터 어플리케이션이 샌드박스화 된 상태로 실행되면 GPU 작동을
방지하는 버그가 있었습니다. 따라서 이 버그가 고쳐지기 전까진 v0.35.x 버전을 사용하는 방지하는 버그가 있었습니다. 따라서 이 버그가 고쳐지기 전까진 v0.35.x 버전을 사용하는
것을 권장합니다. 이 버그에 관한 자세한 사항은 [issue #3871][issue-3871]를 참고하세요. 것을 권장합니다. 이 버그에 관한 자세한 사항은 [issue #3871][issue-3871]를 참고하세요.
__참고:__ Mac App Store에 어플리케이션을 등록하려면 **참고:** Mac App Store에 어플리케이션을 등록하려면
[Apple Developer Program][developer-program]에 등록되어 있어야 하며 비용이 발생할 [Apple Developer Program][developer-program]에 등록되어 있어야 하며 비용이 발생할
수 있습니다. 수 있습니다.

View file

@ -8,7 +8,7 @@ Electron은 라이센스상의 문제로 Widevine CDM 플러그인을 직접 제
따라서 플러그인을 얻으려면 먼저 사용할 Electron 빌드의 아키텍쳐와 버전에 맞춰 공식 따라서 플러그인을 얻으려면 먼저 사용할 Electron 빌드의 아키텍쳐와 버전에 맞춰 공식
Chrome 브라우저를 설치해야 합니다. Chrome 브라우저를 설치해야 합니다.
__참고:__ Chrome 브라우저의 메이저 버전은 Electron에서 사용하는 Chrome 버전과 **참고:** Chrome 브라우저의 메이저 버전은 Electron에서 사용하는 Chrome 버전과
같습니다, 만약 그렇지 않다면 `navigator.plugins`가 로드됐더라도 정상적으로 작동하지 같습니다, 만약 그렇지 않다면 `navigator.plugins`가 로드됐더라도 정상적으로 작동하지
않습니다. 않습니다.
@ -42,7 +42,7 @@ Linux에선 플러그인 바이너리들이 Chrome 브라우저와 함께 제공
`widevinecdmadapter`의 위치를 전달하고 플러그인의 버전을 `--widevine-cdm-version` `widevinecdmadapter`의 위치를 전달하고 플러그인의 버전을 `--widevine-cdm-version`
스위치에 전달해야 합니다. 스위치에 전달해야 합니다.
__참고:__ `widevinecdmadapter` 바이너리가 Electron으로 전달되어도, `widevinecdm` **참고:** `widevinecdmadapter` 바이너리가 Electron으로 전달되어도, `widevinecdm`
바이너리는 옆에 같이 두어야 합니다. 바이너리는 옆에 같이 두어야 합니다.
커맨드 라인 스위치들은 `app` 모듈의 `ready` 이벤트가 발생하기 전에 전달되어야 합니다. 커맨드 라인 스위치들은 `app` 모듈의 `ready` 이벤트가 발생하기 전에 전달되어야 합니다.