tags:

views:

27

answers:

1

Is there a complete source of documentation on the markup format used in vim help files? :help write-local-help provides some info but does not, for example, document the markup used to indicate quoted sections.

update: I've also discovered this post on the vim-use mailing list which provides slightly more info than the afore-mentioned help entry.

+1  A: 

Hello!

:e $VIMRUNTIME/syntax/help.vim

This will indicate you how vim colours its own help files.

:help write-local-help

will also show you an example.

Benoit
I'm hoping to find a reference similar to the one you (and I) mentioned, but more thorough. The help syntax file is certainly thorough, but reading a set of regular expressions is not generally the best way to learn how to write markup. Also, if there *is* an authoritative reference, the syntax colouring code may change in future vim versions in ways that still honour that reference.
intuited