Being repeatedly asked to write a set of vim syntax rules or mappings to help doc writers, I now have a file that contains a decent amount of useful stuff.
As this may be helpful to others out there, I decided to make it public.
Here is a list of the features that this script provides:
Syntax improvments:
- Highlight PHP code in examples
- Define folding rules for <refsect1>
Mappings:
- @fd : Function definition section
- @fpm : Function parameter normal
- @frpm : Function parameter by reference
- @fopm : Function optional parameter
- @forpm : Function optional parameter by reference
- @pms : Parameters section
- @vle : Variable list entry
- @ret : Return values section
- @err : Errors section
- @uni : Unicode sections
- @chlog : Changelog section
- @ex : Single example
- @rex : Example section
Some of those bindings use placeholders (<++>). Usually, Ctrl+j is used to jump through them.
I will probably continue adding new stuff in that script when I feel the need to.
Here is the script.
References:
Doc Skeletons
RSS (general)
Accurev scm has a Vim plug-in now. Not supported, but developed by one of its employees who seems to be a Vim expert. Maybe you could discuss it here?
http://blog.accurev.com/2008/01/31/vim-plugin-for-accurev-10-release/