Skip to content

Split script for reading status bar into two - one for reading and one for moving review cursor into its location#12771

Merged
seanbudd merged 4 commits into
nvaccess:masterfrom
lukaszgo1:I8600
Aug 27, 2021
Merged

Split script for reading status bar into two - one for reading and one for moving review cursor into its location#12771
seanbudd merged 4 commits into
nvaccess:masterfrom
lukaszgo1:I8600

Conversation

@lukaszgo1

@lukaszgo1 lukaszgo1 commented Aug 24, 2021

Copy link
Copy Markdown
Contributor

Link to issue number:

Closes #8600
Implements part of #7314

Summary of the issue:

Currently when reading status bar with NVDA+END review cursor is unconditionally moved to its location. This is inconsistent with all other commands for retrieving information and aside from that is extremely annoying for people working with review cursor now following the caret (I've been in a situation in which I've left review cursor somewhere either because I wanted to monitor a given object for changes, or because I was following some documentation with review cursor in a separate window and wanted to avoid unnecessary alt tabbing and lost my review position because I had to check something on a status bar countless times).

Description of how this pull request fixes the issue:

Review cursor is no longer moved to the location of the status bar. There is a separate script (no gesture assigned by default) which moves review cursor there. As described in #7314 I took this opportunity to split script for reading status bar into a separate ones for reading, spelling and copying.

Testing strategy:

With NVDA+end made sure that first press still reads, second spells and third copies. Made sure that after each of these operations review cursor has not been moved. Tested each of the newly introduced scripts made sure they work. Compiled user guide - ensured it renders as expected.

Known issues with pull request:

None known

Change log entries:

Changes:

  • When reading status bar with NVDA+end review cursor is no longer moved to its location - if you need this functionality please assign a gesture to the appropriate script in the Object Navigation category in the Input gestures dialog.

Code Review Checklist:

  • Pull Request description is up to date.
  • Unit tests.
  • System (end to end) tests.
  • Manual testing.
  • User Documentation.
  • Change log entry.
  • Context sensitive help for GUI changes.
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers

… cursor to its location - create a second command for that
@lukaszgo1 lukaszgo1 marked this pull request as ready for review August 24, 2021 12:25
@lukaszgo1 lukaszgo1 requested review from a team as code owners August 24, 2021 12:25

@seanbudd seanbudd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks @lukaszgo1, LGTM, just added some changes to make the formatting more consistent.

What are your thoughts on binding the "move cursor to location" script to pressing the keys a forth time? I think it overloads the input gesture but if there is an argument to preserve the current behaviour somehow it might be helpful.

Comment thread source/globalCommands.py Outdated
Comment thread source/globalCommands.py Outdated
Comment thread source/globalCommands.py Outdated
Comment thread user_docs/en/userGuide.t2t Outdated
Co-authored-by: Sean Budd <seanbudd123@gmail.com>
@lukaszgo1

Copy link
Copy Markdown
Contributor Author

Thanks @lukaszgo1, LGTM, just added some changes to make the formatting more consistent.

Thanks for these - applied now.

What are your thoughts on binding the "move cursor to location" script to pressing the keys a forth time? I think it overloads the input gesture but if there is an argument to preserve the current behaviour somehow it might be helpful.

For scripts in general I agree that would be a good idea but not in this specific case since third press of that command copies to the clipboard potentialy overwriting whatever was there before. That forces users to be very conscious and use the forth press only when content of the clipboard is not important to them. I would prefer not to introduce this level of complexity.

@lukaszgo1

Copy link
Copy Markdown
Contributor Author

@Qchristensen Since this change is similar to the one I did in #10973 would you be able to comment about eventual impact to the NVDA's training material / certification?

@Qchristensen Qchristensen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Changes to the user guide at least look fine, good work!

@lukaszgo1 Thanks for thinking of the training material! The change doesn't cause any immediate issues, the training material covers using the keystroke to read the status bar, but doesn't mention what it does with the review cursor. As most users would assume it doesn't move the review cursor, this change actually lessons the need for specifically needing to cover that.

It would be worth mentioning the new command and the ability to press this more than once and I've made a note to look at that, thanks!

@seanbudd seanbudd merged commit 4ab4d35 into nvaccess:master Aug 27, 2021
@nvaccessAuto nvaccessAuto added this to the 2021.3 milestone Aug 27, 2021
@lukaszgo1 lukaszgo1 deleted the I8600 branch August 30, 2021 16:17
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.

Split reportstatusline script in to two, one for reading and one for moving navigator object into it

4 participants