branch: externals/pyim
commit 36502dd5df5c91d8f91a4f54c01f02346d5af411
Author: Feng Shu <tuma...@163.com>
Commit: Feng Shu <tuma...@163.com>
Update README.org
---
README.org | 42 ++++++++++++++++++++----------------------
1 file changed, 20 insertions(+), 22 deletions(-)
diff --git a/README.org b/README.org
index 8855c45958..4684ec4d92 100644
--- a/README.org
+++ b/README.org
@@ -7,21 +7,20 @@
#+html: <a href="http://elpa.gnu.org/devel/pyim.html";><img alt="GNU-devel
ELPA" src="https://elpa.gnu.org/devel/pyim.svg"/></a>
#+html: <a href="https://melpa.org/#/pyim";><img alt="MELPA"
src="https://melpa.org/packages/pyim-badge.svg"/></a>
-* Changlog
+* 不兼容更新
** <2021-04-28 Wed> 五笔输入法和仓颉输入法的不兼容更新
-五笔输入法和仓颉输入法的 code-prefix 原来是使用一个标点符号作为 code-prefix, 现
-在使用 "wubi/" 和 "cangjie/" 这种形式的 code-prefix, 减少不同输入法误用相同
-code-prefix 带来的词库冲突。
+五笔输入法和仓颉输入法原来使用一个标点符号作为 code-prefix, 现在使用 "wubi/" 和
+"cangjie/" 这种形式的 code-prefix, 这样可以减少不同输入法误用同一个 code-prefix
+带来的词库冲突。
五笔输入法的 scheme 设置已经移到 pyim-wbdict 包，仓颉输入法的 scheme 设置已经移
-动到 pyim-cangjie5dict 包。
+到 pyim-cangjie5dict 包。
-对于使用上述两个包的用户，此次变更不受影响，因为我已经更新两个包，让其使用新的
-code-prefix.
+使用上述两个包的用户，此次变更不受影响，因为两个包使用新的 code-prefix.
-受影响的是自己维护词库的五笔和仓颉用户，需要做以下更新：
+受影响的是自己维护五笔和仓颉词库用户，这些用户需要做以下更新：
1. 五笔用户
1. 需要 (require 'pyim-wbdict), 加载五笔 scheme 设置。
2. 需要将自己的五笔词库文件中的 code-prefix "." 替换为 "wubi/".
@@ -34,9 +33,8 @@ code-prefix.
[[file:./snapshots/pyim-linux-x-with-toolkit.png]]
* 简介
-pyim 是 Emacs 环境下的一个中文输入法，最初它只支持全拼输入，所以当时 "pyim" 代表
-"Chinese Pinyin Input Method" 的意思，后来根据同学的提议，添加了五笔等输入法的支
-持，再叫 “拼音输入法” 就不太合适了，所以你现在可以叫它 “朋友输入法”
+pyim 是 Emacs 环境下的一个中文输入法，最初这个输入法只支持全拼输入，后来根据同学
+的提议，添加了五笔等输入法的支持，“pyim” 现在可以理解为：
#+begin_center
(Peng You input method)
@@ -44,10 +42,10 @@ pyim 是 Emacs 环境下的一个中文输入法，最初它只支持全拼输
* 背景
-pyim 的代码源自 Emacs-eim。
+pyim 源于 Emacs-eim。
-Emacs-eim 是 Emacs 环境下的一个中文输入法框架， 支持拼音，五笔，仓颉以及二笔等多
-种输入法，但遗憾的是，2008 年之后它就停止了开发。
+Emacs-eim 是 Emacs 环境下的一个中文输入法框架， 支持拼音，五笔，仓颉，二笔等多种
+输入法，但遗憾的是，2008 年之后它就停止了开发。
虽然外部输入法功能强大，但不能和 Emacs 默契的配合，这一点极大的损害了 Emacs 那种
*行云流水* 的感觉。而本人在使用 Emacs-eim 的过程中发现：
@@ -63,11 +61,11 @@ pyim 的目标是： *尽最大的努力成为一个好用的 Emacs 中文输入
1. Fallback: 当外部输入法不能使用时，比如在 console 或者 cygwin 环境下，尽最大可
能让 Emacs 用户不必为输入中文而烦恼。
-2. Integration: 尽最大可能减少输入法切换频率，让中文输入不影响 Emacs的体验。
+2. Integration: 尽最大可能减少输入法切换频率，让中文输入不影响 Emacs 的体验。
3. Exchange: 尽最大可能简化 pyim 使用其他优秀输入法的词库的难度和复杂度。
* 特点
-1. pyim 支持全拼，双拼，五笔和仓颉等，其中对全拼的支持最好。
+1. pyim 支持全拼，双拼，五笔和仓颉等输入法，其中对全拼的支持最好。
2. pyim 通过添加词库的方式优化输入法。
3. pyim 使用文本词库格式，方便处理。
4. pyim 可以作为 rime 的前端使用。
@@ -131,8 +129,8 @@ pyim 的目标是： *尽最大的努力成为一个好用的 Emacs 中文输入
#+end_src
** 添加词库文件
-pyim 当前的默认的拼音词库是 pyim-basedict, 这个词库的词条量8万左右，是一个 *非
-常小* 的拼音词库，源于：libpinyin 项目
+pyim 默认使用 pyim-basedict 词库, 这个词库的词条量8万左右，是一个 *非常小* 的拼
+音词库，源于：libpinyin 项目
如果 pyim-basedict 不能满足需求，用户可以使用其他方式为 pyim 添加拼音词库，具体
方式请参考 [[如何添加自定义拼音词库]] 小结。
@@ -413,7 +411,7 @@ pyim 当前内置三种指示器实现方式：
** 如何添加自定义拼音词库
pyim 默认没有携带任何拼音词库，用户可以使用下面几种方式，获取质量较好的拼音词库：
-*** 第－种方式 (Windows 用户推荐使用)
+*** 第一种方式 (Windows 用户推荐使用)
使用词库转换工具将其他输入法的词库转化为 pyim 使用的词库：这里只介绍 windows 平
台下的一个词库转换软件：
@@ -524,7 +522,7 @@ pyim 安装后，可以通过下面的设置开启拼音搜索功能：
(pyim-isearch-mode 1)
#+end_example
-注意：这个功能有一些限制，搜索字符串中只能出现 “a-z” 和 “’”，如果有其他字符（比
+注意：这个功能有一些限制，搜索字符串中只能出现 “a-z” 和 “'”，如果有其他字符（比
如 regexp 操作符），则自动关闭拼音搜索功能。
开启这个功能后，一些 isearch 扩展有可能失效，如果遇到这种问题，
@@ -565,8 +563,8 @@ pyim 安装后，可以通过下面的设置开启拼音搜索功能：
** 让 vertico, selectrum 等补全框架，通过 orderless 支持拼音搜索候选项功能。
#+begin_example
-(defun my-orderless-regexp (orig_func component)
- (let ((result (funcall orig_func component)))
+(defun my-orderless-regexp (orig-func component)
+ (let ((result (funcall orig-func component)))
(pyim-cregexp-build result)))
(advice-add 'orderless-regexp :around #'my-orderless-regexp)
![https://elpa.gnu.org/devel/pyim.svg"/](https://elpa.gnu.org/devel/pyim.svg"/){kind=link}
![https://melpa.org/packages/pyim-badge.svg"/](https://melpa.org/packages/pyim-badge.svg"/){kind=link}