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

Review Description and Voicing strings for PhET-iO #251

Closed
arouinfar opened this issue Sep 30, 2021 · 4 comments
Closed

Review Description and Voicing strings for PhET-iO #251

arouinfar opened this issue Sep 30, 2021 · 4 comments

Comments

@arouinfar
Copy link
Contributor

Related to #236

In PhET-iO meeting we decided that I should review the description and voicing strings in Friction to identify if there are any strings that could becoming inaccurate/out-of-sync with PhET-iO customization.

For example, clients can change the name of the Chemistry book using view.topBookNode.titleText.textProperty. However, "Chemistry" appears throughout the description and in the name of other UI elements, such as buttons.

Voicing strings can be printed to the console using the printVoicingResponses query parameter.

@arouinfar
Copy link
Contributor Author

phetioID Impact on strings/PDOM
view.resetAllButton.visibleProperty If false, Control Area will be empty.

Scene Summary: "Reset sim to make more observations."

Responsive Descriptions: "Reset sim to make more observations."
general.model.simNameProperty
For multi-screen sims, *Screen.nameProperty
Changes name of sim. Sim name appears in H1 & first sentence of Scene Summary, "Friction is an interactive sim."

For multi-screen sims, changing the screen names affects heading names and navbar button names.
view.bottomBookNode.titleText.textProperty Default value is "Physics". Appears in scene summary, "Chemistry book rests on top of a Physics book" and responsive description when books come into contact, "Lightly on Physics book."
view.topBookNode.titleText.textProperty Default value is "Chemistry". Appears frequently throughout the PDOM.

Buttons: "Grab Chemistry book" and "Grab zoomed-in Chemistry book"

State Descriptions: Referenced throughout Scene Summary

Responsive Descriptions: "Atoms break away from Chemistry book."
view.topBookNode.inputEnabledProperty
view.atomicView.atomDragArea.inputEnabledProperty
If both are false, there is no way to move the Chemistry book.

Scene Summary: "Chemistry book rests on top of a Physics book , and is ready to be rubbed against it."

Play Area: Grab button(s) will be disabled. Associated help text, "Look for grab buttons. Once grabbed, use keyboard shortcuts to move book or zoomed-in book."
view.atomicView.visibleProperty Hides the zoomed-in view.

There are many references to the jiggling atoms throughout the Scene Summary and Responsive Descriptions and are often coupled with the temperature. Examples include, "In zoomed-in view of where books meet, surface temperature thermometer is cool, and atoms jiggle a tiny bit." and "Jiggling less, cooler."

"Grab zoomed-in Chemistry book" button would need to be disabled.
view.thermometerNode.visibleProperty Hides thermometer.

Scene Summary: "In zoomed-in view of where books meet, surface temperature thermometer is {{cool}}, and atoms jiggle a tiny bit."

Responsive Descriptions: "Jiggling more, {{warmer}}." and "Atoms jiggle a tiny bit, temperature {{cool}}."

@arouinfar
Copy link
Contributor Author

arouinfar commented Oct 28, 2021

Example from RIAW

  • Hide Resistivity Slider, would be helpful to say that the value is "unknown" rather than simply omitting its value. Might want a property like isUnknownProperty that could be used in conjunction with the visibleProperty.

@terracoda
Copy link
Contributor

Thanks for opening this issue @arouinfar.

Some description strings not meant for Interactive Description and some behaviours of hints that may be problematic for non-visual users need some review, too. I will open a seperate issue about that.

@arouinfar
Copy link
Contributor Author

arouinfar commented May 16, 2022

The goal of this issue was to identify Description and Voicing strings that could be impacted by PhET-iO customization. That's been done, so I don't think we need to keep this issue open, so 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

3 participants