29 votes

Generating help tags for packages that are loaded by Vim 8's package management

Using :helptags ALL should re-generate all helptags for all doc directories in runtimepath; which should include the ~/.vim/pack/default/start/* directories. You will probably get an error similar to:...
Martin Tournoij's user avatar
14 votes

How to "full screen" browse Vim help?

You can move the help screen to its own tab with ctrl+w T (note the T is upper case). Then you can switch between the tabs with gt.
wisbucky's user avatar
  • 940
14 votes
Accepted

What does `idem` mean in the VIM docs?

It's a latin term meaning "the same". In the quoted context, it just means the listed command does the same thing as the previously listed command, i.e. remove item 3: :let i = remove(list, 3) " ...
Rich's user avatar
  • 31.7k
10 votes
Accepted

Plugin help files not found

you have to create the help-tags. Run :helptags for the dir where you installed the docs. On unix this would most likely be :helptags ~/.vim/doc. Or simply recreate them all with :helptags ALL
Naumann's user avatar
  • 2,759
10 votes

On string concatenation, what's the difference between . and .. (single dot and double dot)?

The . and .. have semantically the same meaning of string concatenation. However, the . can also be used to access dictionary items and can as well be used for floating point numbers. So the meaning ...
Christian Brabandt's user avatar
9 votes

Prevent vim closing the editor when the last window/splits are help pages

using the command :clo[se] instead of :q seems to have solved the problem for me. I.e. if I issue :clo with the above window layout, it causes vim to throw E444: Cannot close last window. In ...
the_velour_fog's user avatar
9 votes
Accepted

Jump to next identifier in Vim help files

In the help files the identifiers are actually marked as |identifier| (but you don't see the | because of the syntax file, use set ft=txt in an help buffer to check what I'm talking about). You could ...
statox's user avatar
  • 49.6k
9 votes
Accepted

How to Interpret Syntax in VIM Help Pages

The basic help syntax being used is (of course) being explained in the help system itself. You can find it (in the not so easy discoverable) help tag :h notation. Copying it here for reference: 4. ...
Christian Brabandt's user avatar
8 votes
Accepted

What does "tag" mean in the context of Vim's help window?

The tag is useful for two things: When using the :help command, the tag is the exact phrase which will let you distinguish between similar terms. {...
muru's user avatar
  • 24.8k
7 votes

How to "full screen" browse Vim help?

Another option that gets rid of the pesky extra "new file" tab is vim +"tab help | -tabc". This creates a help tab on vim start (tab help) and removes the new file (-tabc).
JacobTDC's user avatar
  • 171
7 votes

How do I navigate to topics in Vim's documentation?

-0.1 make notes about vim in a file. Use it as reference and container. fast way to find vim help of key | :cmd | 'option' | etc :h gi or :h g; for gi or g; in normal mode :h ^i for Ctrl-i in normal ...
qeatzy's user avatar
  • 960
7 votes

On string concatenation, what's the difference between . and .. (single dot and double dot)?

Take note of the examples: :execute "buffer" nextbuf :execute "normal" count .. "w" What it's indirectly saying is, to avoid a space in the resulting string that's ...
Zoe is on strike's user avatar
7 votes
Accepted

Why is Vim9 mentioned at all in the doc of Vim 8?

Because Vim9 has not been formally released yet, but the features are ready to try out in the latest Vim8 releases. If you see it in the help, then you can use it two ways: The Vim9 script syntax and ...
Chris Heithoff's user avatar
7 votes
Accepted

When was getcharstr() introduced? And how could I have found the answer my self from :help?

This was patch v8.2.2957, which can be found by examining a full clone of github.com/vim/vim and any of # message search; fast enough I didn't need any of the other limiting options git log -1 --grep ...
D. Ben Knoble's user avatar
  • 25.8k
6 votes

How to "full screen" browse Vim help?

this may be the simplest way to achieve this vim +"help | only" or the same as vim +help +only
user2204107's user avatar
6 votes
Accepted

What prevents the cursor from moving to the first column on some help files?

By default, the cursor is positioned on the last cell used to display a tab character. You can change that behavior by enabling the list option and defining custom values for the listchars option (...
romainl's user avatar
  • 40.1k
6 votes

How do I generate Vim documentation from Markdown notes or inline comments, or are there better ways to add documentation?

html2vimdoc.py The most promising tool I've found is html2vimdoc.py which can be found here http://peterodding.com/code/vim/tools and on github. It can convert markdown and html to vim's help format. ...
Hotschke's user avatar
  • 4,740
6 votes
Accepted

What does `*foo* *[foo]*` mean in the vim help system?

The meaning of the * (or more specifically *word*) is, that this defines a help tag you can jump to. So if you enter :h count Vim knows where to get you to have you read about the count. This also ...
Christian Brabandt's user avatar
6 votes

What does `idem` mean in the VIM docs?

:help list ... :let i = remove(list, 3) " remove item 3 :unlet list[3] " idem :let l = remove(list, 3, -1) " remove items 3 to last item :unlet list[3 : ] ...
João A. Toledo's user avatar
6 votes
Accepted

Buffers that are neither active nor hidden

You'll find more details under :h active-buffer and the sections that follow... *active-buffer* active: The buffer is displayed in a window. If there is a file for this ...
B Layer's user avatar
  • 19.7k
5 votes

Jump to next identifier in Vim help files

This is what I use. As well as |.....| tags, it will also stop on options of the form '.....' But it's not pretty... ### ~/.vim/ftplugin/help/navigate.vim ### nnoremap <silent> <buffer> ...
joeytwiddle's user avatar
  • 3,622
5 votes

How do I navigate to topics in Vim's documentation?

Regarding the question: how to follow hyperlinks? With the mouse cursor over the desired link do Ctrl + ]. Ctrl + t will bring you back to the initial outline with its list of links, where you can ...
alec's user avatar
  • 785
5 votes
Accepted

How to list all help subjects and help files?

A1.a: To get a list of all help topics (of which there can be thousands), you can define and call the following function to read all help-tags files into a new buffer: function! ListHelpSubjects() ...
Jürgen Krämer's user avatar
4 votes
Accepted

vimscript: get result of cmdline-completion Ctrl-a

Edit: Sorry, I misunderstood your question. I think you want the getcompletion() function. For example, given :h bufwin, return h bufwinid() bufwinnr() BufWinEnter BufWinLeave You could get this ...
user852573's user avatar
  • 1,013
4 votes

Where are the French help files?

The answer, for the moment, seems to be: There isn't one (at least, not past vim 6). As mentioned on vim-dev by the former maintainer, a very old archive has been put up at dindinx.net. The ...
D. Ben Knoble's user avatar
  • 25.8k
4 votes
Accepted

:help - is there something like apropos?

You're probably looking for :helpgrep, which is mentioned in :help helphelp.
D. Ben Knoble's user avatar
  • 25.8k
4 votes
Accepted

Complete list of all VIM commands

For all the gory details From :help index: This file contains a list of all commands for each mode, with a tag and a short description. The lists are sorted on ASCII value. From :help function-list:...
mattb's user avatar
  • 1,101
3 votes

How do I generate Vim documentation from Markdown notes or inline comments, or are there better ways to add documentation?

There is Md2Vim project: tool for automatically converting markdown to vimdoc format. Quotation: Writing technical documentation for Vim extensions is not exciting; manually converting what you've ...
petRUShka's user avatar
  • 243
3 votes

How to "full screen" browse Vim help?

I'm rarely use tabs, but if I make a help window :only, (which is what I have done in the past), and then I switch to the file buffer to try what I learned, the help buffer is gone, and I have to ...
Wayne Walker's user avatar
3 votes

How to "full screen" browse Vim help?

My personal variation: command! -nargs=1 -complete=help H help <args> | silent only This let's you to use :H as you would normally use :help. only then does the Ctrlw-o combo that others have ...
Patrick's user avatar
  • 191

Only top scored, non community-wiki answers of a minimum length are eligible