workflow - chimay/wheel GitHub Wiki

<!-- vim: set filetype=markdown: -->

Interfaces

Wheel has four main interfaces :

Mappings

To avoid conflict with your personal bindings, wheel mappings until level 2 included are all using a generic prefix. The first step is to choose a prefix you are comfortable with. Here are some ideas you could use :

" default
let g:wheel_config.prefix = '<M-w>'

" works on nvim-qt, not on gvim or in terminal
let g:wheel_config.prefix = '<D-w>'

" great if you don't use space as map leader
let g:wheel_config.prefix = '<Space>'

 " if you don't use backslash as map leader
 let g:wheel_config.prefix = '\'

This is fine, but can quickly become tedious for often used functions. In that case, prefix-less shortcuts are welcome.

A whole set of these shortcuts is defined in level 10. There is a lot of them, so they would most likely interfere with your config. However, they can be used to choose functions you're interested in, or as a source of inspiration.

So, two solutions :

  • you're happy with all of them : you can set g:wheel_config.mappings to 10
  • you set g:wheel_config.mappings to 2 or less, and cherrypick in level 10

Define your own maps

Two possibilities here, either you use the plugs, like this :

nmap <silent> <M-m> <Plug>(wheel-menu-main)

or the meta-command :

nnoremap <silent> <M-m> :Wheel dedibuf menu-main<cr>

See also define your own maps.

If you're looking for a specific Wheel function, see the plugs exhaustive list.

Auto read & write

You probably want to make your files groups persistent. For that, you need to enable auto read & write :

let g:wheel_config.autoread = 1
let g:wheel_config.autowrite = 1
augroup wheel
	autocmd!
	autocmd VimEnter * call wheel#void#init()
	autocmd VimLeave * call wheel#void#exit()
augroup END

Don't worry about the size : I have 450+ files in my groups, and it is still fluid, thanks to on-demand file loading.

Generally speaking, this plugin is designed to let the user control the flow. If you want to automate more, take a look at the wheel autocommands.

⚠️ **GitHub.com Fallback** ⚠️