Skip to content

Commit

Permalink
Update CONFIGURATION (#371)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Riey
Riey authored Mar 18, 2021
1 parent af2efac commit b3a91ba
Show file tree
Hide file tree
Showing 2 changed files with 144 additions and 79 deletions.
109 changes: 71 additions & 38 deletions docs/CONFIGURATION.ko.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,24 +15,6 @@
| 기본값 |`Latin`|
|--------|-------|

## category_layout

언어별 키보드 자판을 설정합니다.

### 내장된 자판들

* `direct`
* `qwerty`
* `colmak`
* `dubeolsik`(두벌식)
* `sebeolsik-390`(세벌식 390)
* `sebeolsik-391`(세벌식 최종)
* `sebeolsik-3sin-1995`(신세벌식 1995)
* `sebeolsik-3sin-p2`(신세벌식 p2 *옛한글은 미구현*)

`$XDG_CONFIG_HOME/kime/layouts/`에 위 목록에 없는 키보드 자판을 YAML 파일로 직접 만들 수도 있습니다. [dubeolsik.yaml]을 참고해 보세요.

[dubeolsik.yaml]: ../src/engine/core/data/dubeolsik.yaml

### 기본값

Expand All @@ -49,13 +31,6 @@ category_layout:
| 기본값 |`false`|
|--------|-------|

## word_commit

커밋을 단어 단위로 합니다.

| 기본값 |`false`|
|--------|-------|

## icon_color

indicator에서 사용할 아이콘의 색을 정합니다
Expand All @@ -80,6 +55,10 @@ indicator에서 사용할 아이콘의 색을 정합니다

언어별 단축키입니다 전역 단축키를 덮어씁니다

### mode_hotkeys

모드별 단축키입니다 전역과 언어별 단축키를 덮어씁니다

### 내용

#### behavior
Expand All @@ -92,6 +71,10 @@ indicator에서 사용할 아이콘의 색을 정합니다

해당 언어로 바꿉니다

##### Mode: InputMode

해당 모드를 활성화합니다

##### Commit

현재 조합상태를 종료하고 커밋합니다
Expand Down Expand Up @@ -125,13 +108,63 @@ XIM에서 쓸 편집창 글꼴과 크기입니다.
| 기본값 |`[D2Coding, 15.0]`|
|--------|------------------|

## layout_addons
## latin

로마자 입력기를 설정합니다.

### layout

로마자 자판을 설정합니다.

| 기본값 |`Qwerty`|
|--------|-------|

### 가능한 자판들

* `Qwerty`
* `Dvorak`
* `Colemak`

## hangul

한글 입력기를 설정합니다.

### layout

한글 자판을 설정합니다.

| 기본값 |`dubeolsik`|
|--------|-------|

자판의 추가 기능을 설정 합니다
### 내장된 자판들

* `direct`
* `qwerty`
* `colmak`
* `dubeolsik`(두벌식)
* `sebeolsik-390`(세벌식 390)
* `sebeolsik-391`(세벌식 최종)
* `sebeolsik-3sin-1995`(신세벌식 1995)
* `sebeolsik-3sin-p2`(신세벌식 p2 *옛한글은 미구현*)

`$XDG_CONFIG_HOME/kime/layouts/`에 위 목록에 없는 키보드 자판을 YAML 파일로 직접 만들 수도 있습니다. [dubeolsik.yaml]을 참고해 보세요.

[dubeolsik.yaml]: ../src/engine/core/data/dubeolsik.yaml

### word_commit

커밋을 단어 단위로 합니다.

| 기본값 |`false`|
|--------|-------|

### addons

한글 자판의 추가 기능을 설정 합니다

형식은 `자판이름: [Addon]` 입니다 `all`은 모든 자판에 적용됩니다.

### 기본값
#### 기본값

```yaml
all:
Expand All @@ -140,9 +173,9 @@ dubeolsik:
- TreatJongseongAsChoseong
```

### Addons
#### Addons

#### TreatJongseongAsChoseong
##### TreatJongseongAsChoseong

종성을 초성처럼 취급합니다.

Expand All @@ -151,7 +184,7 @@ dubeolsik:
값 + ㅏ = 갑사
```

#### TreatJongseongAsChoseongCompose
##### TreatJongseongAsChoseongCompose

이전 종성과 현재 초성을 조합합니다.

Expand All @@ -162,7 +195,7 @@ dubeolsik:
앇 + ㅅ = 악ㅆ
```

#### FlexibleComposeOrder
##### FlexibleComposeOrder

초성과 중성의 순서를 바꿔도 조합이 되도록 합니다 오타 교정에 도움이 될 수 있습니다.

Expand All @@ -171,7 +204,7 @@ dubeolsik:
ㅚ + ㄱ = 괴
```

#### ComposeChoseongSsang
##### ComposeChoseongSsang

같은 자음을 두 번 누를 때 쌍자음을 합성합니다.

Expand All @@ -183,24 +216,24 @@ dubeolsik:
ㅈ + ㅈ = ㅉ
```

#### DecomposeChoseongSsang
##### DecomposeChoseongSsang

쌍자음에 백스페이스를 누를 때 쌍자음을 분해시킵니다. (e.g. ㄲ -> ㄱ)

#### ComposeJungseongSsang
##### ComposeJungseongSsang

```txt
ㅑ + ㅣ = ㅒ
ㅕ + ㅣ = ㅖ
```

#### DecomposeJungseongSsang
##### DecomposeJungseongSsang

#### ComposeJongseongSsang
##### ComposeJongseongSsang

```txt
ㄱ + ㄱ = ㄲ
ㅅ + ㅅ = ㅆ
```

#### DecomposeJongseongSsang
##### DecomposeJongseongSsang
114 changes: 73 additions & 41 deletions docs/CONFIGURATION.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,29 +17,8 @@ You can also change the location of config file using [`$XDG_CONFIG_DIR` or

Set default InputCategory when IME starts, please select between `Latin` and `Hangul`

| 기본값 |`Latin`|
|--------|-------|

## category_layout

Set layout per categories

### Embeded layouts

* `direct`
* `qwerty`
* `colmak`
* `dubeolsik`(두벌식)
* `sebeolsik-390`(세벌식 390)
* `sebeolsik-391`(세벌식 최종)
* `sebeolsik-3sin-1995`(신세벌식 1995)
* `sebeolsik-3sin-p2`(신세벌식 p2 *옛한글은 미구현*)

Custom layout can be added by creating layout YAML files
at `$XDG_CONFIG_HOME/kime/layouts/` directory. See [dubeolsik.yaml] for the
structure of keyboard layout file.

[dubeolsik.yaml]: ../src/engine/core/data/dubeolsik.yaml
| default |`Latin`|
|---------|-------|

## global_category_state

Expand All @@ -48,13 +27,6 @@ Set category state globally
| default |`false`|
|---------|-------|

## word_commit

Let commit by word

| default |`false`|
|---------|-------|

## icon_color

Set icon color for indicator
Expand All @@ -79,6 +51,10 @@ Global hotkey

Hotkey for specific category override global hotkey

### mode_hotkeys

Hotkey for specific mode override global, category hotkey

### content

#### behavior
Expand All @@ -91,6 +67,10 @@ Toggle Left and Right category

Switch to specific category

##### Mode: InputMode

Enable specific mode

##### Commit

End current preedit state then commit
Expand Down Expand Up @@ -124,13 +104,65 @@ Preedit window font name and size for XIM
| default |`[D2Coding, 15.0]`|
|---------|------------------|

## layout_addons
## latin

Set latin setting

### layout

Set latin layout

| default |`Qwerty`|
|---------|--------|

### 가능한 자판들

* `Qwerty`
* `Dvorak`
* `Colemak`

## hangul

Set hangul setting

### word_commit

Let commit by word

| default |`false`|
|---------|-------|

### layout

Set hangul layout

| default |`dubeolsik`|
|---------|-------|

#### Embeded layouts

* `direct`
* `qwerty`
* `colmak`
* `dubeolsik`(두벌식)
* `sebeolsik-390`(세벌식 390)
* `sebeolsik-391`(세벌식 최종)
* `sebeolsik-3sin-1995`(신세벌식 1995)
* `sebeolsik-3sin-p2`(신세벌식 p2 *옛한글은 미구현*)

Custom layout can be added by creating layout YAML files
at `$XDG_CONFIG_HOME/kime/layouts/` directory. See [dubeolsik.yaml] for the
structure of keyboard layout file.

[dubeolsik.yaml]: ../src/engine/core/data/dubeolsik.yaml

### layout_addons

Adjust layout addons

format is `layout_name: [Addon]`, `all` applys all layouts

### default
#### default

```yaml
all:
Expand All @@ -139,9 +171,9 @@ dubeolsik:
- TreatJongseongAsChoseongg
```
### Addons
#### Addons
#### TreatJongseongAsChoseong
##### TreatJongseongAsChoseong
Treat jongseong as choseong
Expand All @@ -150,7 +182,7 @@ Treat jongseong as choseong
값 + ㅏ = 갑사
```

#### TreatJongseongAsChoseongCompose
##### TreatJongseongAsChoseongCompose

Compose previous jongseong and current choseong

Expand All @@ -161,7 +193,7 @@ Note that it depends on other addons this example is only work when `ComposeChos
앇 + ㅅ = 악ㅆ
```

#### FlexibleComposeOrder
##### FlexibleComposeOrder

Compose choseong and jungseong even order is reversed it could be help for fix typo error.

Expand All @@ -170,7 +202,7 @@ Compose choseong and jungseong even order is reversed it could be help for fix t
ㅚ + ㄱ = 괴
```

#### ComposeChoseongSsang
##### ComposeChoseongSsang

When you press same choseong it will be ssangjaum

Expand All @@ -182,20 +214,20 @@ When you press same choseong it will be ssangjaum
ㅈ + ㅈ = ㅉ
```

#### DecomposeChoseongSsang
##### DecomposeChoseongSsang

Same as above but work on backspace(e.g. ㄲ -> ㄱ)

#### ComposeJungseongSsang
##### ComposeJungseongSsang

```txt
ㅑ + ㅣ = ㅒ
ㅕ + ㅣ = ㅖ
```

#### DecomposeJungseongSsang
##### DecomposeJungseongSsang

#### ComposeJongseongSsang
##### ComposeJongseongSsang

```txt
ㄱ + ㄱ = ㄲ
Expand Down

0 comments on commit b3a91ba

Please sign in to comment.