Skip to content

Commit

Permalink
selfVoicing -> voicing in many places in documentation, see phetsims/…
Browse files Browse the repository at this point in the history
  • Loading branch information
jessegreenberg committed Apr 5, 2021
1 parent 1b11af2 commit 55b4003
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 21 deletions.
6 changes: 3 additions & 3 deletions js/Sim.js
Original file line number Diff line number Diff line change
Expand Up @@ -651,7 +651,7 @@ class Sim {
this.display.addInputListener( {
down: event => {

// in the self-voicing Prototypes focus highlights should remain with gesture controls or interactive highlights
// in the voicing Prototypes focus highlights should remain with gesture controls or interactive highlights
// enabled
if ( this.preferencesProperties && !this.preferencesProperties.interactiveHighlightsEnabledProperty.value && !this.preferencesProperties.gestureControlsEnabledProperty.value ) {

Expand Down Expand Up @@ -720,8 +720,8 @@ class Sim {
this.display.setCanvasNodeBoundsVisible( phet.chipper.queryParameters.showCanvasNodeBounds );
this.display.setFittedBlockBoundsVisible( phet.chipper.queryParameters.showFittedBlockBounds );

// @private (Toolbar|null) - The Toolbar will not be created unless the self-voicing feature is enabled, since
// the only contents of the Toolbar are for the self-voicing feature at the moment.
// @private (Toolbar|null) - The Toolbar will not be created unless the voicing feature is enabled, since
// the only contents of the Toolbar are for the voicing feature at the moment.
this.toolbar = null;

if ( options.preferencesConfiguration ) {
Expand Down
2 changes: 1 addition & 1 deletion js/preferences/AudioPreferencesPanel.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class AudioPreferencesTabPanel extends VBox {

const panelChildren = [];

// The self-voicing feature is not supported with i18n at this time, it should only be enabled and configurable
// The voicing feature is not supported with i18n at this time, it should only be enabled and configurable
// if running in english locale
// NOTE: This should be for the whole feature, not just the dialog
if ( phet.chipper.locale === 'en' && audioOptions.supportsVoicing ) {
Expand Down
8 changes: 4 additions & 4 deletions js/preferences/VoicingPanelSection.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Copyright 2021, University of Colorado Boulder

/**
* The section of PreferencesDialog content in the "Audio" panel related to self-voicing.
* The section of PreferencesDialog content in the "Audio" panel related to voicing.
*
* @author Jesse Greenberg
*/
Expand Down Expand Up @@ -130,7 +130,7 @@ class VoicingPanelSection extends PreferencesPanelSection {

// webSpeaker.enabledProperty.link( enabled => SunConstants.componentEnabledListener( enabled, content ) );

// Speak when self-voicing becomes initially enabled. First speech is done synchronously (not using utterance-queue)
// Speak when voicing becomes initially enabled. First speech is done synchronously (not using utterance-queue)
// in response to user input, otherwise all speech will be blocked on many platforms
webSpeaker.enabledProperty.lazyLink( enabled => {
if ( enabled ) {
Expand All @@ -141,7 +141,7 @@ class VoicingPanelSection extends PreferencesPanelSection {
}

/**
* Create a checkbox for the features of self-voicing content with a label.
* Create a checkbox for the features of voicing content with a label.
* @param {string} labelString
* @param {BooleanProperty} property
* @returns {Checkbox}
Expand All @@ -152,7 +152,7 @@ const createCheckbox = ( labelString, property ) => {
};

/**
* Create a NumberControl for one of the voice parameters of self-voicing (pitch/rate).
* Create a NumberControl for one of the voice parameters of voicing (pitch/rate).
*
* @param {string} labelString - label for the NumberControl
* @param {NumberProperty} voiceRateProperty
Expand Down
12 changes: 6 additions & 6 deletions js/toolbar/Toolbar.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

/**
* The Toolbar along the left edge of the screen with controls related to the sim or active screen. Currently, it
* only contains controls related to the self-voicing feature. It isn't always displayed and the user must request it
* from the PreferencesDialog. In order to be used, both self-voicing AND the Toolbar must be requested by the user,
* self-voicing can be used without this component.
* only contains controls related to the voicing feature. It isn't always displayed and the user must request it
* from the PreferencesDialog. In order to be used, both voicing AND the Toolbar must be requested by the user,
* voicing can be used without this component.
*
* When open, the sim will resize and shift to the right to create space. Screen bounds are adjusted so that
* simulation components will never overlap with the Toolbar.
Expand Down Expand Up @@ -34,7 +34,7 @@ const CONTENT_TOP_MARGIN = 15; // margin between top of Toolbar and contents
class Toolbar extends Node {

/**
* @param {VoicingToolbarAlertManager} voicingAlertManager - generates self-voicing alerts
* @param {VoicingToolbarAlertManager} voicingAlertManager - generates voicing alerts
* @param {BooleanProperty} enabledProperty - whether or not the Toolbar is enabled and visible to the user
* @param {LookAndFeel} lookAndFeel
*/
Expand Down Expand Up @@ -63,14 +63,14 @@ class Toolbar extends Node {
this.openProperty = new BooleanProperty( true );

// @public (read-only) {DerivedProperty.<boolean>} - Whether the Toolbar is shown to the user. At this time,
// that is true if self-voicing and the Toolbar are explicitly enabled. Note that isShowingProperty can be true
// that is true if voicing and the Toolbar are explicitly enabled. Note that isShowingProperty can be true
// while openProperty is false, they are unrelated.
this.isShowingProperty = DerivedProperty.and( [ this.isEnabledProperty, webSpeaker.enabledProperty ] );

// @private {number} - Scale applied to the Toolbar and its contents in response to layout and window resizing.
this.layoutScale = 1;

// @private {VoicingToolbarItem} - Contents for the Toolbar, currently only controls related to the self-voicing
// @private {VoicingToolbarItem} - Contents for the Toolbar, currently only controls related to the voicing
// feature.
this.menuContent = new VoicingToolbarItem( voicingAlertManager, lookAndFeel );

Expand Down
12 changes: 6 additions & 6 deletions js/toolbar/VoicingToolbarAlertManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ class VoicingToolbarAlertManager {
*/
createOverviewContent() {
const screenView = this.screenProperty.value.view;
assert && assert( screenView, 'view needs to be inititalized for self-voicing toolbar content' );
assert && assert( screenView.getVoicingOverviewContent, 'self-voicing toolbar is enabled, implement getVoicingOverviewContent on ScreenView' );
assert && assert( screenView, 'view needs to be inititalized for voicing toolbar content' );
assert && assert( screenView.getVoicingOverviewContent, 'voicing toolbar is enabled, implement getVoicingOverviewContent on ScreenView' );
return screenView.getVoicingOverviewContent();
}

Expand All @@ -37,8 +37,8 @@ class VoicingToolbarAlertManager {
*/
createDetailsContent() {
const screenView = this.screenProperty.value.view;
assert && assert( screenView, 'view needs to be inititalized for self-voicing toolbar content' );
assert && assert( screenView.getVoicingDetailsContent, 'self-voicing toolbar is enabled, implement getVoicingDetailsContent on ScreenView' );
assert && assert( screenView, 'view needs to be inititalized for voicing toolbar content' );
assert && assert( screenView.getVoicingDetailsContent, 'voicing toolbar is enabled, implement getVoicingDetailsContent on ScreenView' );
return screenView.getVoicingDetailsContent();
}

Expand All @@ -48,8 +48,8 @@ class VoicingToolbarAlertManager {
*/
createHintContent() {
const screenView = this.screenProperty.value.view;
assert && assert( screenView, 'view needs to be inititalized for self-voicing toolbar content' );
assert && assert( screenView.getVoicingHintContent, 'self-voicing toolbar is enabled, implement getVoicingDetailsContent on ScreenView' );
assert && assert( screenView, 'view needs to be inititalized for voicing toolbar content' );
assert && assert( screenView.getVoicingHintContent, 'voicing toolbar is enabled, implement getVoicingDetailsContent on ScreenView' );
return this.screenProperty.value.view.getVoicingHintContent();
}
}
Expand Down
2 changes: 1 addition & 1 deletion js/toolbar/VoicingToolbarItem.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Copyright 2021, University of Colorado Boulder

/**
* An item for the Toolbar that includes components related to the self-voicing feature. Includes a switch to
* An item for the Toolbar that includes components related to the voicing feature. Includes a switch to
* enable/disable all speech, and buttons to hear overview information about the active sim Screen.
*
* @author Jesse Greenberg (PhET Interactive Simulations)
Expand Down

0 comments on commit 55b4003

Please sign in to comment.