[vim/vim] Please add hotkeys list to title page (Issue #14058)

39 views
Skip to first unread message

tyler-suard-parker

unread,
Feb 19, 2024, 7:33:22 PM2/19/24
to vim/vim, Subscribed

It would go a long way to making vim more user-friendly if the commands were on the front page. For example, right now when vim opens it shows how to quit, but it would be nice to include the following:

i: Insert mode
A: Append mode
esc: Exit a mode
: :command mode
0: go to beginning of a line
$: go to the end of a line
:w : save changes to file

Etc.


Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.Message ID: <vim/vim/issues/14058@github.com>

tyler-suard-parker

unread,
Feb 19, 2024, 7:48:49 PM2/19/24
to vim/vim, Subscribed

Related: PR #14059


Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.Message ID: <vim/vim/issues/14058/1953322791@github.com>

Christian Brabandt

unread,
Feb 20, 2024, 12:12:36 PM2/20/24
to vim/vim, Subscribed

I am not sure. Keep in mind, the intro screen is not meant as a tutorial for users, but merely should show them where to find help (and in case you were thrown into it and have no idea what this black thing is, how to exit it). Adding more lines to it, will probably make it harder to find the right line, and we must ensure it fits into a default terminal size of 80x20 without looking too crowded.


Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.Message ID: <vim/vim/issues/14058/1954671387@github.com>

Aliaksei Budavei

unread,
Feb 20, 2024, 1:50:58 PM2/20/24
to vim/vim, Subscribed

https://github.com/vim/vim/blob/c86bff1771ed9c340f8f4433ae5530fd6de97980/runtime/doc/usr_01.txt#L110-L112

New and occasional users may brush up on their Vim skills by
following the instructions of vimtutor.

The :intro page already points in its direction:
https://github.com/vim/vim/blob/c86bff1771ed9c340f8f4433ae5530fd6de97980/src/version.c#L1427

Maybe, the "Getting started:" lines:

https://github.com/vim/vim/blob/c86bff1771ed9c340f8f4433ae5530fd6de97980/runtime/doc/help.txt#L35-L38

should be moved closer to the top of doc/help.txt so that
eager users would able to spot them sooner.


Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.Message ID: <vim/vim/issues/14058/1954859611@github.com>

tyler-suard-parker

unread,
Feb 20, 2024, 3:29:43 PM2/20/24
to vim/vim, Subscribed

@chrisbra @zzzyxwvut I understand, I used Nano for years, despite Vim being the vastly superior editor, because Nano has the hotkeys right there on the screen, which makes it way easier to use. I know we can't do that with Vim, but just having some of the essential commands right there on the main screen would go a long way to making Vim more user-friendly for beginners and more popular. Also, it is not clear that on-line help will show what the keystrokes are, or how to use Vim. When I read on-line help, I think of talking to a tech support representative, who might tell me that Vim is working but would not tell me how to use it.


Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.Message ID: <vim/vim/issues/14058/1955021763@github.com>

Gary Johnson

unread,
Feb 20, 2024, 4:34:08 PM2/20/24
to reply+ACY5DGHL5AXWSS4MM6...@reply.github.com, vim...@googlegroups.com
On 2024-02-20, tyler-suard-parker wrote:
> @chrisbra @zzzyxwvut I understand, I used Nano for years, despite Vim being the
> vastly superior editor, because Nano has the hotkeys right there on the screen,
> which makes it way easier to use. I know we can't do that with Vim, but just
> having some of the essential commands right there on the main screen would go a
> long way to making Vim more user-friendly for beginners and more popular. Also,
> it is not clear that on-line help will show what the keystrokes are, or how to
> use Vim. When I read on-line help, I think of talking to a tech support
> representative, who might tell me that Vim is working but would not tell me how
> to use it.

Except that that intro screen is there only until the user makes
some change to the buffer, then it's gone. At that point, the user
is not going to remember a long list of commands, but they may
remember a very short list telling them how to exit and how to find
help. I think that showing them more information than is already
there would actually be _less_ helpful.

Vim's built-in help _does_ show what the important keystrokes are as
well as directing the user to more topics. It is probably the best
help system you will find in any editor. In fact, if a new user
learns only one thing from the intro screen, it should be to type
":help". That will show them how to quit.

If you think that there should be an easier way for the user to find
the list of commands you suggested, putting them in an easy-to-
discover place under :help would be better than on the intro screen.

Regards,
Gary

vim-dev ML

unread,
Feb 20, 2024, 4:34:37 PM2/20/24
to vim/vim, vim-dev ML, Your activity

On 2024-02-20, tyler-suard-parker wrote:
> @chrisbra @zzzyxwvut I understand, I used Nano for years, despite Vim being the
> vastly superior editor, because Nano has the hotkeys right there on the screen,
> which makes it way easier to use. I know we can't do that with Vim, but just
> having some of the essential commands right there on the main screen would go a

> long way to making Vim more user-friendly for beginners and more popular. Also,
> it is not clear that on-line help will show what the keystrokes are, or how to
> use Vim. When I read on-line help, I think of talking to a tech support
> representative, who might tell me that Vim is working but would not tell me how
> to use it.

Except that that intro screen is there only until the user makes
some change to the buffer, then it's gone. At that point, the user
is not going to remember a long list of commands, but they may
remember a very short list telling them how to exit and how to find
help. I think that showing them more information than is already
there would actually be _less_ helpful.

Vim's built-in help _does_ show what the important keystrokes are as
well as directing the user to more topics. It is probably the best
help system you will find in any editor. In fact, if a new user
learns only one thing from the intro screen, it should be to type
":help". That will show them how to quit.

If you think that there should be an easier way for the user to find
the list of commands you suggested, putting them in an easy-to-
discover place under :help would be better than on the intro screen.

Regards,
Gary


Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.Message ID: <vim/vim/issues/14058/1955150837@github.com>

Tyler

unread,
Feb 21, 2024, 1:18:06 AM2/21/24
to vim/vim, vim-dev ML, Mention

@vim-ml Thanks for the feedback. Totally get the concern about clutter. How about we add just one line to the intro: "Hit :help basics for key commands"? Keeps it clean and nudges newbies gently towards the goldmine of info in :help.

Nano's got its shortcuts upfront, and it's a hit for ease of use. We're not Nano, but that one line could make Vim feel a bit more welcoming without sacrificing our minimalist vibe. Plus, it directly addresses the "how do I even start?" question in a super succinct way.

Thoughts?


Reply to this email directly, view it on GitHub.

You are receiving this because you were mentioned.Message ID: <vim/vim/issues/14058/1955967688@github.com>

Christian Brabandt

unread,
Feb 21, 2024, 6:37:41 AM2/21/24
to vim/vim, vim-dev ML, Mention

the type :help<Enter> or <F1> for on-line help is not enough?

Also, I am pretty sure, one could create a plugin for nano like help banner using popup windows or similar. But that probably belongs to its own plugin.


Reply to this email directly, view it on GitHub.

You are receiving this because you were mentioned.Message ID: <vim/vim/issues/14058/1956462482@github.com>

Christian Brabandt

unread,
Feb 24, 2024, 4:30:33 AM2/24/24
to vim/vim, vim-dev ML, Mention

Closed #14058 as not planned.


Reply to this email directly, view it on GitHub.

You are receiving this because you were mentioned.Message ID: <vim/vim/issue/14058/issue_event/11910430722@github.com>

Christian Brabandt

unread,
Feb 24, 2024, 4:30:35 AM2/24/24
to vim/vim, vim-dev ML, Mention

let's not do it then.


Reply to this email directly, view it on GitHub.

You are receiving this because you were mentioned.Message ID: <vim/vim/issues/14058/1962310254@github.com>

Reply all
Reply to author
Forward
0 new messages