phetsims / friction

"Friction" is an educational simulation in HTML5, by PhET Interactive Simulations.
http://phet.colorado.edu/en/simulation/friction
GNU General Public License v3.0
4 stars 6 forks source link

Review Description and Voicing strings for PhET-iO #251

Closed arouinfar closed 2 years ago

arouinfar commented 2 years ago

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 commented 2 years ago
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 commented 2 years ago

Example from RIAW

terracoda commented 2 years ago

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 commented 2 years ago

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.