如何在vim加入一个插件的帮助文件并关联上

如何在vim加入一个插件的帮助文件并关联上?

例如,有一个插件visual mark,其本身并没有帮助文件,我自己按网络提示编写了一个visualmark.txt文件,将其加入到~/.vim/doc中,但在vim中按help visualmark.txt却没任何显示。如何使其关联上。

在 vim 里面用 :helptags ~/.vim/doc (或者进入~/.vim/doc目录,在Vim下运行"helptags ."命令),此步骤是将doc下的帮助文档加入到Vim的帮助主题中,这样我们就可以通过在Vim中运行“help 关键词”查看插件的帮助。
不过,这需要你的 visualmark.txt 文件符合 vim 帮助的格式,vim 就会生成类似链接一样的效果,你就可以直接 :help 相关的链接来查看其帮助了。

追问
那请问帮助文档需要什么样的特殊格式呢?

追答
vim 的帮助文件里面用 *testing* 的方式来定义一个叫 testing 的标签,用 |testing| 来引用一个标签(类似网页链接),包含这样内容的文件,放到 ~/.vim/doc 目录下,然后运行了 :helptags ~/.vim/doc 之后,你就可以用 :help testing 来访问 *testing* 定义的位置了,而如果看帮助的时候光标在 |testing| 上,就可以用 Ctrl-] 来跳转到 *testing* 定义的位置。

posted @ 2020-02-16 20:35  汉学  阅读(316)  评论(0)    收藏  举报