Keys in Vim

The Vim plugin binds the same keys as the Neovim plugin: when the server starts, it announces its commands with their default keys (org-lsp manifest prints them), and the plugin binds those of the vim preset, which are nvim-orgmode's defaults. Keys for Org files, the agenda, the date prompt's calendar, column view and capture buffers are local to those buffers; the keys listed under Anywhere are global.

g? in an Org file or the agenda shows the keys set there, yours included, in a popup. vim.org says how to install and set up the plugin.

The keys#

Anywhere#

In Org files#

In a capture buffer#

In the agenda#

¦ stands for |, which an Org table cannot hold.

In the date prompt#

In column view#

Without a default key#

¹ Where the command does not apply, the key does what it does in any buffer: <C-a> off a timestamp still increments the number under the cursor, <S-Right> off a timestamp goes a word right (and on a headline or an item too, as org_support_shift_select says), and <CR> in a source block's code is Vim's own.

The plugin's own keys#

The plugin adds keys of its own, which only an editor can carry out:

A capture buffer is an Org file, so it has the keys of Org files as well as its own.

How they behave#

As in Neovim: counts work (3<C-a>), . repeats the last change, the keys of the commands Org gives a region work on a Visual selection, and the keys marked ¹ give back their own meaning where the command does not apply. A date is picked in Org's calendar, at the bottom, or typed there with i, as at Org's prompt (fri 10:00, +2d). With coc.nvim, which passes on only an error's message, a key marked ¹ falls back to its own meaning whenever the server refuses.

In a terminal, Vim reads a key with a modifier only as the terminal sends it. <C-Space> comes as NUL, which the plugin binds too (<C-@>), and Alt with a character (<M-m>) as <Esc> then the character in tmux and most terminals, which it binds too (<Esc>m). Alt with an arrow comes as Vim reads it in xterm and tmux. <S-CR> and the other keys with <M-…> or <C-S-…> need a terminal that reports modifiers, as xterm does once Vim turns its modifyOtherKeys on; in tmux, GNU screen or the Linux console Shift-Enter arrives as <CR>. There, bind the command to a key that arrives, with mappings (below) or :Org return item:

let g:org_lsp = {'mappings': {'org': {'org.return.item': ['<S-CR>', '<C-j>']}}}

Changing them#

Keys are set with mappings in g:org_lsp, before the plugin loads. It has one dictionary per scope: global, org, agenda, capture, calendar and columns. In a scope, a command (the second column above, or one of the plugin's own names) maps to:

• a key, which takes the place of the command's default keys;
• a list of keys, to have more than one;
• 0, to leave the command without a key.

Commands that are not listed keep their default keys.

let g:org_lsp = {
      \ 'mappings': {
      \   'global': {'org.agenda.dispatch': '<Leader>a'},
      \   'org': {'org.todo': ['cit', '<Leader>ot'], 'org.todo.next': '<C-n>', 'org.todo.previous': 0},
      \   'agenda': {'quit': ['q', '<Esc>']},
      \ },
      \ }

0 for a scope sets no keys there, the plugin's own included; 0 for mappings sets none at all:

let g:org_lsp = {'mappings': {'org': 0}}   " nothing in Org files
let g:org_lsp = {'mappings': 0}            " nothing anywhere

From the command line#

:Org runs a command by its name without the org. prefix, with completion: :Org todo.next, :Org agenda todos, and a group on its own runs its dispatcher: :Org agenda.