Add ability to speak character when cursor routing

[korbit-ai]

Link to issue number:

Closes #8072

Summary of the issue:

When cursor routing, it can sometimes be handy if speech follows along and tells you what character you moved to, especially when the character in braille is unknown to you.

Description of user facing changes

• Added a new braille option "Speak character when routing cursor in text", disabled by default. When enabled, NVDA will speak the character you routed to after a cursor routing action.

Description of development approach

Added a new option to the config spec, as well as a function to braille to speak the character at the given position. Also added an item to the settings panel as well as an unbound global command.

Testing strategy:

• Tested that NVDA will speak the character ath the cursor when routing when the option is on
• Tested that NVDA won't speak the character ath the cursor when routing when the option is off
• Tested that the global command (when bound) appropriately toggles the option

Known issues with pull request:

None known

Code Review Checklist:

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

Summary by CodeRabbit

• New Features

  • Introduced a setting to automatically speak the character at the cursor during braille cursor routing, enhancing auditory feedback for improved accessibility.
  • Added a checkbox in settings for users to enable or disable the new speech feature.
  • Implemented a toggle command for the speech feature in braille mode.

• Documentation

  • Updated user guide to include instructions for the new braille speech feature and customization options.
  • Added notes in the change log regarding default settings and operational benefits for users.

• Bug Fixes

  • Enhanced configuration management for better user interaction with the new settings.

Description by Korbit AI

What change is being made?

Add the ability to speak the character at the cursor position when performing a braille cursor routing action.

Why are these changes being made?

This feature enhances accessibility by providing auditory feedback for users who rely on braille displays, helping them confirm the cursor's position. The option is disabled by default and can be enabled in the braille settings.

[korbit-ai]

Clone of the PR nvaccess/nvda#16947

[korbit-ai]

My review is in progress 📖 - I will have feedback for you in a few minutes!

[coderabbitai]

Warning

Rate limit exceeded

@codiumai-pr-agent[bot] has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 49 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 5ecc243 and 89cfa48.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[korbit-ai]

I have reviewed your code and did not find any issues!

---

Please note that I can make mistakes, and you should still encourage your team to review your code as well.

[furwellness]

/review

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 PR contains tests

🔒 No security concerns identified

⚡ Key issues to review Performance Concern The _speakOnRouting function is called on every cursor routing action, even when the feature is disabled. Consider moving the config check to the caller. Typo There's a typo in the label for the new checkbox. "Spea&k" should be "Speak". Typo There's a typo in the changelog entry. "ath" should be "at".