nvda icon indicating copy to clipboard operation
nvda copied to clipboard

Add ability to speak next and previous lines/paragraphs when navigating with braille

Open nvdaes opened this issue 1 year ago • 15 comments

Link to issue number:

Fixes #17053

Summary of the issue:

Sometimes, it may be desirable tohear lines when navigating with braille.

Description of user facing changes

  • A new command, not assigned to gestures, is available in the braille category to toggle speaking of lines/paragraphs when navigating with braille, to enable or disable this feature. A new checkbox for this has been added in the braille settings panel as well.

Description of development approach

  • A new key for this feature has been added to configSpec.py. The value is a boolean (False by default).
  • A new script has been added to globalCommands.py.
  • A new function has been added to braille.py, to be used by next and previousLine functions, also modified so that info is expanded to the corresponding read unit, i.e., line or paragraph.
  • The braille settings panel has a new checkbox to toggle this feature.

Testing strategy:

Tested manually in Notepad and Window console, with braille following caret, review cursor and automatic modes. Also, checked that indentation is reported when reading by lines, not by paragraphs, as expected when unit is specified for speakTextInfo function.

Known issues with pull request:

None.

Code Review Checklist:

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

@coderabbitai summary

nvdaes avatar Oct 07 '24 05:10 nvdaes

Fine.

What do you think about setting in braille category?

burmancomp avatar Oct 07 '24 16:10 burmancomp

@burmancomp , feel free to test this again. I've added cancelSpeech() before speaking line or paragraph, and a checkbox in the braille settings panel.

nvdaes avatar Oct 07 '24 20:10 nvdaes

It should work, thanks! Changelog and user guide entries, and then ready for review I think.

burmancomp avatar Oct 08 '24 09:10 burmancomp

I updated the changelog and user guide. I'll test once more and then I'll request a review from NV Access.

nvdaes avatar Oct 08 '24 13:10 nvdaes

I feel that changelog.md and userGuide.md are missing.

burmancomp avatar Oct 10 '24 14:10 burmancomp

I feel that changelog.md and userGuide.md are missing.

Thanks @burmancomp . I've pushed changes correctly now and this should be fixed and ready for review.

nvdaes avatar Oct 10 '24 16:10 nvdaes

I feel I keep this enabled most of time.

burmancomp avatar Oct 10 '24 18:10 burmancomp

@burmancomp , happy to see that this is useful for you.

nvdaes avatar Oct 10 '24 18:10 nvdaes

Thanks @CyrilleB79 . I've applied your suggestions.

nvdaes avatar Oct 11 '24 04:10 nvdaes

Thanks @XLTechie . I've applied your suggestion.

nvdaes avatar Oct 11 '24 05:10 nvdaes

Thanks @LeonarddeR for your review. I'll mark this as a draft and I'll work on this later.

nvdaes avatar Oct 16 '24 11:10 nvdaes

Appropriate suggestions from @LeonarddeR.

burmancomp avatar Oct 16 '24 16:10 burmancomp

@LeonarddeR , I think that I've addressed all your comments. I don't have if you can review this again, so I'll mark this as ready for review in case NV Access wants to do it.

nvdaes avatar Oct 16 '24 17:10 nvdaes

@burmancomp , I'll look at this tomorrow.

nvdaes avatar Oct 16 '24 18:10 nvdaes

Thanks for your work and your review, @SaschaCowley .

nvdaes avatar Oct 18 '24 05:10 nvdaes

Thanks @Qchristensen . I've applied your suggestion.

nvdaes avatar Oct 23 '24 08:10 nvdaes