如何编写类似gvim-help-doc的文本文件?

时间:2011-04-07 04:44:12

标签: vim

gvim帮助doc包含“链接”,我可以通过按ctrl +跳转到主题 如何格式化可以像

那样运作的文本

3 个答案:

答案 0 :(得分:8)

专题讨论中有一节专门介绍该主题:“编写帮助文件”

请参阅: 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|.

要了解更多详情,请阅读前面提到的帮助文件。

答案 1 :(得分:4)

Vim的帮助文件存在于$ VIMRUNTIME / doc中,因此如果您查看这些文件并设置

set syntax=off

这会让你了解加价。基本上,您通过将它们封闭在管道中来创建链接:

go to a link |here|

将跳转到以星号括起来的链接文本,即*here*

然后你只需要做

set filetype=help

用于您的文件,您可以使用自动命令实现。

答案 2 :(得分:1)

需要运行命令:

:helpt[ags] {dir}

在创建文件后生成新标签。细节可以找到:

:help helpt