Monday, June 14, 2010

Plugins - Accepted practices mapping conflicts

What are some good guidelines to follow when trying to
map keys in a plugin?

Currently I have the following setup in my plugin:

I define a "g:GrailsVimMapleader" which defaults to
<leader>g

Currently, all my plugin's commands are mapped to
g:GrailsVimMapLeader + another character. This should
help avoid conflicts, unless of course the user has <leader>g
mapped already.

If the user wants to use a different set of leader keys,
the user can change g:GrailsVimMapLeader (for example, to
<leader><F3> or something.)

However, I realize there's still a chance that key mapping conflicts
can occur.

I would like to warn the user about key mapping conflicts, but I don't
want the warning to be annoying or ever-present until the user fixes it.

I know about the :map <unique> and maparg() function. Can
anyone give me suggestions for how to gracefully handle keymapping conflicts?

Thanks,
--Nate

--
You received this message from the "vim_use" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php

No comments: