Add ability to report start of paragraphs in braille by nvdaes · Pull Request #16906 · nvaccess/nvda

nvdaes · 2024-07-24T21:04:50Z

Link to issue number:

Summary of the issue:

NVDA should have an option to indicate paragraphs in braille, so that reading, especially books or long pieces of text, can be more comfortable and meaningful.

Description of user facing changes

In the braille settings panel, a new combo box can be used for setting NVDA to show two spaces, a pilcrow or no marker at the start of paragraphs in braille. This requires that the reading by paragraph checkbox is enabled.

Description of development approach

A new option for this feature has been added in the braille section of config.conf.
In config["braille"], a string is assigned to get the startParagraphMarker.
A getParagraphStartMarker function has been added, so that it can be used in different places of braille.py, and in this way we can also make the PILCROW translatable.
In the getFormatFieldBraille function of braille.py: when the isAtStart parameter is True, NVDA will check if it's configured to read by paragraph and if it should present the start paragraph indicator, through the getParagraphStartMarker function.
In the _set_windowEndPos function of braille.py: if the braille wrap word and paragraph start options are enabled, and the start window pos to be set is minor than or equal to the lenghts of paragraph start indicator + 1 (1 corresponding to the text separator), tart pos is set to the start position of the last region if it starts with paragraph start indicator plus text separator. This handles some cases where the paragraph start indicator is not displayed when the braille word wrap is enabled.
The braille settings subpanel has been updated in the gui.
A new ParagraphStartMarker class has been added to configFlags.py

Testing strategy:

Tested manually:

Reading scrolling foreard and backward, and moving forward and backward through paragraphs, the braille display.
Moving backward and forward between paragraph with right and left arrows, and control+down and control + up arrow.
Checking the start position to handle cases where the paragraph start indicator wasn't displayed in braille.
Tested options added in the braille settings panel.

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.

Summary by CodeRabbit

New Features
- Introduced a configuration option to indicate the start of paragraphs in braille for improved accessibility.
- Added a feature in the Braille settings panel that allows users to toggle the visibility of paragraph starts.
Documentation
- Updated user guide to include information on the new Braille settings related to paragraph starts.
- Enhanced user documentation to reflect the impact of paragraph indicators on reading experience and navigation.
Bug Fixes
- Improved logic in braille formatting to better reflect user preferences based on updated configuration settings.

AppVeyorBot · 2024-07-24T21:39:26Z

PASS: Translation comments check.
PASS: License check.
PASS: Unit tests.
FAIL: Lint check. See test results and lint artifacts for more information.
PASS: System tests (tags: installer NVDA).
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/ifwkdpqdd2wclfpb/artifacts/output/nvda_snapshot_pr16906-33027,062c99a0.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 1.2,
INSTALL_END 0.9,
BUILD_START 0.0,
BUILD_END 12.4,
TESTSETUP_START 0.0,
TESTSETUP_END 0.3,
TEST_START 0.0,
TEST_END 18.3,
FINISH_END 0.2

See test results for failed build of commit 062c99a010

nvdaes · 2024-07-25T05:37:57Z

@coderabbitai review

coderabbitai · 2024-07-25T05:38:03Z

Walkthrough

The recent changes introduce a feature in NVDA that allows users to indicate the start of paragraphs in braille when the "reading by paragraph" option is enabled. This functionality enhances accessibility by providing clearer context, making it easier for users who rely on braille output to understand textual structures.

Changes

Files	Change Summary
`source/braille.py`, `source/config/configSpec.py`, `source/gui/settingsDialogs.py`	Added a new constant `PARAGRAPH_START` for paragraph indicators, introduced a configuration flag `showParagraphStart`, and enhanced the Braille settings panel to allow users to enable or disable this feature.
`user_docs/en/changes.md`, `user_docs/en/userGuide.md`	Updated documentation to reflect the new paragraph display feature in braille settings, improving user guidance and experience.

Assessment against linked issues

Objective	Addressed	Explanation
Add option to display paragraph indicators in braille (16895)	✅

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

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.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

coderabbitai

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)

user_docs/en/userGuide.md (1)
2166-2169: Ensure clarity and consistency.

The new section introducing the option to show paragraph starts in Braille settings is clear and concise. However, consider rephrasing for better readability and consistency with the rest of the document.
- If enabled and read by paragraph is checked, two spaces will be displayed to indicate paragraph start.
+ If enabled and "Read by paragraph" is checked, two spaces will be displayed to indicate the start of a paragraph.

CyrilleB79 · 2024-07-25T07:21:09Z


+##### Show paragraphs start {#BrailleSettingsShowParagraphStart}
+
+- If enabled and "Read by paragraph" is checked, two spaces will be displayed to indicate the start of a paragraph.


remove leading dash

Link the "Read by paragraph" option

Suggested change

- If enabled and "Read by paragraph" is checked, two spaces will be displayed to indicate the start of a paragraph.

If enabled and "[Read by paragraph](#BrailleSettingsReadByParagraph)" is checked, two spaces will be displayed to indicate the start of a paragraph.

Moreover, it would be worth rephrasing this paragraph with a bit more details. But I am not familiar with "Read by paragraph" option and will not be able to test on a braille display before next week, so I won't be able to make a detailed suggestion.

Maybe something like the following (to be adapted and polished):
When "Read by paragraph" option is enabled, we face [issueToBeDescribed, e.g. difficulty to identify paragraph start].
Enabling this option enable to mitigate this issue adding two spaces at the beginning of paragraphs.

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

nvdaes · 2024-07-25T08:02:14Z

@CyrilleB79 , thanks for your review. I think I've addressed all your suggestions. Let me know if I should apply any other changes.

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

nvdaes · 2024-07-25T08:25:49Z

@XLTechie , thanks for your review. I've applied your suggestions. Let me know if I should fix other things.

… space" This reverts commit 0d9400b.

…a double space"" This reverts commit 23c017a.

nvdaes · 2024-07-27T01:05:17Z

These days I'm testing this in my daily reading. I've observed that, once, when scrolling down the braille display, two spaces haven't been shown at the start of the paragrahp and I needed to scroll up and down. This may be related to a separate issue, since sometimes the first character is not shown and scrolling up and down is needed. I thought that trying to set two spaces as the paragraph start indicator may fix this issue, but it doesn't work.
Seems its related to word wraping, so I'll mark this PR as a draft and I'll try to work on this.

AppVeyorBot · 2024-07-27T01:35:28Z

PASS: Translation comments check.
PASS: License check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/veywpr5qtnglvvs1/artifacts/output/nvda_snapshot_pr16906-33051,754c7854.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 1.4,
INSTALL_END 1.0,
BUILD_START 0.0,
BUILD_END 12.9,
TESTSETUP_START 0.0,
TESTSETUP_END 0.4,
TEST_START 0.0,
TEST_END 18.5,
FINISH_END 0.2

See test results for failed build of commit 754c785426

…n is enabled

Co-authored-by: Sean Budd <seanbudd123@gmail.com>

AppVeyorBot · 2024-08-01T04:58:30Z

Unable to install NVDA prior to tests.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/u7ujo21jt5cmyx04/artifacts/output/nvda_snapshot_pr16906-33170,535ff1f1.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 1.3,
INSTALL_END 0.9,
BUILD_START 0.0,
BUILD_END 12.3,
TESTSETUP_START 0.0,
FINISH_END 3.2

See test results for failed build of commit 535ff1f155

Co-authored-by: Sean Budd <seanbudd123@gmail.com>

nvdaes · 2024-08-01T07:18:38Z

@seanbudd , many thanks for explaining the reason to make the option about paragraph markers an integer. I didn't realise that s.making pilcrows translatable makes this necessary.
I'll finish and test this properly today, in a few hours.

AppVeyorBot · 2024-08-01T08:35:22Z

Unable to install NVDA prior to tests.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/1rb6cnjjxnt9x7q2/artifacts/output/nvda_snapshot_pr16906-33180,bcbbfd3f.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 1.4,
INSTALL_END 1.0,
BUILD_START 0.0,
BUILD_END 13.3,
TESTSETUP_START 0.0,
FINISH_END 3.2

See test results for failed build of commit bcbbfd3fe1

AppVeyorBot · 2024-08-01T10:08:18Z

Unable to install NVDA prior to tests.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/drtrxwpxxd63ynxn/artifacts/output/nvda_snapshot_pr16906-33186,9c870b2b.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 1.3,
INSTALL_END 1.0,
BUILD_START 0.0,
BUILD_END 13.4,
TESTSETUP_START 0.0,
FINISH_END 3.2

See test results for failed build of commit 9c870b2bc4

AppVeyorBot · 2024-08-01T12:56:48Z

Build (for testing PR): https://ci.appveyor.com/api/buildjobs/8h672pltd26pkhpl/artifacts/output/nvda_snapshot_pr16906-33187,ee5eb7a4.exe
Unable to install NVDA prior to tests.
CI timing (mins):
INIT 0.0,
INSTALL_START 1.4,
INSTALL_END 1.1,
BUILD_START 0.0,
BUILD_END 14.8,
TESTSETUP_START 0.0,
FINISH_END 3.2

See test results for failed build of commit ee5eb7a416

…n braille.py

nvdaes · 2024-08-01T20:35:05Z

@seanbudd , seems that we can not assign a value to PILCROW in the enum class using pgettext or _(). So I've created a new function in braille.py to get the text corresponding to the paragraphStartMarker, and from this functon this can be made translatable.

seanbudd · 2024-08-02T00:02:12Z

+	# Translators: This is a paragraph start marker used in braille.
+	# The default symbol is the pilcrow,
+	# a symbol also known as "paragraph symbol" or "paragraph marker".
+	# This symbol should translate in braille via LibLouis automatically.
+	# If there is a more appropriate character for your locale,
+	# consider overwriting this (e.g. for Ge'ez ፨).
+	# You can also use Unicode Braille such as ⠘⠏.
+	# Ensure this is consistent with other strings with the context "paragraphMarker".


this comment should be deleted now that it has been moved to getParagraphStartMarker

seanbudd · 2024-08-02T00:28:57Z

 		optionsEnum="ReviewRoutingMovesSystemCaretFlag", behaviorOfDefault="NEVER")
 	readByParagraph = boolean(default=false)
-	paragraphStartMarker = option("", " ", "¶", default="")
+	paragraphStartMarker = integer(min=0, max=2, default=0)


this change is no longer necessary if the pilcrow is not translatable

Co-authored-by: Sean Budd <seanbudd123@gmail.com>

nvdaes · 2024-08-02T03:46:06Z

pre-commit.ci run

nvdaes · 2024-08-02T04:26:25Z

@seanbudd , I've addressed your comments. Please let me know if anything else needs to be done.

Add ability to report start of paragraphs in braille

b0c873a

nvdaes added 4 commits July 25, 2024 06:12

Reformat files

ea9d8ad

Improve translators comment

b4becef

Fix help event for show paragrahph start in braille

6a3ee72

Reformat file

4586a5b

coderabbitai Bot reviewed Jul 25, 2024

View reviewed changes

Improve documentation, suggested by coderabbitai

646c35b

nvdaes marked this pull request as ready for review July 25, 2024 06:51

nvdaes requested review from a team as code owners July 25, 2024 06:51

nvdaes requested review from Qchristensen and gerald-hartig July 25, 2024 06:51

CyrilleB79 reviewed Jul 25, 2024

View reviewed changes

nvdaes and others added 3 commits July 25, 2024 09:40

Apply suggestions from code review

3c5be80

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

Apply suggestion from code review

a8cfc6e

Improve user guide, addressing review suggestions

a3f9061

XLTechie suggested changes Jul 25, 2024

View reviewed changes

Comment thread user_docs/en/userGuide.md Outdated

Comment thread user_docs/en/userGuide.md Outdated

Apply suggestions from code review

53c19b1

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

nvdaes added 3 commits July 26, 2024 21:18

Use single space as indicator for paragraphs, to get a double space

0d9400b

Revert "Use single space as indicator for paragraphs, to get a double…

23c017a

… space" This reverts commit 0d9400b.

Revert "Revert "Use single space as indicator for paragraphs, to get …

990c306

…a double space"" This reverts commit 23c017a.

nvdaes marked this pull request as draft July 27, 2024 01:31

Prevent that indicator of paragraphs is kipped if the word wrap optio…

37e2ded

…n is enabled

Apply suggestions from code review

9c5d601

Co-authored-by: Sean Budd <seanbudd123@gmail.com>

seanbudd reviewed Aug 1, 2024

View reviewed changes

Comment thread source/config/configFlags.py Outdated

nvdaes and others added 2 commits August 1, 2024 08:44

Apply suggestions from code review

f7a5229

Co-authored-by: Sean Budd <seanbudd123@gmail.com>

Update source/config/configSpec.py

16de62c

Co-authored-by: Sean Budd <seanbudd123@gmail.com>

nvdaes and others added 5 commits August 1, 2024 10:47

Use paragraph start marker with integer value in config

955a6be

Pre-commit autofix

cc84855

Fix for paragraphStartMarker

3c0ec10

Pre-commit autofix

69ba267

Merge branch 'master' into brailleParagraphs

5a7e57e

Fix paragraphStartMarker in function

a6c1215

Make PILCROW translatable adding a getParagraphStartMarker function i…

a5d351d

…n braille.py

nvdaes marked this pull request as ready for review August 1, 2024 20:32

seanbudd reviewed Aug 2, 2024

View reviewed changes

seanbudd marked this pull request as draft August 2, 2024 00:31

nvdaes and others added 4 commits August 2, 2024 05:07

Update source/braille.py

43f9ee4

Co-authored-by: Sean Budd <seanbudd123@gmail.com>

Apply review suggestions

36e2797

Merge remote-tracking branch 'origin/master' into brailleParagraphs

f3109bc

Pre-commit auto-fix

701ba49

Pre-commit auto-fix

a46c3cd

nvdaes marked this pull request as ready for review August 2, 2024 04:25

seanbudd merged commit fbb7437 into nvaccess:master Aug 2, 2024

nvdaes deleted the brailleParagraphs branch August 2, 2024 05:52


		##### Show paragraphs start {#BrailleSettingsShowParagraphStart}

		- If enabled and "Read by paragraph" is checked, two spaces will be displayed to indicate the start of a paragraph.

	- If enabled and "Read by paragraph" is checked, two spaces will be displayed to indicate the start of a paragraph.
	If enabled and "[Read by paragraph](#BrailleSettingsReadByParagraph)" is checked, two spaces will be displayed to indicate the start of a paragraph.

Uh oh!

Conversation

nvdaes commented Jul 24, 2024 • edited 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:

Summary by CodeRabbit

Summary by CodeRabbit

Uh oh!

AppVeyorBot commented Jul 24, 2024

Uh oh!

nvdaes commented Jul 25, 2024

Uh oh!

coderabbitai Bot commented Jul 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Assessment against linked issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CyrilleB79 Jul 25, 2024

Choose a reason for hiding this comment

Uh oh!

nvdaes commented Jul 25, 2024

Uh oh!

Uh oh!

Uh oh!

nvdaes commented Jul 25, 2024

Uh oh!

nvdaes commented Jul 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AppVeyorBot commented Jul 27, 2024

Uh oh!

Uh oh!

AppVeyorBot commented Aug 1, 2024

Uh oh!

nvdaes commented Aug 1, 2024

Uh oh!

AppVeyorBot commented Aug 1, 2024

Uh oh!

AppVeyorBot commented Aug 1, 2024

Uh oh!

AppVeyorBot commented Aug 1, 2024

Uh oh!

nvdaes commented Aug 1, 2024

Uh oh!

seanbudd Aug 2, 2024

Choose a reason for hiding this comment

Uh oh!

seanbudd Aug 2, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nvdaes commented Aug 2, 2024

Uh oh!

nvdaes commented Aug 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

nvdaes commented Jul 24, 2024 •

edited

Loading

coderabbitai Bot commented Jul 25, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

nvdaes commented Jul 27, 2024 •

edited

Loading