Skip to content

Baum braille driver: provide more mappings for common keyboard commands #14714

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

Merged
merged 3 commits into from
Mar 23, 2023

Conversation

michaelDCurran
Copy link
Member

Link to issue number:

None

Summary of the issue:

The Baum braille driver does not provide mappings for several common keyboard commands like other Braille drivers do. Examples being windows+d, tab, shift+tab etc.

Description of changes

As requested by Orbit for the Baum braille driver, Add several Braille gestures mapped to common keyboard commands

  • shift+tab key | space+dot1+dot3 |
  • tab key | space+dot4+dot6 |
  • alt key | space+dot1+dot3+dot4 (space+m) |
  • escape key | space+dot1+dot5 (space+e) |
  • windows key | space+dot3+dot4 |
  • alt+tab key | space+dot2+dot3+dot4+dot5 (space+t) |
  • NVDA Menu | space+dot1+dot3+dot4+dot5 (space+n) |
  • windows+d key (minimize all applications) | space+dot1+dot4+dot5 (space+d) |
  • Say all | space+dot1+dot2+dot3+dot4+dot5+dot6 |

Testing strategy:

  • Connected to the Orbit Reader 40 in Orbit (Baum) mode.
    Enabled NVDA input help with NVDA+1
    Pressed each of the braille gestures listed above, and ensured the correct keyboard gesture was emulated.

Known issues with pull request:

None known.

Change log entries:

New features
Changes

  • Baum Braille driver: addes several Braille chord gestures for performing common keyboard commands such as windows+d, alt+tab etc. Please refer to the NVDA user guide for a full list.
    Bug fixes
    For Developers

Code Review Checklist:

  • Pull Request description:
    • description is up to date
    • change log entries
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • API is compatible with existing add-ons.
  • Documentation:
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • Security precautions taken.

…eyboard gestures:

- shift+tab key | space+dot1+dot3
- tab key | space+dot4+dot6
- alt key | space+dot1+dot3+dot4 (space+m)
- escape key | space+dot1+dot5 (space+e)
- windows key | space+dot3+dot4
- alt+tab key | space+dot2+dot3+dot4+dot5 (space+t)
- NVDA Menu | space+dot1+dot3+dot4+dot5 (space+n)
- windows+d key (minimize all applications) | space+dot1+dot4+dot5 (space+d)
- Say all | space+dot1+dot2+dot3+dot4+dot5+dot6
@michaelDCurran michaelDCurran requested review from a team as code owners March 11, 2023 05:49
| alt key | space+dot1+dot3+dot4 (space+m) |
| escape key | space+dot1+dot5 (space+e) |
| windows key | space+dot3+dot4 |
| alt+tab key | space+dot2+dot3+dot4+dot5 (space+t) |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could the keys be wrapped in monospace formatting?

Suggested change
| alt+tab key | space+dot2+dot3+dot4+dot5 (space+t) |
| ``alt+tab`` key | ``space+dot2+dot3+dot4+dot5`` (``space+t``) |

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems to me that many of these gesture tables don't markup the keys like that yet. I'm unclear as to whether it should be done for script names as well? E.g. "scroll forward"?
Perhaps this could be done as a separate pr that goes through the user guide as a whole, as it will make the diff harder to read if I go through and doo the entire table here...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The userGuide standards only suggest doing this for key commands https://github.com/nvaccess/nvda/blob/master/devDocs/userGuideStandards.md

@michaelDCurran michaelDCurran merged commit facb2d9 into master Mar 23, 2023
@michaelDCurran michaelDCurran deleted the baumGestures branch March 23, 2023 07:32
@nvaccessAuto nvaccessAuto added this to the 2023.2 milestone Mar 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants