sioyek icon indicating copy to clipboard operation
sioyek copied to clipboard

Display quick help with hotkeys

Open skjerns opened this issue 2 years ago • 6 comments

As a new user it takes a while to memorize all the amazing features and shortcuts of sioyek. Going back to the tutorial PDF every time is not very efficient.

It would be very useful to have a overlay with all hotkeys very briefly listed, e.g. semi-transparent and toggle-able by pressing F1. What do you think?

skjerns avatar Feb 24 '22 18:02 skjerns

Maybe we could do that in the future. As an alternative for now, if you press : we show a list of all available commands with the corresponding shortcut on the right side. Also we recently added fuzzy search to this list in bb571d01878b33bf53bf72b55b0b9dce394627c9 which should help.

ahrm avatar Feb 26 '22 09:02 ahrm

i did this in ~/.config/sioyek/prefs_user.config:

new_command open_tutorial sioyek /usr/share/sioyek/tutorial.pdf

and in ~/.config/sioyek/keys_user.config:

open_tutorial <f1>

anarcat avatar Mar 07 '23 20:03 anarcat

Note that custom command names must start with an underscore.

ahrm avatar Mar 07 '23 20:03 ahrm

Note that custom command names must start with an underscore.

why?

anarcat avatar Mar 07 '23 20:03 anarcat

In order not to be confused with future built in sioyek commands. For example in the future I may add a built-in open_tutorial command and it could break user configs.

ahrm avatar Mar 07 '23 20:03 ahrm

Right, I guessed as much, but in this specific case I very much hope you will add a open_tutorial command and I do hope my command will then break, so I can remove the cruft from my config. :)

anarcat avatar Mar 07 '23 21:03 anarcat