This is an HTML version of the jieba.vim help pages, current as of jieba.vim 383fa0f. They are kept up-to-date automatically from the jieba.vim source repository.

快捷链接: 中文文档 · 常见问题
jieba_vim.txt           基于 jieba 的 Vim 按词跳转插件

                Author:  Kaiwen Wu
               License:  Apache license v2 + Vim license
            Repository:  https://github.com/kkew3/jieba.vim

                                                          jieba.vim  jieba


==============================================================================
CONTENTS                                                      jieba-contents
  1. Introduction .............................................. jieba-intro
  2. Configuration ............................................ jieba-config
  3. Mappings ............................................... jieba-mappings
     3.1 Word motions ................................... jieba-word-motions
     3.2 Word text objects .............................. jieba-text-objects
     3.3 Insert special keys ............................. jieba-ins-special
     3.4 Command line ........................................ jieba-cmdline
     3.5 Word motion preview ................................. jieba-preview
  4. Commands ............................................... jieba-commands
  5. Functions ............................................. jieba-functions
  6. Global indicators ............................. jieba-global-indicators
  7. Optional dependency .............................. jieba-opt-dependency


==============================================================================
INTRODUCTION                                                     jieba-intro

jieba.vim 是一个基于 jieba 的中文分词插件,用于中文段落中光标按单词移动、
VISUAL 模式按单词扩张选区、按单词复制、删词、改词等操作。完整支持各模式下
word-motions 和基于单词的 text-objects 键位。同时尊重 'iskeyword' 设置,
并允许自定义用户词典,从而自定义分词边界。


                                                    jieba-word  jieba-WORD
与 Vim 相似,jieba-word 是由连续的 word 字符组成的序列,而 jieba-WORD 则
是由连续的非空白字符组成的序列。对于 ASCII 以及 Latin-1 字符,是否属于 word
字符由 'iskeyword' 决定;其它字符则根据其 Unicode 类别判断。这与 Vim 的行为
基本一致。例如,中文字符总是 word 字符。

对于包含中文字符的 word 字符序列,jieba.vim 会调用 jieba-rs
( https://github.com/messense/jieba-rs ) 进行分词,并在各分词之间插入虚拟
空白,使每个分词成为独立的 jieba-word。jieba-mappings 以这些 word 为
单位进行操作。这些虚拟空白用于在概念上分隔 jieba-word 和 jieba-WORD,不
实际存在于 Vim 缓冲区。此外,某些中文标点(例如逗号和句号)之后也会插入这种
虚拟空白,从而禁止 jieba-WORD 越过这些标点。


==============================================================================
CONFIGURATION                                                   jieba-config

                                                          g:jieba_vim_keymap
是/否 (1/0) 自动启用默认键位映射。

注意,本插件默认不映射任何按键,需要用户通过 jieba-mappings 自行绑定键位。
若希望快速启用默认键位(不包括跳转预览、实验性功能及参考实现),可启用此
设置。默认键位由 jieba_vim#default_keymap() 定义,因此也可以设置该选项
为 0, 同时手动通过 :autocmd 等方式调用 jieba_vim#default_keymap() 实现
相似功能。

默认: 0

                                                            g:jieba_vim_lazy
是/否 (1/0) 延迟加载 jieba 词典直到光标所在行有中文出现。

默认: 1

                                                       g:jieba_vim_user_dict
若为非空字符串,加载此文件路径所指向的用户自定义词典。
用户词典范例见 https://github.com/fxsjy/jieba/blob/master/test/userdict.txt。

默认: ""(空字符串,使用默认词典)

                                                  g:jieba_vim_preview_limits
用于设置 jieba-preview 的 {motion} 预览上界。若为正数 N,则预览该次数内的
{motion} 目标位置;若为 0, 则预览当前行的所有目标位置;否则,相当于 N 等于
99999。

默认: 0(预览当前行)

                                             g:jieba_vim_experimental_opfunc
是/否 (1/0) 启用对 g@ 的实验性支持。

若为 1, 则通过可视选择实现 g@ 的 omap,从而支持任意 'operatorfunc',其
代价为无法保证没有作用于可视模式的副作用,例如在一些情况下 `< 及 `> 会
被意外覆写。若为 0, 则通过操作符重放实现 g@ 的 omap,从而不引入任何
副作用,其代价为无法支持调用 getchar() 的 'operatorfunc'。

具体细节参见设计文档
https://github.com/kkew3/jieba.vim/blob/main/docs/design_choices/0003-omap-impl-tradeoff.md。

默认: 0


==============================================================================
MAPPINGS                                                      jieba-mappings

jieba.vim 映射总览如下(不包括 jieba-preview 映射):

Vim 模式           <Plug> 映射                
------------------------------------------------------------------------------
nxo                <Plug>(Jieba_w), <Plug>(Jieba_W)
nxo                <Plug>(Jieba_b), <Plug>(Jieba_B)
nxo                <Plug>(Jieba_e), <Plug>(Jieba_E)
nxo                <Plug>(Jieba_ge), <Plug>(Jieba_gE)
nxoi(*)            <Plug>(Jieba_C_Left), <Plug>(Jieba_S_Left)
nxoi(*)            <Plug>(Jieba_C_Right), <Plug>(Jieba_S_Right)
xo                 <Plug>(Jieba_iw), <Plug>(Jieba_iW)
xo                 <Plug>(Jieba_aw), <Plug>(Jieba_aW)
i                  <Plug>(Jieba_C_w)
c   (+)            <Plug>(Jieba_C_r_C_w), <Plug>(Jieba_C_r_C_a)

注:

(*): 箭头映射在插入模式下为实验性支持,不保证与 Vim 原生行为的完全兼容
     性。
(+): 命令行编辑功能为基于 jieba_vim#cword() 的参考实现,不保证与 Vim
     原生行为的完全兼容性。

                                                          jieba-word-motions
WORD MOTIONS

以下所有 word-motions 键位映射为对应 Vim 原生键位的中文增强版本,支持
[count],且 word 和 exclusive 语义与所对应的 Vim 原生键位相同。例如
WORD 版本的映射会跳过中文标点,而 word 版本则不会。

<Plug> 映射              对应的 Vim 原生键位  
------------------------------------------------------------------------------
<Plug>(Jieba_w)          w                           <Plug>(Jieba_w)
<Plug>(Jieba_S_Right)    <S-Right>                   <Plug>(Jieba_S_Right)
<Plug>(Jieba_W)          W                           <Plug>(Jieba_W)
<Plug>(Jieba_C_Right)    <C-Right>                   <Plug>(Jieba_C_Right)
<Plug>(Jieba_e)          e                           <Plug>(Jieba_e)
<Plug>(Jieba_E)          E                           <Plug>(Jieba_E)
<Plug>(Jieba_b)          b                           <Plug>(Jieba_b)
<Plug>(Jieba_S_Left)     <S-Left>                    <Plug>(Jieba_S_Left)
<Plug>(Jieba_B)          B                           <Plug>(Jieba_B)
<Plug>(Jieba_C_Left)     <C-Left>                    <Plug>(Jieba_C_Left)
<Plug>(Jieba_ge)         ge                          <Plug>(Jieba_ge)
<Plug>(Jieba_gE)         gE                          <Plug>(Jieba_gE)

键位映射示例: 

        nmap w <Plug>(Jieba_w)
        xmap w <Plug>(Jieba_w)
        omap w <Plug>(Jieba_w)
        " [remaining mappings ..]


                                                          jieba-text-objects
WORD TEXT OBJECTS

以下所有 text-objects 键位映射为对应 Vim 原生键位的中文增强版本,支持
[count],且 word 和 exclusive 语义与所对应的 Vim 原生键位相同。例如
WORD 版本的映射会包含中文标点,而 word 版本则不会。

<Plug> 映射              对应的 Vim 原生键位  
------------------------------------------------------------------------------
<Plug>(Jieba_iw)         iw                          <Plug>(Jieba_iw)
<Plug>(Jieba_iW)         iW                          <Plug>(Jieba_iW)
<Plug>(Jieba_aw)         aw                          <Plug>(Jieba_aw)
<Plug>(Jieba_aW)         aW                          <Plug>(Jieba_aW)

键位映射示例: 

        xmap iw <Plug>(Jieba_iw)
        omap iw <Plug>(Jieba_iw)
        " [remaining mappings ..]

注意 text-objects 按定义不存在 nmap 映射。

                                                           jieba-ins-special
INSERT SPECIAL KEYS

以下所有 INSERT 模式特殊键位映射为对应 Vim 原生键位的中文增强版本。

<Plug> 映射              对应的 Vim 原生键位  
------------------------------------------------------------------------------
<Plug>(Jieba_C_w)        i_CTRL-W                    <Plug>(Jieba_C_w)


实验性键位单独在下面列出,不保证与 Vim 原生行为的完全兼容性。

<Plug> 映射              对应的 Vim 原生键位  
------------------------------------------------------------------------------
<Plug>(Jieba_S_Left)     i_<S-Left>                  <Plug>(Jieba_S_Left)
<Plug>(Jieba_C_Left)     i_<C-Left>                  <Plug>(Jieba_C_Left)
<Plug>(Jieba_S_Right)    i_<S-Right>                 <Plug>(Jieba_S_Right)
<Plug>(Jieba_C_Right)    i_<C-Right>                 <Plug>(Jieba_C_Right)

键位映射示例: 

        imap <C-w> <Plug>(Jieba_C_w)
        " [remaining mappings ..]


COMMAND LINE                                                   jieba-cmdline

以下所有命令行键位为对应 Vim 原生键位的中文增强版本。目前为参考实现,不保证与
Vim 原生行为的完全兼容性。

<Plug> 映射              对应的 Vim 原生键位  
------------------------------------------------------------------------------
<Plug>(Jieba_C_r_C_w)    c_<C-r>_<C-w>               <Plug>(Jieba_C_r_C_w)
<Plug>(Jieba_C_r_C_a)    c_<C-r>_<C-a>               <Plug>(Jieba_C_r_C_a)

键位映射示例: 

        cmap <C-r><C-w> <Plug>(Jieba_C_r_C_w)
        cmap <C-r><C-a> <Plug>(Jieba_C_r_C_a)


                                                               jieba-preview
WORD MOTION PREVIEW

可使用如下键位映射在 Normal 模式下提前高亮 jieba-word-motions 的跳转位置。

<Plug> 映射                  预览的 jieba_vim 键位  
------------------------------------------------------------------------------
<Plug>(Jieba_preview_cancel) 取消预览         <Plug>(Jieba_preview_cancel)
<Plug>(Jieba_preview_w)      <Plug>(Jieba_w)  <Plug>(Jieba_preview_w)
<Plug>(Jieba_preview_W)      <Plug>(Jieba_W)  <Plug>(Jieba_preview_W)
<Plug>(Jieba_preview_e)      <Plug>(Jieba_e)  <Plug>(Jieba_preview_e)
<Plug>(Jieba_preview_E)      <Plug>(Jieba_E)  <Plug>(Jieba_preview_E)
<Plug>(Jieba_preview_b)      <Plug>(Jieba_b)  <Plug>(Jieba_preview_b)
<Plug>(Jieba_preview_B)      <Plug>(Jieba_B)  <Plug>(Jieba_preview_B)
<Plug>(Jieba_preview_ge)     <Plug>(Jieba_ge) <Plug>(Jieba_preview_ge)
<Plug>(Jieba_preview_gE)     <Plug>(Jieba_gE) <Plug>(Jieba_preview_gE)

键位映射示例: 

        nmap <Leader>jw <Plug>(Jieba_preview_w)
        " [remaining mappings ..]



==============================================================================
COMMANDS                                                      jieba-commands

                                                         :JiebaPreviewCancel
:JiebaPreviewCancel        功能同 <Plug>(Jieba_preview_cancel)。


==============================================================================
FUNCTIONS                                                    jieba-functions

jieba_vim#install()                                      jieba_vim#install()
                           用于安装 jieba.vim。常作为 post-update hook 使用;
                           如果 post-update hook 自动运行失败,也可手动调用。


jieba_vim#default_keymap()                        jieba_vim#default_keymap()
                           用于启用默认键位。常通过设置 g:jieba_vim_keymap
                           为 1 自动运行,也可手动调用。


jieba_vim#cword([expr])                                    jieba_vim#cword()
                           返回当前光标下的 jieba-word;如果传入 0,则返回
                           当前光标下的 jieba-WORD。如果当前光标下不存在
                           jieba-WORD,返回空字符串。作用相当于 Vim 中的
                           expand("<cword>") 或 expand("<cWORD>")。


jieba_vim#ctoken([expr])                                  jieba_vim#ctoken()
                           返回当前光标下的 token;如果传入 0,则返回以 WORD
                           分词时当前光标下的 token。如果当前光标位于空行或
                           一行中最后一个字符之后(见 'virtualedit'),返回空
                           字符串。和 jieba_vim#cword() 的区别是,如果光标
                           处于非 word 字符上,cword() 会返回光标后的第一个
                           jieba-word,而 ctoken() 会返回光标下的 token,
                           无论其是否为 word。

==============================================================================
GLOBAL INDICATORS                                    jieba-global-indicators

                                                   g:jieba_vim_loaded_cdylib
若为 1,说明 jieba.vim 的 C 链接库加载成功。否则,调用 jieba_vim#install()
以下载或本地编译链接库。

                                              g:jieba_vim_loaded_word_motion
若为 1,说明 jieba.vim 的后端加载成功。否则,需要检查用户配置。例如,无效的
用户词典路径(见 g:jieba_vim_user_dict)常导致后端加载失败。

                                                     g:jieba_vim_build_error
若该变量存在,说明上一次 jieba_vim#install() 运行失败,且该变量包含了安装
脚本的标准输出(stdout);是否包含错误输出(stderr)取决于运行时 'shellredir'
的值,例如 Unix 系统下 'shell' 为 "bash" 或 "zsh" 时默认包含错误输出。


==============================================================================
OPTIONAL DEPENDENCY                                     jieba-opt-dependency

如果用户安装了 tpope/vim-repeat ( https://github.com/tpope/vim-repeat ),可
使用 . 重复上一次修改。例如 dw. 相当于 dwdw。


vim:tw=78:ts=8:ft=help:et:norl:


快捷链接: 中文文档 · 常见问题