Saturday, January 9, 2010

vim plugins: help document generator

Hi,

I don't know how other plugin developers generate/create their plugin
documentation. I personally use a ruby script that extracts the
documentation from the source files.

The script is little more that a convoluted hack (the source code is
ugly) but it has proved useful for me. As I thought that other people
might find it useful too, I have included now the script in my
vimtlib
repository:
http://github.com/tomtom/vimtlib/blob/master/ruby/vimdedoc.rb

A very rudimentary documentation can be found here:
http://github.com/tomtom/vimtlib/blob/master/ruby/vimdedoc.txt

A generated help file looks like this:
http://github.com/tomtom/vimtlib/blob/master/doc/tplugin.txt
(The generated part starts with the table of contents.)

Regards,
Tom

No comments: