[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/pyim 39abbcc 3/3: Update README
From: |
ELPA Syncer |
Subject: |
[elpa] externals/pyim 39abbcc 3/3: Update README |
Date: |
Fri, 12 Mar 2021 23:57:15 -0500 (EST) |
branch: externals/pyim
commit 39abbcc8f571bb80e30cbba31da148c5bb17c033
Author: Feng Shu <tumashu@163.com>
Commit: Feng Shu <tumashu@163.com>
Update README
---
README.md | 179 +++++++++++++++++++++++++++++++++-----------------------------
1 file changed, 94 insertions(+), 85 deletions(-)
diff --git a/README.md b/README.md
index 8419512..e4b07cd 100644
--- a/README.md
+++ b/README.md
@@ -3,62 +3,63 @@ Note: this file is auto converted from pyim.el by
[el2org](https://github.com/tu
# 目录
-1. [pyim 使用说明](#org1a50b51)
- 1. [截图](#org25ff3a4)
- 2. [简介](#org780a8c5)
- 3. [背景](#org28f85b7)
- 4. [目标](#org1056777)
- 5. [特点](#org5351807)
- 6. [安装](#org3f99a8d)
- 7. [配置](#org0abf75c)
- 1. [配置实例](#org14b4c60)
- 2. [添加词库文件](#org7712405)
- 3. [激活 pyim](#orgfe2d0df)
- 8. [使用](#orgb834c8b)
- 1. [常用快捷键](#orgbb28e52)
- 2. [使用双拼模式](#org144333f)
- 3. [使用 rime 输入法](#orgd5380d2)
- 4. [使用五笔输入](#orgca2e51d)
- 5. [使用仓颉输入法](#org746da00)
- 6. [让选词框跟随光标](#org599f6a5)
- 7. [调整 tooltip 选词框的显示样式](#org79091b2)
- 8. [设置模糊音](#orgec7070f)
- 9. [使用魔术转换器](#org63a6a1d)
- 10. [切换全角标点与半角标点](#orgd10a20b)
- 11. [手动加词和删词](#org960fae7)
- 12. [pyim 高级功能](#org0d40aef)
- 9. [捐赠](#org778c2ee)
- 10. [Tips](#org2109336)
- 1. [关闭输入联想词功能 (默认开启)](#orgb0a391b)
- 2. [如何将个人词条相关信息导入和导出?](#org7109c22)
- 3. [pyim 出现错误时,如何开启 debug 模式](#org11a4c5d)
- 4. [如何查看 pyim 文档。](#orgea0afea)
- 5. [将光标处的拼音或者五笔字符串转换为中文 (与 vimim 的 “点石成金” 功能类似)](#orgd80df71)
- 6. [如何使用其它字符翻页](#org9b083fa)
- 7. [如何用 ";" 来选择第二个候选词](#org709d8a6)
- 8. [如何添加自定义拼音词库](#org96ab21d)
- 9. [如何手动安装和管理词库](#orgc1e986a)
- 10. [Emacs 启动时加载 pyim 词库](#org00bc777)
- 11. [将汉字字符串转换为拼音字符串](#org4401c59)
- 12. [中文分词](#org345a5a0)
- 13. [获取光标处的中文词条](#orgd5c17b2)
- 14. [让 \`forward-word' 和 \`back-backward’ 在中文环境下正常工作](#org4360c5c)
- 15. [为 isearch 相关命令添加拼音搜索支持](#org1ec670b)
-
-
-<a id="org1a50b51"></a>
+1. [pyim 使用说明](#org19a0ee0)
+ 1. [截图](#orgb8792e2)
+ 2. [简介](#org43de720)
+ 3. [背景](#org660eac9)
+ 4. [目标](#orgb768d9e)
+ 5. [特点](#orgafb323d)
+ 6. [安装](#org03b7889)
+ 7. [配置](#org655d84b)
+ 1. [配置实例](#org8fd73de)
+ 2. [添加词库文件](#org6e3db1d)
+ 3. [激活 pyim](#orgd8e0f61)
+ 8. [使用](#org11708fe)
+ 1. [常用快捷键](#org4ba2955)
+ 2. [使用双拼模式](#orgf35c2b3)
+ 3. [使用 rime 输入法](#orgb6a5d73)
+ 4. [使用五笔输入](#org3f5dd06)
+ 5. [使用仓颉输入法](#orgda2f7f3)
+ 6. [让选词框跟随光标](#orgf4ba754)
+ 7. [调整 tooltip 选词框的显示样式](#org36be13a)
+ 8. [设置模糊音](#org3a714dd)
+ 9. [使用魔术转换器](#orge4149b4)
+ 10. [切换全角标点与半角标点](#org0d0a400)
+ 11. [手动加词和删词](#org6d0226c)
+ 12. [pyim 高级功能](#org2074783)
+ 9. [捐赠](#orge69b3b9)
+ 10. [Tips](#org374c9de)
+ 1. [关闭输入联想词功能 (默认开启)](#org6794f93)
+ 2. [如何将个人词条相关信息导入和导出?](#org5acd91c)
+ 3. [pyim 出现错误时,如何开启 debug 模式](#org70186b7)
+ 4. [如何查看 pyim 文档。](#org0342f2f)
+ 5. [将光标处的拼音或者五笔字符串转换为中文 (与 vimim 的 “点石成金” 功能类似)](#orgf7a7e1a)
+ 6. [如何使用其它字符翻页](#org6368d16)
+ 7. [如何用 ";" 来选择第二个候选词](#org826dd31)
+ 8. [如何添加自定义拼音词库](#orgbf4f0b9)
+ 9. [如何手动安装和管理词库](#orgeb01fac)
+ 10. [Emacs 启动时加载 pyim 词库](#org0fa8718)
+ 11. [将汉字字符串转换为拼音字符串](#org6b7fbf7)
+ 12. [中文分词](#orgb60d5cb)
+ 13. [获取光标处的中文词条](#org6ff2843)
+ 14. [让 \`forward-word' 和 \`back-backward’ 在中文环境下正常工作](#org0c34af2)
+ 15. [为 isearch 相关命令添加拼音搜索支持](#orgbcca805)
+ 16. [让 ivy 支持拼音搜索候选项功能](#org6bc050b)
+
+
+<a id="org19a0ee0"></a>
# pyim 使用说明
-<a id="org25ff3a4"></a>
+<a id="orgb8792e2"></a>
## 截图
![img](./snapshots/pyim-linux-x-with-toolkit.png)
-<a id="org780a8c5"></a>
+<a id="org43de720"></a>
## 简介
@@ -66,7 +67,7 @@ pyim 是 Emacs 环境下的一个中文输入法,最初它只支持全拼输
"pyim" 代表 "Chinese Pinyin Input Method" 的意思,后来根据同学的提议,添加了五笔的支持,再叫 “拼音输入法”
就不太合适了,所以你现在可以将它理解为 “PengYou input method”: 平时像朋友一样帮助你,偶尔也像朋友一样犯二 。。。
-<a id="org28f85b7"></a>
+<a id="org660eac9"></a>
## 背景
@@ -83,7 +84,7 @@ emacs-eim 是 Emacs 环境下的一个中文输入法框架, 支持拼音,
于是我 fork 了 emacs-eim 输入法的部分代码, 创建了一个项目:pyim。
-<a id="org1056777"></a>
+<a id="orgb768d9e"></a>
## 目标
@@ -95,7 +96,7 @@ pyim 的目标是: **尽最大的努力成为一个好用的 Emacs 中文输
3. Exchange: 尽最大可能简化 pyim 使用其他优秀输入法的词库的难度和复杂度。
-<a id="org5351807"></a>
+<a id="orgafb323d"></a>
## 特点
@@ -104,7 +105,7 @@ pyim 的目标是: **尽最大的努力成为一个好用的 Emacs 中文输
3. pyim 使用文本词库格式,方便处理。
-<a id="org3f99a8d"></a>
+<a id="org03b7889"></a>
## 安装
@@ -118,12 +119,12 @@ pyim 的目标是: **尽最大的努力成为一个好用的 Emacs 中文输
(setq default-input-method "pyim")
-<a id="org0abf75c"></a>
+<a id="org655d84b"></a>
## 配置
-<a id="org14b4c60"></a>
+<a id="org8fd73de"></a>
### 配置实例
@@ -175,7 +176,7 @@ pyim 的目标是: **尽最大的努力成为一个好用的 Emacs 中文输
("C-;" . pyim-delete-word-from-personal-buffer)))
-<a id="org7712405"></a>
+<a id="org6e3db1d"></a>
### 添加词库文件
@@ -185,10 +186,10 @@ pyim 当前的默认的拼音词库是 pyim-basedict, 这个词库的词条量
1. libpinyin 项目的内置词库
2. pyim 用户贡献的个人词库
-如果 pyim-basedict 不能满足需求,用户可以使用其他方式为 pyim 添加拼音词库,具体方式请参考 [1.10.8](#org96ab21d)
小结。
+如果 pyim-basedict 不能满足需求,用户可以使用其他方式为 pyim 添加拼音词库,具体方式请参考 [1.10.8](#orgbf4f0b9)
小结。
-<a id="orgfe2d0df"></a>
+<a id="orgd8e0f61"></a>
### 激活 pyim
@@ -196,12 +197,12 @@ pyim 当前的默认的拼音词库是 pyim-basedict, 这个词库的词条量
(global-set-key (kbd "C-\\") 'toggle-input-method)
-<a id="orgb834c8b"></a>
+<a id="org11708fe"></a>
## 使用
-<a id="orgbb28e52"></a>
+<a id="org4ba2955"></a>
### 常用快捷键
@@ -295,7 +296,7 @@ pyim 当前的默认的拼音词库是 pyim-basedict, 这个词库的词条量
</table>
-<a id="org144333f"></a>
+<a id="orgf35c2b3"></a>
### 使用双拼模式
@@ -310,14 +311,14 @@ pyim 支持双拼输入模式,用户可以通过变量 \`pyim-default-scheme'
3. 用户可能需要重新设置 \`pyim-translate-trigger-char'。
-<a id="orgd5380d2"></a>
+<a id="orgb6a5d73"></a>
### 使用 rime 输入法
具体安装和使用方式请查看 pyim-liberime 包的 Commentary 部分。
-<a id="orgca2e51d"></a>
+<a id="org3f5dd06"></a>
### 使用五笔输入
@@ -349,7 +350,7 @@ pyim 支持五笔输入模式,用户可以通过变量 \`pyim-default-scheme'
键临时切换到辅助输入法来输入,选词完成之后自动退出。辅助输入法可以通过 \`pyim-assistant-scheme' 来设置。
-<a id="org746da00"></a>
+<a id="orgda2f7f3"></a>
### 使用仓颉输入法
@@ -374,7 +375,7 @@ pyim 支持其它版本的仓颉,但需要用户自己创建词库文件。
用户可以使用命令:\`pyim-search-word-code' 来查询当前选择词条的仓颉编码
-<a id="org599f6a5"></a>
+<a id="orgf4ba754"></a>
### 让选词框跟随光标
@@ -390,7 +391,7 @@ pyim 支持其它版本的仓颉,但需要用户自己创建词库文件。
注意:pyim 不会自动安装 posframe, 用户需要手动安装这个包,
-<a id="org79091b2"></a>
+<a id="org36be13a"></a>
### 调整 tooltip 选词框的显示样式
@@ -402,14 +403,14 @@ pyim 的 tooltip 选词框默认使用 **双行显示** 的样式,在一些特
注:用户可以添加函数 pyim-page-style:STYLENAME 来定义自己的选词框格式。
-<a id="orgec7070f"></a>
+<a id="org3a714dd"></a>
### 设置模糊音
可以通过设置 \`pyim-fuzzy-pinyin-alist' 变量来自定义模糊音。
-<a id="org63a6a1d"></a>
+<a id="orge4149b4"></a>
### 使用魔术转换器
@@ -424,7 +425,7 @@ pyim 的 tooltip 选词框默认使用 **双行显示** 的样式,在一些特
(setq pyim-magic-converter #'my-converter)
-<a id="orgd10a20b"></a>
+<a id="org0d0a400"></a>
### 切换全角标点与半角标点
@@ -437,7 +438,7 @@ pyim 的 tooltip 选词框默认使用 **双行显示** 的样式,在一些特
3. 第三种方法:设置变量 \`pyim-translate-trigger-char' ,输入变量设定的字符会切换光标处标点的样式。
-<a id="org960fae7"></a>
+<a id="org6d0226c"></a>
### 手动加词和删词
@@ -447,7 +448,7 @@ pyim 的 tooltip 选词框默认使用 **双行显示** 的样式,在一些特
4. \`pyim-delete-word' 从个人词库中删除当前高亮选择的词条。
-<a id="org0d40aef"></a>
+<a id="org2074783"></a>
### pyim 高级功能
@@ -577,7 +578,7 @@ pyim 的 tooltip 选词框默认使用 **双行显示** 的样式,在一些特
注:上述函数列表中,任意一个函数的返回值为 t 时,pyim 切换到半角标点输入模式。
-<a id="org778c2ee"></a>
+<a id="orge69b3b9"></a>
## 捐赠
@@ -589,19 +590,19 @@ pyim 的 tooltip 选词框默认使用 **双行显示** 的样式,在一些特
![img](snapshots/QR-code-for-author.jpg)
-<a id="org2109336"></a>
+<a id="org374c9de"></a>
## Tips
-<a id="orgb0a391b"></a>
+<a id="org6794f93"></a>
### 关闭输入联想词功能 (默认开启)
(setq pyim-enable-shortcode nil)
-<a id="org7109c22"></a>
+<a id="org5acd91c"></a>
### 如何将个人词条相关信息导入和导出?
@@ -609,14 +610,14 @@ pyim 的 tooltip 选词框默认使用 **双行显示** 的样式,在一些特
2. 导出使用命令: pyim-export
-<a id="org11a4c5d"></a>
+<a id="org70186b7"></a>
### pyim 出现错误时,如何开启 debug 模式
(setq debug-on-error t)
-<a id="orgea0afea"></a>
+<a id="org0342f2f"></a>
### 如何查看 pyim 文档。
@@ -625,14 +626,14 @@ pyim 的文档隐藏在 comment 中,如果用户喜欢阅读 html 格式的文
<http://tumashu.github.io/pyim/>
-<a id="orgd80df71"></a>
+<a id="orgf7a7e1a"></a>
### 将光标处的拼音或者五笔字符串转换为中文 (与 vimim 的 “点石成金” 功能类似)
(global-set-key (kbd "M-i") 'pyim-convert-string-at-point)
-<a id="org9b083fa"></a>
+<a id="org6368d16"></a>
### 如何使用其它字符翻页
@@ -640,7 +641,7 @@ pyim 的文档隐藏在 comment 中,如果用户喜欢阅读 html 格式的文
(define-key pyim-mode-map "," 'pyim-page-previous-page)
-<a id="org709d8a6"></a>
+<a id="org826dd31"></a>
### 如何用 ";" 来选择第二个候选词
@@ -650,7 +651,7 @@ pyim 的文档隐藏在 comment 中,如果用户喜欢阅读 html 格式的文
(pyim-page-select-word-by-number 2)))
-<a id="org96ab21d"></a>
+<a id="orgbf4f0b9"></a>
### 如何添加自定义拼音词库
@@ -695,7 +696,7 @@ pyim 默认没有携带任何拼音词库,用户可以使用下面几种方式
3. 编写语言: C语言
-<a id="orgc1e986a"></a>
+<a id="orgeb01fac"></a>
### 如何手动安装和管理词库
@@ -717,7 +718,7 @@ pyim 默认没有携带任何拼音词库,用户可以使用下面几种方式
3. 词库文件的编码必须为 utf-8-unix,否则会出现乱码。
-<a id="org00bc777"></a>
+<a id="org0fa8718"></a>
### Emacs 启动时加载 pyim 词库
@@ -725,7 +726,7 @@ pyim 默认没有携带任何拼音词库,用户可以使用下面几种方式
#'(lambda () (pyim-restart-1 t)))
-<a id="org4401c59"></a>
+<a id="org6b7fbf7"></a>
### 将汉字字符串转换为拼音字符串
@@ -736,7 +737,7 @@ pyim 默认没有携带任何拼音词库,用户可以使用下面几种方式
2. \`pyim-hanzi2pinyin-simple' (不考虑多音字)
-<a id="org345a5a0"></a>
+<a id="orgb60d5cb"></a>
### 中文分词
@@ -755,7 +756,7 @@ pyim 包含了一个简单的分词函数:\`pyim-cstring-split-to-list', 可
词库中不存在的中文词条。
-<a id="orgd5c17b2"></a>
+<a id="org6ff2843"></a>
### 获取光标处的中文词条
@@ -763,7 +764,7 @@ pyim 包含了一个简单的命令:\`pyim-cwords-at-point', 这个命令可
\`pyim-cstring-split-to-list'。
-<a id="org4360c5c"></a>
+<a id="org0c34af2"></a>
### 让 \`forward-word' 和 \`back-backward’ 在中文环境下正常工作
@@ -780,7 +781,7 @@ pyim 包含了一个简单的命令:\`pyim-cwords-at-point', 这个命令可
(global-set-key (kbd "M-b") 'pyim-backward-word)
-<a id="org1ec670b"></a>
+<a id="orgbcca805"></a>
### 为 isearch 相关命令添加拼音搜索支持
@@ -797,3 +798,11 @@ pyim 安装后,可以通过下面的设置开启拼音搜索功能:
(setq-default pyim-english-input-switch-functions
'(pyim-probe-isearch-mode))
+
+<a id="org6bc050b"></a>
+
+### 让 ivy 支持拼音搜索候选项功能
+
+ (setq ivy-re-builders-alist
+ '((t . pyim-ivy-cregexp)))
+