- Chinese-pyim 使用说明
- 截图
- 简介
- 背景
- 目标
- 特点
- 安装
- 配置
- 使用
- 捐赠
- Tips
- Chinese-pyim 出现错误时，如何开启 debug 模式
- 选词框弹出位置不合理或者选词框内容显示不全
- 如何查看 Chinese-pyim 文档。
- 将光标处的拼音字符串转换为中文 (与 vimim 的 “点石成金” 功能类似)
- 如何添加自定义拼音词库
- 如何手动安装和管理词库
- 如何合并两个词库文件
- 如何快速切换词库
- 将汉字字符串转换为拼音字符串
- 中文分词
- 获取光标处的中文词条
- 让 `forward-word' 和 `back-backward’ 在中文环境下正常工作
- 为 isearch 相关命令添加拼音搜索支持
- 使用 Chinese-pyim 改善 company-mode 中文补全的体验
Chinese-pyim (Chinese Pinyin Input Method) 是 emacs 环境下的一个中文拼音输入法。
Chinese-pyim 的代码源自 emacs-eim。
emacs-eim 是 emacs 环境下的一个中文输入法框架， 支持拼音，五笔，仓颉以及二笔等多种输入法，但遗憾的是，2008 年之后它就停止了开发，我认为主要原因是外部中文输入法快速发展。
虽然外部输入法功能强大，但不能和 emacs 默契的配合，这一点极大的损害了 emacs 那种 行云流水 的感觉。而本人在使用（或者叫折腾） emacs-eim 的过程中发现：
- 当 emacs-eim 拼音词库词条超过100万时，选词频率大大降低，中文体验增强。
- 随着使用时间的延长，emacs-eim会越来越好用（个人词库的积累）。
于是我 fork 了 emacs-eim 拼音输入法相关的代码, 创建了一个项目：chinese-pyim。
Chinese-pyim 的目标是： 尽最大的努力成为一个好用的 emacs 中文拼音输入法 ，具体可表现为三个方面：
- Fallback: 当外部输入法不能使用时，比如在 console或者cygwin环境下，尽最大可能让 emacs 用户不必为输入中文而烦恼。
- Integration: 尽最大可能减少输入法切换频率，让中文输入不影响 emacs 的体验。
- Exchange: 尽最大可能简化 Chinese-pyim 使用其他优秀输入法的词库的难度和复杂度。
- Chinese-pyim 只是一个拼音输入法，安装配置方便快捷，一般只能通过添加词库的方式优化输入法。
- Chinese-pyim 只使用最简单的文本词库格式，可以快速方便的利用其他输入法的词库。
-
配置melpa源，参考：http://melpa.org/#/getting-started
-
M-x package-install RET chinese-pyim RET
-
在emacs配置文件中（比如: ~/.emacs）添加如下代码：
(require 'chinese-pyim)
对 Chinese-pyim 感兴趣的同学，可以看看我的 Chinese-pyim 配置，大体了解一下 Chinese-pyim 的用法：Tumashu's emacs configure 。
用户可以使用三种方法为 Chinese-pyim 添加拼音词库，具体方式请参考 1.10.5 小结。
注意：每一个词库文件必须按行排序（准确的说，是按每一行的拼音code排序），因为`Chinese-pyim' 寻找词条时，使用二分法来优化速度，而二分法工作的前提就是对文件按行排序。具体细节请参考：`pyim-bisearch-word' 。当发现词库排序不正确时（比如：用户手动调整词库文件后），记得运行函数 `pyim-update-dict-file' 重新对文件排序。
(setq default-input-method "chinese-pyim")
(global-set-key (kbd "C-\\") 'toggle-input-method)
| 输入法快捷键 | 功能 |
|---|---|
| C-n 或 M-n 或 + | 向下翻页 |
| C-p 或 M-p 或 - | 向上翻页 |
| C-f | 选择下一个备选词 |
| C-b | 选择上一个备选词 |
| SPC | 确定输入 |
| RET 或 C-m | 字母上屏 |
| C-c | 取消输入 |
| C-g | 取消输入并保留已输入的中文 |
| TAB | 模糊音调整 |
Chinese-pyim 支持双拼模式，用户可以通过变量 `pyim-default-pinyin-scheme' 来设定当前使用的双拼方案，比如：
(setq pyim-default-pinyin-scheme 'pyim-shuangpin)
注意：
- 用户可以使用变量 `pyim-pinyin-schemes' 添加自定义双拼方案。
- 用户可能需要重新设置 `pyim-translate-trigger-char'。
用户可以通过下面的设置让 Chinese-pyim 在 光标处 显示一个选词框：
-
使用 popup 包来绘制选词框 （emacs overlay 机制）
(setq pyim-use-tooltip 'popup) -
使用 pos-tip 包来绘制选词框（emacs tooltip 机制）
(setq pyim-use-tooltip 'pos-tip)
注：Linux 平台下，emacs 可以使用 GTK 来绘制选词框：
(setq pyim-use-tooltip 'pos-tip)
(setq x-gtk-use-system-tooltips t)
GTK 选词框的字体设置可以参考：GTK resources 。
Chinese-pyim 的 tooltip 选词框默认使用 双行显示 的样式，在一些特殊的情况下（比如：popup 显示的菜单错位），用户可以使用 单行显示 的样式：
(setq pyim-guidance-format-function 'pyim-guidance-format-function-one-line)
注：用户也可以自定义 guidance 格式化函数。
可以通过设置 `pyim-fuzzy-pinyin-alist' 变量来自定义模糊音。
Chinese-pyim 内置 了5种词语联想方式：
-
`pinyin-similar' 搜索拼音类似的词条做为联想词，如果输入 "ni-hao" ，那么搜索拼音与 "ni-hao" 类似的词条（比如："ni-hao-a"）作为联想词。
-
`pinyin-shouzimu' 搜索拼音首字母对应的词条做为联想词，如果输入 "ni-hao" ，那么同时搜索 code 为 "n-h" 的词条做为联想词。
-
`pinyin-znabc' 类似智能ABC的词语联想(源于 emacs-eim)。
-
`guess-words' 以上次输入的词条为 code，然后在 guessdict 中搜索，用搜索得到的词条来提高输入法识别精度。
注意：这个方法需要用户安装 guessdict 词库，guessdict 词库文件可以用 `pyim-article2dict-guessdict' 命令生成，不想折腾的用户也可以从下面的地址下载样例词库：(注意：请使用另存为，不要直接点击链接)。
http://tumashu.github.io/chinese-pyim-guessdict/pyim-guessdict.gpyim
-
`dabbrev' 搜索当前 buffer, 或者其他 buffer 中已经存在的中文文本，得到匹配的候选词，通过这些候选词来提高输入法的识别精度。
注意: 如果 emacs 打开的 buffer 太多或者太大, 输入法 可能 出现卡顿。
Chinese-pyim 默认开启了词语联想功能，但用户可以通过下面的代码来调整设置，比如：
(setq pyim-enable-words-predict '(dabbrev pinyin-similar pinyin-shouzimu guess-words))
开启词语联想功能有时候会导致输入法卡顿，用户可以通过下面的方式关闭：
(setq pyim-enable-words-predict nil)
- 第一种方法：使用命令 `pyim-toggle-full-width-punctuation'，全局切换。
- 第二种方法：使用命令 `pyim-punctuation-translate-at-point' 只切换光标处标点的样式。
- 第三种方法：设置变量 `pyim-translate-trigger-char' ，输入变量设定的字符会切换光标处标点的样式。
- `pyim-create-word-without-pinyin' 直接将一个中文词条加入个人词库的函数，用于编程环境。
- `pyim-create-word-at-point:"N"char' 这是一组命令，从光标前提取N个汉字字符组成字符串，并将其加入个人词库。
- `pyim-translate-trigger-char' 以默认设置为例：在“我爱吃红烧肉”后输入“5v” 可以将“爱吃红烧肉”这个词条保存到用户个人词频文件。
- `pyim-delete-word-from-personal-buffer' 从个人词频文件对应的 buffer 中删除当前高亮选择的词条。
- 根据环境自动切换到英文输入模式，使用 pyim-english-input-switch-functions 配置。
- 根据环境自动切换到半角标点输入模式，使用 pyim-punctuation-half-width-functions 配置。
注意：上述两个功能使用不同的变量设置， 千万不要搞错 。
-
根据环境自动切换到英文输入模式
探针函数 功能说明 pyim-probe-program-mode 如果当前的 mode 衍生自 prog-mode，那么仅仅在字符串和 comment 中开启中文输入模式 pyim-probe-org-speed-commands 解决 org-speed-commands 与 Chinese-pyim 冲突问题 pyim-probe-isearch-mode 使用 isearch 搜索时，强制开启英文输入模式 注意：想要使用这个功能，pyim-isearch-enable-pinyin-search 必须设置为 t pyim-probe-org-structure-template 使用 org-structure-template 时，关闭中文输入模式 1. 当前字符为中文字符时，输入下一个字符时默认开启中文输入 pyim-probe-dynamic-english 2. 当前字符为其他字符时，输入下一个字符时默认开启英文输入 3. 使用命令 pyim-convert-pinyin-at-point 可以将光标前的拼音字符串强制转换为中文。 激活方式：
(setq-default pyim-english-input-switch-functions '(probe-function1 probe-function2 probe-function3))注：上述函数列表中，任意一个函数的返回值为 t 时，Chinese-pyim 切换到英文输入模式。
-
根据环境自动切换到半角标点输入模式
探针函数 功能说明 pyim-probe-punctuation-line-beginning 行首强制输入半角标点 pyim-probe-punctuation-after-punctuation 半角标点后强制输入半角标点 激活方式：
(setq-default pyim-punctuation-half-width-functions '(probe-function4 probe-function5 probe-function6))注：上述函数列表中，任意一个函数的返回值为 t 时，Chinese-pyim 切换到半角标点输入模式。
您可以通过小额捐赠的方式支持 Chinese-pyim 的开发工作，具体方式：
-
通过支付宝收款账户：[email protected]
-
通过支付宝钱包扫描：
(setq debug-on-error t)
可以通过设置 `pyim-tooltip-width-adjustment' 变量来手动校正。
- 选词框内容显示不全：增大变量值
- 选词框弹出位置不合理：减小变量值
Chinese-pyim 开发使用 lentic 文学编程模式，代码文档隐藏在comment中，如果用户喜欢阅读 html 格式的文档，可以查看在线文档；
http://tumashu.github.io/chinese-pyim/
(global-set-key (kbd "M-i") 'pyim-convert-pinyin-at-point)
Chinese-pyim 默认没有携带任何拼音词库，用户可以使用下面四种方式，获取质量较好的拼音词库：
-
第一种方式 (懒人推荐使用)
获取其他 Chinese-pyim 用户的拼音词库，比如，某个同学测试 Chinese-pyim 时创建了一个中文拼音词库，词条数量大约60万，文件大约20M，(注意：请使用另存为，不要直接点击链接)。
http://tumashu.github.io/chinese-pyim-bigdict/pyim-bigdict.pyim
下载上述词库后，运行 `pyim-dicts-manager' ，按照命令提示，将下载得到的词库文件信息添加到 `pyim-dicts' 中，最后运行命令 `pyim-restart' 或者重启 emacs，这个词库使用 `utf-8-unix' 编码。
-
第二种方式 (Windows 用户推荐使用)
使用词库转换工具将其他输入法的词库转化为Chinese-pyim使用的词库：这里只介绍windows平台下的一个词库转换软件：
- 软件名称： imewlconverter
- 中文名称： 深蓝词库转换
- 下载地址：https://github.com/studyzy/imewlconverter
- 依赖平台： Microsoft .NET Framework (>= 3.5)
使用方式：
如果生成的词库词频不合理，可以按照下面的方式处理（非常有用的功能）：
生成词库后，运行 `pyim-dicts-manager' ，按照命令提示，将转换得到的词库文件的信息添加到 `pyim-dicts' 中，完成后运行命令 `pyim-restart' 或者重启emacs。
-
第三种方式 (Linux & Unix 用户推荐使用)
E-Neo 同学编写了一个简单的词库转换工具: scel2pyim , 这个小工具可以直接将搜狗输入法的细胞词库转换为 Chinese-pyim 使用的文本词库， pyim-dicts-manager 中 “导入搜狗输入法细胞词库” 功能就是依靠这个工具实现。
- 软件名称： scel2pyim
- 下载地址：https://github.com/E-Neo/scel2pyim
- 编写语言： C语言
按照说明安装好 scel2pyim 后，将scel2pyim命令所在的目录添加到系统PATH，或者在 emacs 配置文件中添加代码：
(setq pyim-dicts-manager-scel2pyim-command "/path/to/scel2pyim") -
第四种方式 (喜欢折腾的人推荐使用)
获取中文词条，然后使用命令为词条添加拼音code。中文词条的获取途径很多，比如：
- 从其它输入法中导出。
- 获取中文文章，通过分词系统分词得到。
- 中文处理工具自带的dict。
- 其它。
相关命令有三个：
- `pyim-article2dict-chars' 将文章中游离汉字字符转换为拼音词库。
- `pyim-article2dict-words' 将文章中中文词语转换为拼音词库。
- `pyim-article2dict-misspell-words' 将文章中连续的游离词组成字符串后，转换为拼音词库。
- `pyim-article2dict-guessdict' 将文章中词条转换为 guessdict词库。
注意：在运行上述两个命令之前，必须确保待转换的文章中，中文词汇已经使用 空格 强制隔开。
最后将生成的词库按上述方法添加到 Chinese-pyim 中就可以了。
这里假设有两个词库文件：
- /path/to/pyim-dict1.pyim
- /path/to/pyim-dict2.pyim
在~/.emacs文件中添加如下一行配置。
(setq pyim-dicts
'((:name "dict1" :file "/path/to/pyim-dict1.pyim" :coding gbk-dos :dict-type pinyin-dict)
(:name "dict2" :file "/path/to/pyim-dict2.pyim" :coding gbk-dos :dict-type pinyin-dict)))
注意事项:
- 必须使用词库文件的绝对路径。
- 正确设置coding，否则会出现乱码。
假设有两个词库文件：
- file-a.pyim
- file-b.pyim
合并方法：
-
将两个词库文件的内容合并到一起，比如：
cat file-a.pyim file-b.pyim > output.pyim -
使用 emacs 打开合并后的文件：output.pyim
-
运行 pyim-update-dict-file 命令对 output.pyim 的内容进行排序，然后保存。
用户可以自定义类似的命令来实现快速切换拼音词库。
(defun pyim-use-dict:bigdict ()
(interactive)
(setq pyim-dicts
'((:name "BigDict"
:file "/path/to/pyim-bigdict.pyim"
:coding utf-8-unix
:dict-type pinyin-dict)))
(pyim-restart-1 t))
下面两个函数可以将中文字符串转换的拼音字符串或者列表，用于 emacs-lisp 编程。
- `pyim-hanzi2pinyin' （考虑多音字）
- `pyim-hanzi2pinyin-simple' （不考虑多音字）
Chinese-pyim 包含了一个简单的分词函数：`pyim-split-chinese-string'. 这个函数使用暴力匹配模式来分词，所以， 不能检测出 Chinese-pyim 词库中不存在的中文词条。另外，这个函数的分词速度比较慢，仅仅适用于中文短句的分词，不适用于文章分词。根据评估，20个汉字组成的字符串需要大约0.3s， 40个汉字消耗1s，随着字符串长度的增大消耗的时间呈几何倍数增加。
举例来说：
(("天安" 5 7)
我爱北京*** -> ("***" 5 8)
("北京" 3 5)
("我爱" 1 3))
其中，每一个词条列表中包含三个元素，第一个元素为词条本身，第二个元素为词条相对于字符串的起始位置，第三个元素为词条结束位置。
另外一个分词相关的函数是 `pyim-split-chinese-string2string', 这个函数仅仅将一个中文字符串分词，在分词的位置用空格或者用户自定义的分隔符隔开，然后返回新的字符串。
Chinese-pyim 包含了一个简单的命令：`pyim-get-words-list-at-point', 这个命令可以得到光标处的 英文 或者 中文 词条的 *列表*，这个命令依赖分词函数： `pyim-split-chinese-string'。
中文词语没有强制用空格分词，所以 emacs 内置的命令 `forward-word' 和 `backward-word' 在中文环境不能按用户预期的样子执行，而是 forward/backward “句子” ，Chinese-pyim 自带的两个命令可以在中文环境下正常工作：
- `pyim-forward-word
- `pyim-backward-word
用户只需将其绑定到快捷键上就可以了，比如：
(global-set-key (kbd "M-f") 'pyim-forward-word)
(global-set-key (kbd "M-b") 'pyim-backward-word)
chinese-pyim 安装后，可以通过下面的设置开启拼音搜索功能：
(setq pyim-isearch-enable-pinyin-search t)
值得注意的是：这个功能有一些限制：搜索字符串中只能出现 “a-z” 和 “’”，如果有其他字符（比如 regexp 操作符），则自动关闭拼音搜索功能。
如果用户开启了拼音搜索功能，可以使用下面的方式 强制关闭 isearch 搜索框中文输入（即使在 Chinese-pyim 激活的时候）。
(setq-default pyim-english-input-switch-functions
'(pyim-probe-isearch-mode))
中文词语之间没有分割字符，所以 Company-mode 在中文环境下， 补全词条 变成了 补全句子 ，可用性很差，chinese-pyim-company 通过 Chinese-pyim 自带的分词函数来分割中文字符串，改善了中文补全的体验 。
安装和使用方式：
-
安装配置 `company-mode' 扩展包，具体可以参考：emacs-helper's company configure
-
在 emacs 配置中添加如下几行代码：
(require 'chinese-pyim-company) (setq pyim-company-max-length 6)
用户也可以通过下面的方式 禁用 company 中文补全
(setq pyim-company-complete-chinese-enable nil)
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent