New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to list and document all the keyboard shortcuts #7023

Closed
afercia opened this Issue May 30, 2018 · 4 comments

Comments

Projects
None yet
6 participants
@afercia
Contributor

afercia commented May 30, 2018

I see there has been some reworking of the keyboard shortcuts recently. The relevant tools are in utils/keycodes.js. There are functions for the raw shortcuts and the ones to display in a human readable form, there's a well defined list of modifers, etc. It's a good improvement, well done.

However, users need to know all the available keyboard shortcuts. Sooner or later there will be the need to have a place (internal, external?) to list all the shortcuts. Also, there will be the need to document them somewhere in the handbook.

Even as developers, we don't know how many (and which) keyboard shortcuts are currently available. The only way is to manually look for them through the codebase.

I'd like to propose to consider to make this way easier. Maybe, there should be a centralized place, a configuration file that lists all the shortcuts and can then be imported in the various components when needed? Any feedback and suggestions very welcome.

@danielbachhuber danielbachhuber added this to the WordPress 5.0 milestone Jun 4, 2018

@rianrietveld

This comment has been minimized.

Member

rianrietveld commented Jun 12, 2018

@afercia
I've talked about this with Jon Ang of the docs team, and he proposed adding this to the new wp-helphub.com site. We can put the WP manual for users of AT there. If you agree.

@iandunn

This comment has been minimized.

Member

iandunn commented Jul 9, 2018

I think it would be much more discoverable, intuitive, and convenient if the shortcuts were documented in the Gutenberg UI directly, rather than making the user learn about and reference external documentation.

A few examples of that:

  • Slack: Cmd + / (Mac) or Ctrl + / (Linux, Windows)
  • GitHub: ? (when not in a textarea)
  • Trello: ? (when not in a textarea)
@samikeijonen

This comment has been minimized.

Contributor

samikeijonen commented Jul 9, 2018

Agreed.

@mtias

This comment has been minimized.

Contributor

mtias commented Jul 19, 2018

Closing in favor of #5420

@mtias mtias closed this Jul 19, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment