From 6f6fbff80786f7f6aedee7b0f0b8f81b68a45ec7 Mon Sep 17 00:00:00 2001 From: Chris Malley <vcs@pixelzoom.com> Date: Fri, 21 Jan 2022 13:36:11 -0700 Subject: [PATCH] https://github.com/phetsims/phet-info/issues/168 --- doc/alternative-input-quickstart-guide.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/alternative-input-quickstart-guide.md b/doc/alternative-input-quickstart-guide.md index aea09753..7ed7051e 100644 --- a/doc/alternative-input-quickstart-guide.md +++ b/doc/alternative-input-quickstart-guide.md @@ -143,15 +143,15 @@ globalKeyStateTracker.keydownEmitter.addListener( event => { ## Keyboard Shortcuts dialog -Add `hasKeyboardHelpContent: true` to Sim constructor options in your main.js. This creates a keyboard button -in the navigation bar, and requires each Screen to provide content for the Keyboard Shortcuts dialog. Pressing -the keyboard button will open the Keyboard Shortcuts dialog. - -To provide content for the Keyboard Shortcuts dialog, add `keyboardHelpNode: {Node}` to constructor options -for each of your Screens. Instructions for creating this -Node are beyond the scope of this guide. Programming by example is recommended, by searching for "keyboardHelpNode". Your content will typically consist of standard descriptions (supported by common code. -e.g. `BasicActionsKeyboardHelpSection`), -plus custom descriptions (for sim-specific hotkeys). Consult with your designer on the content layout. +The Keyboard Shortcuts dialog is accessed by pressing the keyboard button in the navigation bar. +To make this button appear in the navigation bar, add `hasKeyboardHelpContent: true` to the Sim +constructor options in your main.js. + +Each of your screens is then required to provide content for the dialog, via the +`keyboardHelpNode: {Node}` option to the Screen constructor. Instructions for creating this +Node are beyond the scope of this guide. Programming by example is recommended, by searching for "keyboardHelpNode". Your content will typically consist of standard "sections" supported by common code +(e.g. `BasicActionsKeyboardHelpSection`), +plus custom sections for sim-specific hotkeys. Consult with your designer about the content layout. ## Not Supported?