electron/docs-translations/ko-KR/styleguide.md

236 lines
6.5 KiB
Markdown
Raw Normal View History

2016-09-25 07:04:10 +00:00
# Electron 문서 스타일 가이드
2015-08-31 00:52:28 +00:00
2016-09-25 07:04:10 +00:00
Electron 문서 작성 가이드입니다.
2015-08-31 00:52:28 +00:00
2016-09-25 07:04:10 +00:00
## 제목
2015-08-31 00:52:28 +00:00
2016-09-25 07:04:10 +00:00
* 각 페이지는 상단에 하나의 `#`-단계의 제목을 사용해야 합니다.
* 같은 페이지의 챕터는 `##`-단계의 제목을 사용해야 합니다.
* 보조 챕터는 포함 단계에 따라 `#` 수를 증가시켜야 합니다.
* 페이지 제목의 "of" 와 "and" 같은 접속사를 제외한 모든 단어는 대문자로
시작해야합니다.
* 챕터 제목은 첫 단어만 대문자로 시작합니다.
2015-08-31 00:52:28 +00:00
2016-09-25 07:04:10 +00:00
`Quick Start` 사용 예시:
2015-09-11 02:56:36 +00:00
2016-09-25 07:04:10 +00:00
```markdown
# Quick Start
...
## Main process
...
2015-09-11 02:56:36 +00:00
2016-09-25 07:04:10 +00:00
## Renderer process
2015-08-27 00:19:24 +00:00
2016-09-25 07:04:10 +00:00
...
2015-08-27 00:19:24 +00:00
2016-09-25 07:04:10 +00:00
## Run your app
2015-08-27 00:19:24 +00:00
2016-09-25 07:04:10 +00:00
...
2015-08-27 00:19:24 +00:00
2016-09-25 07:04:10 +00:00
### Run as a distribution
2015-08-27 00:19:24 +00:00
2016-09-25 07:04:10 +00:00
...
### Manually downloaded Electron binary
...
```
2015-08-27 00:19:24 +00:00
2016-09-25 07:04:10 +00:00
API 참고문서에는 이 규칙에 예외가 있습니다.
## 마크다운 규칙
* 코드 블록에서 `cmd` 대신 `bash` 를 사용하세요. (문법 강조기 입니다)
* 한줄은 영문 80 자 길이로 맞춰야 합니다.
* 2단계를 넘는 중첩 목록은 사용하지 마세요. (마크다운 렌더러 때문입니다)
* 모든 `js``javascript` 는 [표준-마크다운](http://npm.im/standard-markdown)에
의해 linted 됩니다.
## 단어 선택
* 결과를 설명할 때 "would" 대신 "will" 을 사용합니다.
* "on" 대신 "in the ___ process" 표현을 지향합니다.
## API 참고문서
다음 규칙은 API 문서에만 적용합니다.
### 페이지 제목
각 페이지는 `BrowserWindow`, `autoUpdater``session` 와 같은
`require('electron')` 에 의해 반환되는 실 객체의 이름을 제목으로 합니다.
페이지 제목 아래에는 `>` 로 시작하는 한줄 설명이 있어야합니다.
`session` 사용 예시:
```markdown
# session
> 브라우저 세션, 쿠키, 캐시, 프록시 설정 등을 관리.
```
2015-08-27 00:19:24 +00:00
2016-09-25 07:04:10 +00:00
### 모듈 메소드와 이벤트
2015-08-27 00:19:24 +00:00
2016-09-25 14:37:34 +00:00
클래스가 아닌 모듈에서 메소드와 이벤트는 `## Methods``## Events` 챕터에
2016-09-25 07:04:10 +00:00
있어야 합니다.
2015-08-27 00:19:24 +00:00
2016-09-25 07:04:10 +00:00
`autoUpdater` 사용 예시:
2016-09-25 07:04:10 +00:00
```markdown
# autoUpdater
2016-09-25 14:37:34 +00:00
## Events
2016-09-25 07:04:10 +00:00
2016-09-25 14:37:34 +00:00
### Event: 'error'
2016-09-25 07:04:10 +00:00
2016-09-25 14:37:34 +00:00
## Methods
2016-09-25 07:04:10 +00:00
### `autoUpdater.setFeedURL(url[, requestHeaders])`
```
2016-09-25 07:04:10 +00:00
### 클래스
2016-09-25 14:37:34 +00:00
* API 클래스와 모듈 클래스는 `## Class: TheClassName` 챕터 아래에 표시합니다.
2016-09-25 07:04:10 +00:00
* 한 페이지에 여러개의 클래스가 있을 수 있습니다.
* 생성자는 `###`-단계의 제목으로 표시합니다.
2016-09-25 14:37:34 +00:00
* [정적 메소드](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/static) 는 `### Statis Methods` 챕터 아래에 표시합니다.
* [인스턴스 메소드](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes#Prototype_methods) 는 `### Instance Methods` 챕터 아래에 표시합니다.
2016-09-25 08:04:34 +00:00
* 반환값이 있는 모든 메소드는 "반환값 `[유형]` - 반환값 설명" 형태의 설명으로 시작해야 합니다.
2016-09-25 07:04:10 +00:00
* 인스턴스 이벤트는 `### 인스턴스 이벤트` 챕터 아래에 표시합니다.
* 인스턴스 속성은 `### 인스턴스 속성` 챕터 아래에 표시합니다.
2016-09-25 08:04:34 +00:00
* 인스턴스 속성은 "[속성 유형]" 으로 시작해야 합니다.
2016-09-25 07:04:10 +00:00
`Session``Cookies` 클래스 사용 예시:
```markdown
# session
2016-09-25 14:37:34 +00:00
## Methods
2016-09-25 07:04:10 +00:00
### session.fromPartition(partition)
2016-09-25 14:37:34 +00:00
## Properties
2016-09-25 07:04:10 +00:00
### session.defaultSession
2016-09-25 14:37:34 +00:00
## Class: Session
2016-09-25 07:04:10 +00:00
2016-09-25 14:37:34 +00:00
### Instance Events
2016-09-25 07:04:10 +00:00
2016-09-25 14:37:34 +00:00
#### Event: 'will-download'
2016-09-25 07:04:10 +00:00
2016-09-25 14:37:34 +00:00
### Instance Methods
2016-09-25 07:04:10 +00:00
#### `ses.getCacheSize(callback)`
2016-09-25 14:37:34 +00:00
### Instance Properties
2016-09-25 07:04:10 +00:00
#### `ses.cookies`
2016-09-25 14:37:34 +00:00
## Class: Cookies
2016-09-25 07:04:10 +00:00
2016-09-25 14:37:34 +00:00
### Instance Methods
2016-09-25 07:04:10 +00:00
#### `cookies.get(filter, callback)`
```
### 메소드
메소드 챕터는 다음을 따릅니다:
```markdown
### `objectName.methodName(required[, optional]))`
* `required` String
* `optional` Integer (optional)
...
```
2016-09-25 07:04:10 +00:00
제목은 `###` 또는 `####`-단계로 합니다. 모듈이냐 클래스냐에 따라 달라집니다.
모듈에서 `objectName` 은 모듕의 이름입니다. 클래스에서 그것은 클래스의
인스턴스의 이름이며, 모듈의 이름과 달라야합니다.
예를 들어, `session` 모듈의 `Session` 클래스의 메소드는 `objectName` 으로
`ses` 를 사용해야 합니다.
선택적인 인수는 각각을 컴마로 구분하여 대괄호 `[]` 로 감쌉니다:
```
required[, optional]
```
2016-09-25 08:04:34 +00:00
아래 메소드에 각 인수에 대한 더 자세한 내용이 있습니다. 인수의 유형은 기본 유형
2016-09-25 07:04:10 +00:00
중 하나로 표시합니다.
* [`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)
* [`Boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
2016-09-25 07:15:16 +00:00
* 또는 Electron 의 [`WebContents`](api/web-contents.md)와 같은 사용자 타입
2015-08-27 00:19:24 +00:00
2016-09-25 07:04:10 +00:00
인수 또는 메소드가 특정 플랫폼에만 사용된다면, 이 플랫폼들은 자료형 다음에
공백으로 구분된 이탤릭체 목록으로 표시된다. 값은 `macOS`, `windows`, 또는
`Linux` 일 수 있습니다.
2015-08-27 00:19:24 +00:00
2016-09-25 07:04:10 +00:00
```markdown
* `animate` Boolean (optional) _macOS_ _Windows_
```
2015-08-27 00:19:24 +00:00
2016-09-25 08:04:34 +00:00
`Array` 유형의 인수는 배열이 무엇을 포함하는지 아래에 명시해야 합니다.
2016-09-25 07:04:10 +00:00
2016-09-25 08:04:34 +00:00
`Function` 유형의 인수를 위한 설명은 호출방법을 명확히 하고, 전달되는
매개변수의 유형을 표시해야 합니다.
2016-09-25 07:04:10 +00:00
### 이벤트
이벤트 챕터는 다음을 따릅니다:
```markdown
2016-09-25 14:37:34 +00:00
### Event: 'wake-up'
2016-09-25 07:04:10 +00:00
2016-09-25 14:37:34 +00:00
Returns:
2015-08-27 00:19:24 +00:00
* `time` String
2016-09-25 07:04:10 +00:00
...
```
2015-08-27 00:19:24 +00:00
2016-09-25 07:04:10 +00:00
제목은 `###` 또는 `####`-단계로 합니다. 모듈이냐 클래스냐에 따라 달라집니다.
이벤트의 인수는 메소드와 같은 규칙을 따릅니다.
### 속성
속성 챕터는 다음을 따릅니다:
2015-08-27 00:19:24 +00:00
2016-09-25 07:04:10 +00:00
```markdown
### session.defaultSession
...
2015-08-31 00:52:28 +00:00
```
2016-09-25 07:04:10 +00:00
제목은 `###` 또는 `####`-단계로 합니다. 모듈이냐 클래스냐에 따라 달라집니다.
## 문서 번역
Electron 문서의 번역본은 `docs-translations` 아래에 위치합니다.
아직 번역되지 않은 언어를 추가하려면 (일부분 포함):
* 언어의 약어로 서브 디렉토리를 만듭니다.
* 파일을 번역합니다.
* 언어 디렉토리의 `README.md` 의 링크를 번역된 문서로 변경합니다.
* 언어 디렉토리의 링크를 Electron 의
[README](https://github.com/electron/electron#documentation-translations)에
추가합니다.
참고로 `docs-translations` 아래의 파일들은 번역된 것만 있어야 합니다. 영어 원문
파일을 복사하면 안됩니다.