typst / webapp-issues

Issue tracker for Typst's web app.
https://typst.app
13 stars 0 forks source link

Remove "only for experienced users" warning in settings #243

Closed basings closed 11 months ago

basings commented 11 months ago

Description

The settings state

Applies keybindings as known from Vi/vim editors. Only for experienced users!

where "only for experienced users" tells me that I shall learn vim keybindings to become an experienced user and as long as I don't do that, I'm not experienced.

Use Case

Users should not think that vim keybindings are neccessary to master (the) typst (webapp).

Enivex commented 11 months ago

Experienced users of Vim, not typst

basings commented 11 months ago

Meaning, it's discouraged for beginners in vim?

Enivex commented 11 months ago

Meaning, it's discouraged for beginners in vim?

There has to be some sort of warning there to prevent users from being confused when keys don't work as they expect. If you're familiar with vim, then you're able to make an informed choice.

basings commented 11 months ago

Meaning, it's in an alpha/beta/whatever state and a vim beginner shall not use it because there might be hickups only experienced users know how to handle.

I expect a vim beginner to be educated enough to know how to handle bugs. A warning that it might be buggy would be better than to exclude vim beginners.

Enivex commented 11 months ago

Meaning, it's in an alpha/beta/whatever state and a vim beginner shall not use it because there might be hickups only experienced users know how to handle.

No, thats not what it means. To my knowledge it works well.

The point is that most users of typst will not even know what Vim is in the first place. It's not about bugs.

Heinenen commented 11 months ago

Typst is also meant for people that are not programmers and the like, thus normally do not know what Vim is. The warning is to prevent such a user from enabling that option "on accident" without knowing what it actually does.

basings commented 11 months ago

To me the warning reads as if vim keybindings are for experienced typst users. This is why I opened the issue in the first place.

Andrew15-5 commented 11 months ago
Neovim user here

![image](https://github.com/typst/webapp-issues/assets/37143421/f6295508-e57e-423c-8395-6c873a2f558b)

Typst is also meant for people that are not programmers and the like, thus normally do not know what Vim is.

Typst is meant for everybody, but web app version... still meant for everybody, but fewer people will prefer it (including myself), if you can just directly use Typst compiler locally. So the chances are that web app is used by users who don't know what vim is (compared to vim-users), are pretty high, I would say.

Anyway, I agree with @Enivex and @Heinenen that non-Vim users could set up themselves for a disaster by enabling Vim mode (imagine hitting dd or something). Or at least it could be confusing: "why the heck my keyboard doesn't work?!".

When I first read this note, I thought that it was written "by vimmer", in other words it shows superiority of vim users (Vim superiority, let's gooo!). So, in a way, it only lacks " /s" at the end. But if I try to suppress my superiority complex, I can see that this phrase isn't the best one (from other points of view).

I just thought of one very popular phrase that should fix the problem:

Applies keybindings from Vi/Vim editors. Only enable this (mode) if you know what you are doing!

Or:

Applies keybindings from Vi/Vim editors. Only enable this mode if you know how to work in Vim (and alike)!

Or:

Applies keybindings from Vi/Vim editors. Only enable this mode if you know what Vim is!

The only part I'm not sure of is if Vi is written with capital V (but Vim is correct).

(other) Notes to devs:

basings commented 11 months ago

Thank you @Andrew15-5 that sounds more understabdable to me. Maybe linking to `Vim?

Andrew15-5 commented 11 months ago

Maybe linking to Vim?

You know what? I think that's a great idea! But I was thinking more of a https://en.wikipedia.org/wiki/Vim_(text_editor) or https://www.vim.org/about.php. Because users that don't know what Vim is will probably want to see Wikipedia-like information to easily understand "what's vim?". I think if a person doesn't know what Vim is, there is a high change of not knowing what GitHub/git(-repository) is as well, so linking to repository wouldn't make any difference (in terms of clarity of the Vim term).

laurmaedje commented 11 months ago

I have removed the warning completely. It's not that difficult to turn it off if things are weird after turning it on. I haven't added a link because I think (a) people that know Vim don't need a link, (b) people that don't know Vim don't need the setting and will just ignore it anyway.