如何编写一个类似gvim-help-doc的文本文件？

Question

GVIM帮助文档中包含“链接”，我可以跳到通过按Ctrl +主题] 如何格式化，可以像

Answer 1

有在帮助专用于该主题的一个部分：“写作帮助文件”

见: help help-writing或:help helphelp.txt

摘录：

TAGS 


To define a help tag, place the name between asterisks (*tag-name*). 

(...) 

When referring to an existing help tag and to create a hot-link, place the 
name between two bars (|) eg. |help-writing|. 

如需更多信息，请阅读前面提到的帮助文件。

Answer 2

Vim的帮助文件运行文本中存在在$ VIMRUNTIME/doc的，所以如果你查看这些文件并设置

set syntax=off 

这会给你一个标记的想法。基本上，你在管道括起来创建链接：

go to a link |here| 

将跳转到双星号链接文字的出现，即*here*。

然后你只需要为您的文件，您可以用自动命令实现做

set filetype=help 

。

Answer 3

它需要运行命令：

:helpt[ags] {dir} 

创建文件后，生成新的标签。详情可查询：

:help helpt