Is it possible for wiki-link-types to support jumping to Vim help?

[VimWei]

The Vim ecosystem is vast, and I often need to consult the Vim help documentation for various topics. I've made quite a few wiki notes, and while I can search for the keywords mentioned in these notes using :h subject, it always feels like it would be much more convenient if the wiki-link-types supported a format like |vim help subject| or something similar. With this feature, recognizing and using wiki links with a simple press of the Enter key would enable direct jumping to the help content.

PS: I have configured the Vim help document type to be accessed in a way that mimics the wiki approach.

" Jump
nnoremap <buffer> <CR> <C-]>
nnoremap <buffer> <BS> <C-T>

" Lookup |label| using <Tab>/<S-Tab>
nnoremap <buffer> <Tab> /<Bar>\zs\k*\ze<Bar><CR>:noh<CR>
nnoremap <buffer> <S-Tab> ?<Bar>\zs\k*\ze<Bar><CR>:noh<CR>

[lervag]

You can use the vimdoc scheme, e.g. vimdoc:user-manual.

I notice that I've added support for a few things, such as this, that I forgot to document. I'll keep this issue open until I've documented it.

[VimWei]

I have experienced the vimdoc scheme, and it's great!

However, it seems that it can only be opened with <cr> and does not support the following methods:

  `n`     <c-w><cr>           |<plug>(wiki-link-follow-split)|
  `n`     <c-w><tab>          |<plug>(wiki-link-follow-vsplit)|
  `n`     <c-w>u              |<plug>(wiki-link-follow-tab)|
  `n`     <bs>                |<plug>(wiki-link-return)|

[lervag]

<plug>(wiki-link-return) will not work here, because we end up in a non-wiki file. But the other mappings should work. Are you sure they don't work?

[lervag]

Can confirm that the other wiki-link-follow-... does not work as expected. I'll look into it.

[lervag]

I think the follow maps should work now, please update.

[VimWei]

After updating, the following key mappings now work! Thank you!

  `n`     <c-w><cr>           |<plug>(wiki-link-follow-split)|
  `n`     <c-w><tab>          |<plug>(wiki-link-follow-vsplit)|
  `n`     <c-w>u              |<plug>(wiki-link-follow-tab)|

[lervag]

No problem; glad to hear it works.