Skip to content

Allow to use find next and find previous commands during say all.#11564

Merged
feerrenrut merged 7 commits into
nvaccess:masterfrom
CyrilleB79:skimReadingWithFindCmd
Sep 11, 2020
Merged

Allow to use find next and find previous commands during say all.#11564
feerrenrut merged 7 commits into
nvaccess:masterfrom
CyrilleB79:skimReadingWithFindCmd

Conversation

@CyrilleB79

@CyrilleB79 CyrilleB79 commented Sep 4, 2020

Copy link
Copy Markdown
Contributor

Link to issue number:

Fixes #11563

Summary of the issue:

In browse mode, the find next/previous commands stop text reading if executed during say all. Since these commands move the caret and read the line at the new position, this would make sense that they do not interrupt say all.

Description of how this pull request fixes the issue:

  • specified "resumeSayAllMode" for findNext and findPrevious scripts.
  • adapt doFindText with an extra argument specifiying if sayAll should resume.
  • also converted the 2 modified scripts to the new way to write scripts with script decorator.

Testing performed:

  • Tested that findNext and findPrevious do not interrupt sayAll if skim reading option is enabled.
  • Tested that findNext and findPrevious work as before if skim reading option is disabled.
  • Test that help mode on these 2 scripts still announce their function.

Known issues with pull request:

None

Change log entry:

Section: Changes

When reading with say all in browse mode, the find next and find previous commands do not stop reading anymore if Allow skim reading option is enabled; say all rather resumes from after the next or previous found term. (#11563)

@AppVeyorBot

This comment has been minimized.

@lukaszgo1

This comment has been minimized.

@AppVeyorBot

This comment has been minimized.

@CyrilleB79

This comment has been minimized.

Comment thread source/cursorManager.py
@CyrilleB79

This comment has been minimized.

@AppVeyorBot

This comment has been minimized.

@AppVeyorBot

This comment has been minimized.

@feerrenrut

Copy link
Copy Markdown
Contributor

Generally this looks ok to me, but what isn't clear on the issue, or in the changes string, is where the say all should resume from. Should users expect say-all to resume speaking the content prior to the interruption, or continue speaking text after the found term?

@CyrilleB79

Copy link
Copy Markdown
Contributor Author

@feerrenrut thanks for review.

You wrote:

Generally this looks ok to me, but what isn't clear on the issue, or in the changes string, is where the say all should resume from. Should users expect say-all to resume speaking the content prior to the interruption, or continue speaking text after the found term?

Say all continues reading after the found term. This seemed obvious to me... but it seems it was not the case for all.
I have updated the corresponding issue (#11563) with more details in actual result and expected result.

I will also modify the change log item. Would the change log item be clearer as follow?

`When reading with say all in browse mode, the find next and find previous commands do not interrupt reading anymore if Allow skim reading option is enabled; say all rather resumes from the next or previous found term. (#11563)

It's a bit long, and maybe my English formulation is not so good. Any more concise proposal is welcome.
When the formulation is confirmed, I will update the initial description of this PR with the new proposal for change log.

@feerrenrut

Copy link
Copy Markdown
Contributor

Thanks for confirming, this is what I expected it to do also, but you never know! The change log entry looks good to me. Better slightly verbose than not clear.

I don't seem to be able to get this to work with a laptop keyboard layout. It worked as expected with desktop layout.

@feerrenrut

Copy link
Copy Markdown
Contributor

Ah, it does work with laptop layout, but I used the wrong say-all command:

Name Desktop key Laptop key Touch Description
Say all with review numpadPlus NVDA+shift+a 3-finger flick down (text mode) Reads from the current position of the review cursor, moving it as it goes

I don't think this should hold back this PR, but it would be good to have at least an issue open to document it. Would you be interested in investigating whether making this work during say all with review makes sense?

@feerrenrut feerrenrut left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @CyrilleB79

@feerrenrut feerrenrut merged commit 864ff77 into nvaccess:master Sep 11, 2020
@nvaccessAuto nvaccessAuto added this to the 2020.4 milestone Sep 11, 2020
@CyrilleB79

Copy link
Copy Markdown
Contributor Author

Ah, it does work with laptop layout, but I used the wrong say-all command:
Name Desktop key Laptop key Touch Description
Say all with review numpadPlus NVDA+shift+a 3-finger flick down (text mode) Reads from the current position of the review cursor, moving it as it goes

I don't think this should hold back this PR, but it would be good to have at least an issue open to document it. Would you be interested in investigating whether making this work during say all with review makes sense?

No this presently do not make sense. Indeed, the Find command applies to virtual cursor (as quick jump key), not to review cursor. If one day there is a search function using the review cursor in NVDA, this behavior may be replicated in the case of say all with review cursor.
I do not know however if such a feature would be very useful. But I am not the best person to judge of it since I usually work review cursor tethered to system cursor.

@lukaszgo1, I think you usually work with both cursors separately. Could you comment further if required and open an issue describing the need if you feel it applicable?

@lukaszgo1

Copy link
Copy Markdown
Contributor

No this presently do not make sense. Indeed, the Find command applies to virtual cursor (as quick jump key), not to review cursor. If one day there is a search function using the review cursor in NVDA, this behavior may be replicated in the case of say all with review cursor.
I do not know however if such a feature would be very useful. But I am not the best person to judge of it since I usually work review cursor tethered to system cursor.

@lukaszgo1, I think you usually work with both cursors separately. Could you comment further if required and open an issue describing the need if you feel it applicable?

Having find command working with the review cursor might be useful in some cases and it is something which I intent to implement one day if time permits (see #7855). When this is implemented we can reconsider, but I personally don't use say all with review at all so it is unlikely I'll be interested in pursuing this further.

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.

Say all is interrupted when using find next/previous commands

5 participants