Remember the documentation

Vim has a very comprehensive help system with help for nearly any aspect of using Vim. But what happens when a user installs your script and wants to find "help" about it? If you haven't added documentation with your script installation, then the user will be out of luck and find no help in the help system. But why not follow the good concept that Vim has started about documenting everything? In other words: "Please include documentation when you release a script for Vim."

So let's take a look at how to create Vim documentation so that it has links, markers, tags, and so on, just like the real Vim documentation.

A Vim documentation document is just a plain text file with some special markup. When you create a new document, ...

Get Hacking Vim 7.2 now with O’Reilly online learning.

O’Reilly members experience live online training, plus books, videos, and digital content from 200+ publishers.