Skip to content
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

Create documentation for used hotkeys #211

Closed
jessegreenberg opened this issue Apr 14, 2023 · 3 comments
Closed

Create documentation for used hotkeys #211

jessegreenberg opened this issue Apr 14, 2023 · 3 comments

Comments

@jessegreenberg
Copy link
Contributor

From phetsims/scenery#1445, we hoped to make an automated registry for global hotkeys. But that won't be worked on any time soon and may even be more trouble than it is worth. We should document key commands used in each sim/repo so it easy to make sure there are no overlaps.

Maybe the keys could be encoded in a machine readable way so that the data can be used for things like the Keyboard Help dialog. Otherwise we should manually document.

@terracoda
Copy link
Contributor

This resource should be part of the documentation:

@jessegreenberg jessegreenberg changed the title Create a registry for hotkeys Create documentation used for hotkeys Apr 26, 2024
@jessegreenberg jessegreenberg changed the title Create documentation used for hotkeys Create documentation for used hotkeys Apr 26, 2024
@jessegreenberg
Copy link
Contributor Author

jessegreenberg commented Apr 26, 2024

A global "registry" for Hotkeys was implemented in phetsims/scenery#1621. It catches Hotkey overlap at runtime. I am not sure yet how that relates to this issue but I wanted to link the two.

@jessegreenberg
Copy link
Contributor Author

Binder is now generating a list of used hotkeys in PhET sims through HotkeyData. Most of the work was done in phetsims/scenery#1266. Closing.

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

No branches or pull requests

2 participants