diff --git a/docs-translations/ko/api/auto-updater.md b/docs-translations/ko/api/auto-updater.md index dd9adf86709a..369f58297be4 100644 --- a/docs-translations/ko/api/auto-updater.md +++ b/docs-translations/ko/api/auto-updater.md @@ -1,4 +1,4 @@ -# auto-updater +# autoUpdater **이 모듈은 현재 OS X에서만 사용할 수 있습니다.** @@ -76,26 +76,30 @@ Squirrel은 "url"로 `Accept: application/zip` 헤더와 함께 업데이트 zip `pub_date`은 ISO 8601 표준에 따라 포맷된 날짜입니다. -## Event: error +## Events + +`autoUpdater` 객체는 다음과 같은 이벤트를 발생시킵니다: + +### Event: 'error' * `event` Event * `message` String 업데이트시 에러가 나면 발생하는 이벤트입니다. -## Event: checking-for-update +### Event: 'checking-for-update' 업데이트를 확인하기 시작할 때 발생하는 이벤트입니다. -## Event: update-available +### Event: 'update-available' 사용 가능한 업데이트가 있을 때 발생하는 이벤트입니다. 이벤트는 자동으로 다운로드 됩니다. -## Event: update-not-available +### Event: 'update-not-available' 사용 가능한 업데이트가 없을 때 발생하는 이벤트입니다. -## Event: update-downloaded +### Event: 'update-downloaded' * `event` Event * `releaseNotes` String @@ -106,12 +110,16 @@ Squirrel은 "url"로 `Accept: application/zip` 헤더와 함께 업데이트 zip 업데이트의 다운로드가 완료되었을 때 발생하는 이벤트입니다. `quitAndUpdate()`를 호출하면 어플리케이션을 종료하고 업데이트를 설치합니다. -## autoUpdater.setFeedUrl(url) +## Methods + +`autoUpdater` 객체에서 사용할 수 있는 메서드입니다: + +### `autoUpdater.setFeedUrl(url)` * `url` String `url`을 설정하고 자동 업데이터를 초기화합니다. `url`은 한번 설정되면 변경할 수 없습니다. -## autoUpdater.checkForUpdates() +### `autoUpdater.checkForUpdates()` 서버에 새로운 업데이트가 있는지 요청을 보내 확인합니다. API를 사용하기 전에 `setFeedUrl`를 호출해야 합니다. diff --git a/docs-translations/ko/development/build-instructions-windows.md b/docs-translations/ko/development/build-instructions-windows.md index eb1283e7c4bc..06c2349b3d9b 100644 --- a/docs-translations/ko/development/build-instructions-windows.md +++ b/docs-translations/ko/development/build-instructions-windows.md @@ -46,7 +46,7 @@ python script\build.py python script\build.py -c D ``` -빌드가 모두 끝나면 `out/D` 디렉터리에서 `atom.exe` 실행 파일을 찾을 수 있습니다. +빌드가 모두 끝나면 `out/D` (디버그 타겟) 또는 `out/R` (릴리즈 타겟) 디렉터리에서 `electron.exe` 실행 파일을 찾을 수 있습니다. ## 64비트 빌드 diff --git a/docs-translations/ko/development/coding-style.md b/docs-translations/ko/development/coding-style.md index 92aa3b4ed173..1b88be8487c1 100644 --- a/docs-translations/ko/development/coding-style.md +++ b/docs-translations/ko/development/coding-style.md @@ -4,8 +4,15 @@ C++과 Python스크립트는 Chromium의 [코딩 스타일](http://www.chromium.org/developers/coding-style)을 따릅니다. 파이선 스크립트 `script/cpplint.py`를 사용하여 모든 파일이 해당 코딩스타일에 맞게 코딩 되었는지 확인할 수 있습니다. + 파이선의 버전은 2.7을 사용합니다. +C++ 코드는 많은 Chromium의 추상화와 타입을 사용합니다. 그래서 이에 대해 잘 알고 있어야 합니다. +이와 관련하여 시작하기 좋은 장소로 Chromium의 [Important Abstractions and Data Structures] +(https://www.chromium.org/developers/coding-style/important-abstractions-and-data-structures) 문서가 있습니다. +이 문서에선 몇가지 특별한 타입과 스코프 타입(스코프 밖으로 나가면 자동으로 메모리에서 할당을 해제합니다. 스마트 포인터로 보시면 됩니다), +로깅 메커니즘 등을 언급하고 있습니다. + ## CoffeeScript CoffeeScript의 경우 GitHub의 [스타일 가이드](https://github.com/styleguide/javascript)를 따릅니다. 동시에 다음 규칙도 따릅니다: diff --git a/docs-translations/ko/styleguide.md b/docs-translations/ko/styleguide.md new file mode 100644 index 000000000000..065d37f5cd17 --- /dev/null +++ b/docs-translations/ko/styleguide.md @@ -0,0 +1,78 @@ +# Electron Documentation Styleguide + +Find the appropriate section for your task: [reading Electron documentation](#) +or [writing Electron documentation](#). + +## Writing Electron Documentation + +These are the ways that we construct the Electron documentation. + +- Maximum one `h1` title per page. +- Use `bash` instead of `cmd` in code blocks (because of syntax highlighter). +- Doc `h1` titles should match object name (i.e. `browser-window` + `BrowserWindow`). + - Hyphen separated filenames, however, are fine. +- No headers following headers, add at least a one-sentence description. +- Methods headers are wrapped in `code` ticks. +- Event headers are wrapped in single 'quotation' marks. +- No nesting lists more than 2 levels (unfortunately because of markdown + renderer). +- Add section titles: Events, Class Methods and Instance Methods. +- Use 'will' over 'would' when describing outcomes. +- Events and methods are `h3` headers. +- Optional arguments written as `function (required[, optional])`. +- Optional arguments are denoted when called out in list. +- Line length is 80-column wrapped. +- Platform specific methods are noted in italics following method header. + - ```### `method(foo, bar)` _OS X_``` + +## Reading Electron Documentation + +Here are some tips for understanding Electron documentation syntax. + +### Methods + +An example of [method](https://developer.mozilla.org/en-US/docs/Glossary/Method) +documentation: + +--- + +`methodName(required[, optional]))` + +* `require` String, **required** +* `optional` Integer + +--- + +The method name is followed by the arguments it takes. Optional arguments are +notated by brackets surrounding the optional argument as well as the comma +required if this optional argument follows another argument. + +Below the method is more detailed information on each of the arguments. The type +of argument is notated by either the common types: [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object), [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) +or a custom type like Electron's [`webContent`](api/web-content.md). + +### Events + +An example of [event](https://developer.mozilla.org/en-US/docs/Web/API/Event) +documentation: + +--- + +Event: 'wake-up' + +Returns: + +* `time` String + +--- + +The event is a string that is used after a `.on` listener method. If it returns +a value it and its type is noted below. If you were to listen and respond to +this event it might look something like this: + +```javascript +Alarm.on('wake-up', function(time) { + console.log(time) +}) +``` \ No newline at end of file diff --git a/docs-translations/ko/tutorial/quick-start.md b/docs-translations/ko/tutorial/quick-start.md index 7564f1c8c4c9..963ebca4dacd 100644 --- a/docs-translations/ko/tutorial/quick-start.md +++ b/docs-translations/ko/tutorial/quick-start.md @@ -59,7 +59,9 @@ your-app/ } ``` -`main.js`에서 창을 만들거나 시스템 이벤트를 처리할 수 있습니다. 대표적인 예제로 다음과 같이 작성할 수 있습니다: +__알림__: 만약 `main` 필드가 `package.json`에 설정되어 있지 않으면 Electron은 자동으로 같은 디렉터리의 `index.js`를 로드합니다. + +반드시 `main.js`에서 창을 만들고 시스템 이밴트를 처리해야합니다. 대표적인 예제로 다음과 같이 작성할 수 있습니다: ```javascript var app = require('app'); // 어플리케이션 기반을 조작 하는 모듈. diff --git a/docs-translations/ko/tutorial/using-selenium-and-webdriver.md b/docs-translations/ko/tutorial/using-selenium-and-webdriver.md index 069a49e52798..b6178184d661 100644 --- a/docs-translations/ko/tutorial/using-selenium-and-webdriver.md +++ b/docs-translations/ko/tutorial/using-selenium-and-webdriver.md @@ -29,7 +29,7 @@ Starting ChromeDriver (v2.10.291558) on port 9515 Only local connections are allowed. ``` -곧 사용하므로 포트 `9515`를 기억해 놓습니다. +포트 `9515`는 나중에 사용하므로 기억해 놓읍시다 ### 2. WebDriverJS 설치 @@ -66,6 +66,53 @@ driver.wait(function() { driver.quit(); ``` +## WebdriverIO 설정하기 + +[WebdriverIO](http://webdriver.io/)는 웹 드라이버와 함께 테스트를 위해 제공되는 node 패키지입니다. + +### 1. 크롬 드라이버 시작 + +먼저, `chromedriver` 바이너리를 다운로드 받고 실행합니다: + +```bash +$ chromedriver --url-base=/wd/hub --port=9515 +Starting ChromeDriver (v2.10.291558) on port 9515 +Only local connections are allowed. +``` + +포트 `9515`는 나중에 사용하므로 기억해 놓읍시다 + +### 2. WebDriverIO 설치 + +```bash +$ npm install webdriverio +``` + +### 3. 크롬 드라이버에 연결 +```javascript +var webdriverio = require('webdriverio'); +var options = { + host: "localhost", // Use localhost as chrome driver server + port: 9515, // "9515" is the port opened by chrome driver. + desiredCapabilities: { + browserName: 'chrome', + chromeOptions: {binary: '/Path-to-Your-App.app/Electron'} // Path to your Electron binary. + } +}; + +var client = webdriverio.remote(options); + +client + .init() + .url('http://google.com') + .setValue('#q', 'webdriverio') + .click('#btnG') + .getTitle().then(function(title) { + console.log('Title was: ' + title); + }) + .end(); +``` + ## 작업환경 따로 Electron을 다시 빌드하지 않는 경우 간단히 어플리케이션을 Electron의 리소스 디렉터리에