Vim独立插件vimio的全面介绍

这是什么插件？

插件主页：https://github.com/qindapao/vimio

先看两个小动图直观感受下。

demo 1:

demo 2:

简单来说，这是一个使用vim来绘制文本流程图或者架构图的插件。以前也出现过类似的东西，比如：DrawIt sketch ，但是它们的功能都比较简单。绘制起来也不是那么方便。

受到 Nadim Khemir 开发的全功能的文本图绘制软件 asciio 的启发。我开发了简单的 vimio，以方便 vim 用户可以直接通过 vim 在源码中或者是架构文档中直接绘制文本流程图或者架构图。

关于更加强大的 asciio 软件，我会在后面的博文中单独介绍，这里只介绍下它是一个使用 Perl5 语法开发的，基于绘图对象管理的，支持图形对象分组，各种自动链接路由的强大软件。并且可以方便的导出到纯 TXT 文本。

vimio 继承了一部分它的思想，但是本质上这是两个不同的软件。vimio 更加简单，因为没有对象的概念，你使用它和编辑代码编写文档没有区别，画出来是什么就是什么。因为它是基于文本的，所以它的智能化程度和 asciio 比差了很多。所以 vimio 的定位是绘制简单的即时架构图。如果你的文本架构图或者流程图相当复杂，为了节约你的时间，强烈建议你直接使用 asciio ！它绝对是你的终极选择，没有之一！

虽然这个插件的说明文档写得相当详细。但是那是纯文本的说明。对于第一次使用的朋友来说可能不够友好，所以我还是在博客中图文并茂的重新介绍下吧！

插件安装完成后，在 vim 的命令行直接: :h vimio 即可。

所有的操作总表

这里先给个操作的总表，当前不用去理解这些操作是什么意思，因为后面会详细解释。放个总表的目的是后面熟悉了后可以直接在这个操作总表来找对应的操作。

注：下面的大部分的映射都是有英文含义的，比如 sm -> smart s -> start 合并后是 sms 表示 智能线开始绘制。

• 绘图前的准备

• 绘制

• 橡皮擦

• 拷贝、剪切和粘贴

• 智能预览

• 模板操作

• 手动操作高亮图形字符标定(图形管理)

• 基于文本图形算法的高亮图形字符标定(图形管理)

• 鼠标的快捷操作

见下面的 <<鼠标快捷操作>> 章节。

绘图前的准备

在绘制文本图以前，我们首先要把vim变成一个画布，而不是普通的编辑模式，在画布的状态下，直接输入一个字符不会顶掉后面的字符的位置。

相关的操作可以看下面这个小的 gif 演示：

上面的视频中漏掉了 Ctrl + Shift + J/K/L/H 的操作，这个非常有用，如果你要输入不同位置的字符，这个让你不用频繁的进入和退出全局替换模式。

绘制

这里是基本的绘制功能，可以画线，也可以画框，还可以根据线的方向自动绘制箭头，还有可能根据起点和终点自动路由的智能线。

由于这部分内容有点多，所以分几个部分来说明。

基本的线条和框绘制以及样式控制

快速画线还有一个十分实用的小技巧，sw 不仅仅是可以画框，其实也可以快速画线的，这样我们就不要慢慢去画。在横向或者纵向的范围内，我们指定起点和终点就可以快速画线，下面的小 gif 说明下这一点。

这个功能在制作表格的时候非常方便！

智能线相关的操作

智能线的意思是我们指定开始和结束的位置，然后线条会自动路由，不用我们人为的指定路径。这样绘制的时候更加灵活。同样用一个范例视频来说明下。

smr 的操作涉及到高亮选择的问题，这个会在后面单独说明。然后从视频中也可以看到，如果要绘制连续多段的智能线，只需要在上一条线结尾的地方，继续按 sms 即可，然后上一条线自动绘制到画布中。

这里的控制交叉模式只是控制视觉效果，不影响最后生成的结果。

盒子元素快速绘制和相关操作

有时候我们可能需要执行很多重复的操作，s. 主要是方便快速执行一次 a寄存器 中的内容。

关于矩形盒子的操作，也用一个视频来说明下：

对于上面的视频，有个特殊需要说明的地方。

sst 的操作前，你需要先确认你的当前的线形选择，sls 用于显示当前的线形。slc 用于切换当前的线形，当切换到你的目标线形后，把光标放到矩形框的边框上，然后按 sst 就可以改变当前这个矩形框为你想要的线形。

橡皮擦

这里先介绍下基本的橡皮擦，后面还有基于高亮的高级橡皮擦（可以批量删除不规则区域的字符，并且不要求连续）。

视频范例：

上面的视频中，块全局替换模式下，要求输入的时候输入一个空格，就是删除，如果要替换成别的字符，输入相应的字符即可。

拷贝、剪切和粘贴

这里的也是先介绍基本的选择操作，后面介绍了高级的高亮选择后，我们可以拷贝、剪切和粘贴不规则的图形，不要求连续，这里先不讲，先讲最基本的操作。

视频范例：

Ctrl + Shift + Right/Left/Up/Down 的操作除了绘制一个字符以外，还有连续绘制剪切板中的字符的功能。比如你想纵向输出文字，就可以先横向输入文字，然后选择块选择到剪切板中，然后采用这种方法纵向输出。

这里的操作我就不细讲了，如果有什么不同的，欢迎大家在留言板中问我，我再来解释。

智能预览

要知道当前剪切板中的内容和图形的位置信息，打开预览窗口即可。

还是先个一个视频来直观感受下，然后我们再慢慢解释。

• 特别说明下，st 的效果是切换预览窗口的透明和遮罩
  • 透明 - 那么剪切板中的图形中的空格会被忽略，底图中对应的字符会保留。
  • 遮罩 - 那么底图中的所有字符都会被剪切板中的矩形图形覆盖

插入模板图形

模板是可以自定义的，关于自定义的方法可以参考帮助文档(vimio.txt)中的相关部分自己开发。这里讲下预设的模板操作。

还是看个视频直观感受下先。

在模板的搜索中，对于搜到的内容，按 n 切换到下一个匹配，按 Shift + N 切换到上一个匹配。在匹配中切换2层小类就和普通情况一样。

选择模板小类，对于枚举类的模板(没有图形大小概率的)，还有一种通过数字来选择对应的图形的功能。

进入预览界面后：

• 按 1xx 就是选择第一级的图形，其中 xx 就是这个第一级图形的数字编号。
• 按 2xx 就是选择第一级的图形对应的第二级的子图形，xx 同样是这个子图形的数字编号。

还是举个视频范例来说明下：

在上面的视频中。我们首先通过 Alt + t 打开模板预览面板，然后通过 113 切换到方块符号大类，然后在这个大类中通过 226 定位到我们的2类方块字符，然后通过 Ctrl + Shift + Space 插入面板。

高亮字符标定

一旦把我们想要的图形字符全部高亮，然后我们就可以独立对它们进行拷贝或者剪切的操作，而不会误操作到它们旁边的字符，实现精确操作。

手动的高亮标定

大部分的情况下，我们通过人为来操作，不会出现误操作，可以精确选取我们想操作的图形字符。

手动高亮一个字符

高亮一个字符然后光标往相应的方向移动

自由高亮和自由取消高亮模式相关操作

处于这种模式下，光标自由移动的时候，对路径中所有的字符进行高亮或者取消高亮的动作，直到按 sd 结束自由模式。

清除屏幕上的所有高亮

这主要是为了一些误操作的清理环境。相当于完全丢弃本轮的所有的高亮操作。

高亮字符的拷贝、剪切和粘贴

基于算法的自动标定

这一块比较绕，并且内容有点多，如果有人感兴趣我再细讲吧。也可以直接参考 vimio.txt 文档中的内容来详细了解。

邻居算法算法

未完待续。

线选择算法算法

未完待续。

最大环最小环选择

未完待续。

未完待续

关于字符交叉效果的专门说明

本插件最大的特色就是可以自动处理框线字符相交的时候的交叉字符替换。无论是直接画线还是画框，都可以自动处理。这里整理几个和交叉相关的操作。

直接绘制的线条默认只支持交叉

如果不想要交叉效果，那么在交叉点的时候不要绘制即可！所有主动权还是完全在用户手里。

注意下，如果不想出现交叉字符，必须要从两个方向逼近，不然还是会出现交叉字符。如果觉得麻烦，其实直接用智能线就行了，如果只想绘制线条不要要箭头，在智能线中关闭首尾的箭头即可，上面都有详细的解释的。

智能线绘制过程中的交叉控制

smx 控制智能线交叉的打开和关闭。

图形的拷贝、剪切和粘贴过程中的交叉控制

切换交叉主题

主题是可以自定义的，具体参考插件的详细说明，这里简单演示下。

sxi 用于显示当前的交叉和其它的样式信息。

从上面看到，我们用 sxs 切换到某个主题，本来应该出现 + 的位置现在变成了 )，在某些电路图的绘制中这可能更加自然。

交叉算法

大部分情况下不需要关注和设置，如果感兴趣，可以直接看：vimio.txt 中的详细说明。

特殊字体下的8向交叉

正常情况下，我们的交叉只处理纵向和横向，如果要处理对角线的交叉，那么需要用到特殊的字体 vimiomono，这个字体当前还不够平滑，我还在打磨中，可以先看下效果。

上面的演示动画中

• 左边的图形是使用正常的字体绘制，可以看到斜向相交的时候交叉点处的字符是不会自动改变的。
• 右边的图形是切换到 vimiomono 字体后绘制的，复杂的对角线相交都支持。

目前字体的优化还不是那么好，所以效果看起来不是很完美。

智能拷贝

当交叉模式打开的时候，我们如果拷贝一条已经穿透的线段，最终拷贝出来的图形会自动去掉多余的交叉字符，补齐为平滑的字符。这么说有点抽象，直接用一个小动图说明下：

辅助定位线

任何时候，要操作剪切板中的图形，我们想对齐别的图形，就可以打开辅助定位线。

通过辅助定位线，我们可以横向或者纵向，或者同时对齐横向和纵向的其它图形。

如果移动过程中比较缓慢，可以先移动到临近的位置再用 Ctrl + j/k/h/l 打开预览。

CJK 支持

如果字体支持中文对齐（中文字符宽度严格等于英文字符宽度的2倍），其实也可以支持中文，但是一般情况下不建议在图表中使用中文，不便于国际化。

还是举个例子吧。

鼠标快捷操作

画框使用鼠标是最快的方式，使用鼠标进行可视块选择，然后按 sw。

在当前的配置下，使用键盘进入可视模式可能没有鼠标快速。可以利用鼠标进入可视模式进行快速的高亮和选择。

还有更加高级的用法，si 启动自动高亮后，可以直接使用鼠标左键点击需要选择的字符。这样选择自己需要的字符就会非常快速了。

在上面的操作中，如果你发现自己选择错了某些字符，随时可以使用 sj 进行高亮取消。然后继续切换 si 进行高亮选择。

在 so 打开自由预览的基础上，鼠标移动到的位置可以自由显示图形预览，然后按 Ctrl + 鼠标左键 就可以快速插入图形，和 Ctrl + Shift + Space 的效果完全一样，但是更加快速。要进行其它的操作，需要先用 sq 退出自由预览模式。

结语

谢谢，插件使用过程中的任何问题欢迎留言，直接在这里评论或者去 https://github.com/qindapao/vimio 的 issue 中留言皆可。