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

Keyboard help dialog needed #102

Closed
zepumph opened this issue Mar 6, 2024 · 12 comments
Closed

Keyboard help dialog needed #102

zepumph opened this issue Mar 6, 2024 · 12 comments
Assignees

Comments

@zepumph
Copy link
Member

zepumph commented Mar 6, 2024

From #98 and phetsims/buoyancy#76. This should have probably been done over there.

@zepumph zepumph self-assigned this Mar 6, 2024
@zepumph
Copy link
Member Author

zepumph commented Apr 4, 2024

@DianaTavares. I believe the first step here is to make a design. This is because it has custom dragging that likely wants sim-specific wording. For examples you can poke the all our keyboard help dialogs here: https://phetsims.github.io/binder/#joist-KeyboardHelpDialog

@zepumph zepumph assigned DianaTavares and unassigned zepumph Apr 4, 2024
@terracoda
Copy link

@zepumph, that is an amazing link! Thanks for posting it in this issue.

@DianaTavares here are some KBS dialog exmaples that cover draggable objects, sliders, and comboboxes

Gas Properties has all 3 of those:
Screenshot 2024-04-30 at 15 48 35

@terracoda
Copy link

It's trivial to change the heading content to be more sim specific. There are other customizations that can be made if they are really important for the interaction or for the organization of the dialog content. For example, is GFL:B and GFL regular, the Move Spheres and Change Mass sections were reduced to just one set of arrow keys even though all the 4 arrow keys work. Doing this emphasizes the orientation of the interaction in GFL:B, and de-clutter the instructions for both sims. De-cluttering was essential for GFL regular because the instructions for grabbing and moving the Ruler are long.

Gravity Force Lab: Basics
Screenshot 2024-04-30 at 15 55 30

Gravity Force Lab (regular)
Screenshot 2024-04-30 at 15 53 50

@terracoda
Copy link

Some Tips:

  • Basic Actions always comes last since those are likely known to keyboard users.
  • Instructions for the interactions should ideally come in order of importance of the interaction in the sim.
  • Instructions are per screen
  • If you run out of room (you won't for Density and Buoyancy) you can potentially leave off interactions that have been described on a previous screen's KBS dialog (not ideal, but it has happened).

@terracoda
Copy link

And here's one last example from Quadrilateral where we changed the language from "Move Draggable Items" to "Move Corners and Sides" and did some more customization as well.
Screenshot 2024-04-30 at 16 11 21

I hope these examples are helpful. Let me know if you need anything else for Keyboard Shortcuts dialogs.

@DianaTavares
Copy link

Thanks for all your support @terracoda!!

Buoyancy is super general. Then I use the general picture that @terracoda share and delete the information that is not going to b needed in each screen, this is the information:

Intro Screen
image

All the other Screens
image

@DianaTavares DianaTavares assigned zepumph and unassigned DianaTavares May 1, 2024
@zepumph zepumph removed their assignment May 1, 2024
@terracoda
Copy link

@jessegreenberg, I am not sure if "Pop Up Menu" is the final heading for the latest version of combobox. Can you double check that. We just updated the common code combobox info for Gas Properties and I can't remember if "Pop Up Menu" was the final text for the heading.

@jessegreenberg
Copy link
Contributor

Yes, "Pop Up Menu" was the choice from phetsims/scenery-phet#852.

@terracoda
Copy link

Thanks for posting the issue number. In this comment, phetsims/scenery-phet#852 (comment)

I had suggested "Show Choices" or "Pop Open Menu", since the menu doesn't always go up.

And sorry, I am not sure what I am supposed to review in phetsims/scenery-phet/issues/852

@jessegreenberg
Copy link
Contributor

Ah, I think just to confirm you like the final language for default content. If you want it to change to "Show Choices", can you please comment over there?

@terracoda
Copy link

Over in the other issue, I made the default to "Change X" or "Change Choice". That captures the spirit of the heading language better, since "Show Choices" is step 1.

samreid added a commit that referenced this issue May 7, 2024
samreid added a commit to phetsims/density that referenced this issue May 7, 2024
samreid added a commit that referenced this issue May 7, 2024
samreid added a commit to phetsims/buoyancy that referenced this issue May 7, 2024
samreid added a commit to phetsims/buoyancy-basics that referenced this issue May 7, 2024
samreid added a commit that referenced this issue May 7, 2024
@samreid
Copy link
Member

samreid commented May 7, 2024

@terracoda and I reviewed the implementation and it seems good to close. @terracoda indicated we could change the headings to say e.g., "drag blocks" or things that are more screen-specific, but we discussed that that is non-trivial and could take >1hr to do for all 10 screens across 3 sims. So we are OK to close.

@samreid samreid closed this as completed May 7, 2024
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

5 participants