像用户手册一样创建vim标签

时间:2014-03-02 12:46:26

标签: vim

我想以类似于vim用户手册的方式在.txt文件之间制作标签。

我已经知道如何生成标签文件,我可以在我的文件之间进行链接。我唯一想弄清楚的是如何使我的所有标签都有不同的颜色(如用户手册中的蓝色),因此它们很容易识别。

我最好的猜测是我必须为txt文件自定义语法高亮,但我不确定如何区分标签和普通文本。

2 个答案:

答案 0 :(得分:2)

提取标签及其链接是一回事;你好像已经解决了这个问题。

要识别并突出显示标记,您需要语法规则。如果您的代码样式遵循Vim帮助,则代码定义会被*个字符包围,标记链接会被|个字符包围。

$VIMRUNTIME/syntax/help.vim的以下摘录涵盖了这一点:

syn match helpHyperTextJump "\\\@<!|[#-)!+-~]\+|" contains=helpBar
syn match helpHyperTextEntry    "\*[#-)!+-~]\+\*\s"he=e-1 contains=helpStar
syn match helpHyperTextEntry    "\*[#-)!+-~]\+\*$" contains=helpStar

hi def link helpHyperTextJump   Subtitle
hi def link helpHyperTextEntry  String

如果你把(help...替换为txt...)最佳地放入自定义~/.vim/syntax/txt.vim语法脚本中,你可以使用:setf txt激活语法(甚至自动化通过自定义文件类型检测)。

答案 1 :(得分:0)

手册中的标签可通过:help命令获得。您可能无法将文本文件与Vim文档混合使用。

如果您打算仅在文本文件之间创建链接,可以尝试使用一些插件来实现此目的;我建议the vimwiki plugin - 它包括几个用于创建/管理文本文件的链接,列表和标题的映射,这些映射通过其中包含的语法文件正确突出显示。

有些替代方案为listed on vim.orgutl.vim : Univeral Text LinkingTxtfmt (The Vim Highlighter)TxtBrowser : Browse plain text easily