Add ability to speak next and previous lines/paragraphs when navigating with braille by nvdaes · Pull Request #17256 · nvaccess/nvda

nvdaes · 2024-10-07T05:19:24Z

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:

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.

@coderabbitai summary

…ng with braille

…if braille follows speech output

burmancomp · 2024-10-07T16:49:09Z

Fine.

What do you think about setting in braille category?

nvdaes · 2024-10-07T20:26:39Z

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

burmancomp · 2024-10-08T09:00:38Z

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

nvdaes · 2024-10-08T13:24:55Z

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

burmancomp · 2024-10-10T14:20:40Z

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

… brailleNextLine

nvdaes · 2024-10-10T16:26:53Z

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.

burmancomp · 2024-10-10T18:22:20Z

I feel I keep this enabled most of time.

nvdaes · 2024-10-10T18:44:30Z

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

CyrilleB79

Some rewording suggestions; this may be discussed.

…he user guide

Co-authored-by: Cyrille Bougot <cyrille.bougot2@laposte.net>

nvdaes · 2024-10-11T04:26:21Z

Thanks @CyrilleB79 . I've applied your suggestions.

Co-authored-by: Luke Davis <8139760+XLTechie@users.noreply.github.com>

nvdaes · 2024-10-11T05:17:10Z

Thanks @XLTechie . I've applied your suggestion.

LeonarddeR

Great to see this being implemented!

Co-authored-by: Leonard de Ruijter <3049216+LeonarddeR@users.noreply.github.com>

nvdaes · 2024-10-16T11:17:15Z

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

burmancomp · 2024-10-16T16:12:23Z

Appropriate suggestions from @LeonarddeR.

nvdaes · 2024-10-16T17:39:46Z

@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 · 2024-10-16T18:56:21Z

@burmancomp , I'll look at this tomorrow.

SaschaCowley

Thanks @nvdaes, this is looking really good.

Co-authored-by: Sascha Cowley <16543535+SaschaCowley@users.noreply.github.com>

SaschaCowley

Thanks for this good work, @nvdaes

nvdaes · 2024-10-18T05:29:08Z

Thanks for your work and your review, @SaschaCowley .

Qchristensen

Looks good - one suggestion proposed as a way to improve the user guide moving forward

Co-authored-by: Quentin Christensen <quentin@nvaccess.org>

nvdaes · 2024-10-23T08:06:39Z

Thanks @Qchristensen . I've applied your suggestion.

Add ability to speak next and previous lines/paragraphs when navigati…

e0c2634

…ng with braille

nvdaes requested a review from a team as a code owner October 7, 2024 05:19

nvdaes requested a review from SaschaCowley October 7, 2024 05:19

nvdaes marked this pull request as draft October 7, 2024 05:19

nvdaes added 2 commits October 7, 2024 07:26

Ensure that braille next and previous line commands won't speak them …

73be849

…if braille follows speech output

Use cancelSpeech to improve user experience

0a121df

nvdaes and others added 4 commits October 7, 2024 19:16

Add checkbox to speak lines or paragraphs when navigating with braille

7711bc7

Pre-commit auto-fix

fcae90e

Update user guide

7cdcd30

Update changelog

15f34a9

nvdaes marked this pull request as ready for review October 9, 2024 05:36

Merge branch 'brailleNextLine' of https://github.com/nvdaes/nvda into…

750eac1

… brailleNextLine

nvdaes requested a review from a team as a code owner October 10, 2024 16:19

nvdaes requested a review from Qchristensen October 10, 2024 16:19

CyrilleB79 reviewed Oct 10, 2024

View reviewed changes

Comment thread user_docs/en/userGuide.md Outdated

Comment thread source/gui/settingsDialogs.py Outdated

Remove characters word from section about speaking on navigating in t…

515781e

…he user guide

nvdaes marked this pull request as draft October 11, 2024 04:23

nvdaes and others added 2 commits October 11, 2024 06:24

Update source/gui/settingsDialogs.py

03da6d5

Co-authored-by: Cyrille Bougot <cyrille.bougot2@laposte.net>

Update user_docs/en/userGuide.md

f3bd793

Co-authored-by: Cyrille Bougot <cyrille.bougot2@laposte.net>

nvdaes marked this pull request as ready for review October 11, 2024 04:26

XLTechie reviewed Oct 11, 2024

View reviewed changes

Comment thread user_docs/en/userGuide.md Outdated

Update user_docs/en/userGuide.md

f0d358c

Co-authored-by: Luke Davis <8139760+XLTechie@users.noreply.github.com>

LeonarddeR suggested changes Oct 16, 2024

View reviewed changes

Comment thread source/braille.py Outdated

Comment thread source/braille.py Outdated

Comment thread source/braille.py

Comment thread source/braille.py Outdated

Comment thread source/braille.py Outdated

Comment thread source/braille.py Outdated

Apply suggestions from code review

5cc0077

Co-authored-by: Leonard de Ruijter <3049216+LeonarddeR@users.noreply.github.com>

nvdaes marked this pull request as draft October 16, 2024 11:17

Apply review suggestions

138133b

burmancomp reviewed Oct 16, 2024

View reviewed changes

Comment thread source/braille.py Outdated

nvdaes marked this pull request as ready for review October 16, 2024 18:55

nvdaes marked this pull request as draft October 16, 2024 18:56

nvdaes and others added 2 commits October 17, 2024 04:50

Appy review suggestions

55ff0a5

Pre-commit auto-fix

39814e2

seanbudd changed the title ~~Add ability to speak next and previous lines/paragraphs when navigati…~~ Add ability to speak next and previous lines/paragraphs when navigating with braille Oct 17, 2024

nvdaes marked this pull request as ready for review October 17, 2024 04:33

SaschaCowley requested changes Oct 18, 2024

View reviewed changes

Comment thread user_docs/en/changes.md Outdated

Comment thread source/gui/settingsDialogs.py Outdated

Comment thread source/globalCommands.py Outdated

Comment thread source/braille.py

Comment thread source/braille.py Outdated

nvdaes and others added 2 commits October 18, 2024 06:31

Apply suggestions from code review

48e26d9

Co-authored-by: Sascha Cowley <16543535+SaschaCowley@users.noreply.github.com>

Pre-commit auto-fix

39ed1a8

SaschaCowley approved these changes Oct 18, 2024

View reviewed changes

seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Oct 21, 2024

Qchristensen requested changes Oct 23, 2024

View reviewed changes

Comment thread user_docs/en/userGuide.md Outdated

Update user_docs/en/userGuide.md

bccec29

Co-authored-by: Quentin Christensen <quentin@nvaccess.org>

Qchristensen approved these changes Oct 23, 2024

View reviewed changes

seanbudd merged commit 70c41a2 into nvaccess:master Nov 4, 2024

github-actions Bot added this to the 2025.1 milestone Nov 4, 2024

Uh oh!

Conversation

nvdaes commented Oct 7, 2024 • edited by seanbudd Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Link to issue number:

Summary of the issue:

Description of user facing changes

Description of development approach

Testing strategy:

Known issues with pull request:

Code Review Checklist:

Uh oh!

burmancomp commented Oct 7, 2024

Uh oh!

nvdaes commented Oct 7, 2024

Uh oh!

burmancomp commented Oct 8, 2024

Uh oh!

nvdaes commented Oct 8, 2024

Uh oh!

burmancomp commented Oct 10, 2024

Uh oh!

nvdaes commented Oct 10, 2024

Uh oh!

burmancomp commented Oct 10, 2024

Uh oh!

nvdaes commented Oct 10, 2024

Uh oh!

CyrilleB79 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

nvdaes commented Oct 11, 2024

Uh oh!

Uh oh!

nvdaes commented Oct 11, 2024

Uh oh!

LeonarddeR left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nvdaes commented Oct 16, 2024

Uh oh!

burmancomp commented Oct 16, 2024

Uh oh!

nvdaes commented Oct 16, 2024

Uh oh!

Uh oh!

nvdaes commented Oct 16, 2024

Uh oh!

SaschaCowley left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

SaschaCowley left a comment

Choose a reason for hiding this comment

Uh oh!

nvdaes commented Oct 18, 2024

Uh oh!

Qchristensen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nvdaes commented Oct 23, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

nvdaes commented Oct 7, 2024 •

edited by seanbudd

Loading