Update documents.

This commit is contained in:
Hiroyuki Komatsu
2021-07-10 12:21:21 +09:00
parent 9f44ea26b5
commit 343cc41146
4 changed files with 103 additions and 2 deletions

1
.gitignore vendored
View File

@@ -17,6 +17,7 @@
/docker/ubuntu20.04/src/ /docker/ubuntu20.04/src/
# Temporary working dirs # Temporary working dirs
/oss
/src-* /src-*
/src_* /src_*

View File

@@ -2,7 +2,13 @@ Contributing Guide
================== ==================
## Pull Requests ## Pull Requests
**Mozc team is not accepting pull requests for files under src/.** **Pull requests to the Mozc project are limited to the specific directories.**
Files and directories we may accept pull requests.
* files in the top directory
* docker/
* docs/
* src/data/test/quality_regression/test/
Although Google company policy certainly allows Mozc team to accept pull Although Google company policy certainly allows Mozc team to accept pull
requests, to do so Mozc team needs to move all Mozc source files into requests, to do so Mozc team needs to move all Mozc source files into

View File

@@ -1,4 +1,10 @@
**Mozc team is not accepting pull requests for files under src/.** **Pull requests to the Mozc project are limited to the specific directories.**
Files and directories we may accept pull requests.
* files in the top directory
* docker/
* docs/
* src/data/test/quality_regression/test/
Although Google company policy certainly allows Mozc team to accept pull Although Google company policy certainly allows Mozc team to accept pull
requests, to do so Mozc team needs to move all Mozc source files into requests, to do so Mozc team needs to move all Mozc source files into

88
docs/configurations.md Normal file
View File

@@ -0,0 +1,88 @@
# Configurations
## IBus
IBus specific configurations are customizable in `~/.config/mozc/ibus_config.textproto`.
The file path may be `~/.mozc/ibus_config.textproto` if `~/.mozc` directry already exists.
Here is the default configuration.
```
engines {
name : "mozc-jp"
longname : "Mozc"
layout : "default"
layout_variant : ""
layout_option : ""
rank : 80
}
active_on_launch: False
```
The variables of `engines` are mapped to the same named variables of IBus.
**Note:**
After modification of `ibus_config.textproto`,
`ibus write-cache; ibus restart` might be necessary to apply changes.
### Specify the keyboard layout
`layout` represents the keyboard layout (e.g. JIS keyboard, US keyboard, etc.).
Sample configuration
```
engines {
name : "mozc-jp"
longname : "Mozc"
layout : "ja" # or "us"
layout_variant : ""
layout_option : ""
rank : 80
}
active_on_launch: False
```
### Activate Mozc on launch
`active_on_launch` represents the default input.
If it's True, Hiragana input is the default mode.
Sample configuration
```
engines {
name : "mozc-jp"
longname : "Mozc"
layout : "default"
layout_variant : ""
layout_option : ""
rank : 80
}
active_on_launch: True # default is False.
```
### Multiple engines with different keyboard layouts
`engines` can be multiple entries.
```
engines {
name : "mozc-jp"
longname : "Mozc"
layout : "ja"
layout_variant : ""
layout_option : ""
rank : 80
}
engines {
name : "mozc-us"
longname : "Mozc US"
layout : "us"
layout_variant : ""
layout_option : ""
rank : 80
}
active_on_launch: False
```