Add an "on-demand" speech mode #15804

CyrilleB79 · 2023-11-19T23:17:33Z

Link to issue number:

Closes #481

Summary of the issue:

In some situations, e.g. meetings or when an alternative information channel (braille, visual with magnification), the user does not want NVDA to provide speech feedback on actions such as moving the cursor or focus. But they still want to have NVDA speaking on specific request.

Description of user facing changes

Add a new speech "on demand" mode in the NVDA+S toggle command. When speech on demand is selected, NVDA does not provide a speech feedback for actions, but still speak on explicit request.

The criterion to determine if a command should speak in "on demand" mode is:

if the command is mainly to perform an action and the speech is only a feedback after this action, NVDA does not speak. Said otherwise, this command could have a usefulness when used blindly without any speech (or braille or visual) feedback
if the goal command is mainly to provide information without performing any other action, NVDA speaks.

Note: although say all commands move the cursor, they are speaking in the "on demand" mode since there is no point running them if speech is totally off.

Description of development approach

Added a new speech mode
Added a new "speakOnDemand" parameter for the script decorator to indicate which script should speak in this mode.
In documentBase.py, do not use script decorator as per Adding commands to jump to first/last row/column in tables #13435 (comment)

Notes for reviewers

Regarding UX, was it a good solution to add a fourth speech mode? There is already an add-on to remove the beep mode from the speech mode toggle command...
For documentation, what should be the correct name to use? "speech on demand", "speak on demand", etc. Also, speak or talk? @XLTechie would you mind review documentation (change log, user guide, command description)?
Do I need to include an API change item when extending the speech mode enum?

Testing strategy:

Manual tests of the modified scripts to support "on demand" mode:

All the say all scripts (caret, review, foreground window, row and column)
Most of the other modified scripts in global commands (all those having a default shortcut)
Word with and without UIA, Excel, poedit
Tested miranda32 and vipmud with a fake test renaming an executable since I have not these applications.

Foobar not tested.

Tested other scripts to check that they do not speak in "on demand" mode.

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.

AppVeyorBot · 2023-11-20T00:18:12Z

PASS: Translation comments check.
PASS: Unit tests.
FAIL: Lint check. See test results for more information.
PASS: System tests (tags: installer NVDA).
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/93dqrxc8330apkww/artifacts/output/nvda_snapshot_pr15804-29976,15f0b897.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.9,
INSTALL_END 1.0,
BUILD_START 0.0,
BUILD_END 26.1,
TESTSETUP_START 0.0,
TESTSETUP_END 0.3,
TEST_START 0.0,
TEST_END 16.8,
FINISH_END 0.2

See test results for failed build of commit 15f0b897a9

Adriani90 · 2023-11-20T04:52:33Z

Great work on this! Really highly appreciated. Does include also application specific commands like changing formating in Ms Office etc.? These should be reported as well in my view.
Also such commands like changing nvda settings might be worthy to consider.
The beep mode by the way is very useful, especially when you work with 2 sessions of Nvda one on a local and one on a virtual machine, especially when it is not allowed to use the remote addon due to restrictions via security policies.
Naming this mode speech on demand totally makes sense, because it is consistent with other speech modes already in place.

Adriani90 · 2023-11-20T05:11:11Z

In my view say all could be implemented on a later stage, if the users demand it. It should not prevent this PR from being merged.
But how should we handle reporting commands introduced by addons such as Windows magnifier addon? It would maybe make sense to include all commands which contain the nvda key except for the ones used for moving system focus, carret, review cursor, virtual cursor and mouse cursor. This includes also commands for navigation such as object navigation and review, jumping to last rows or columns in tables etc. or such commands for navigations introduced by addons such as golden cursor or objnav.
So maybe there could be a condition be implemented where NVDA looks for the movements of these cursors and then speech is not fired. Might be more efficient than the command by command implementation.

LeonarddeR · 2023-11-20T06:26:24Z

* Regarding UX, was it a good solution to add a fourth speech mode? There is already an add-on to remove the beep mode from the speech mode toggle command...

Could the speech modes be made opt out, at least the beeps and on demant modes? That would make the no beeps mode add-on obsolete, but I think that would be the best solution.

CyrilleB79 · 2023-11-20T08:13:47Z

Thanks @LeonarddeR and @Adriani90

Answering to all:

Does include also application specific commands like changing formating in Ms Office etc.? These should be reported as well in my view.

If you are speaking about Office commands such as toggle bold (control+U), toggle italic (control+I), etc., they are not reported in "on demand" mode. Indeed these scripts perform an action. In the "on demand" mode however, only the script whose goal is to report an information are speaking. The scripts that perform an action indeed do not speak. The use case is the following. You are in a meeting so you do not want NVDA to speak when you write notes in Word. Thus NVDA does not speak when you type or when you change formatting (bold, etc.) so that you can perform these actions without being bothered by NVDA speech. If you explicitly want to know font formatting, you still can request it with NVDA+F. The same way, the time command (NVDA+F12) speaks because you have no reason to press this command without any speech feedback.
To summarize, the commands that speak in the "on demand" mode are those that would be useless when speech is muted and with no braille.

Also such commands like changing nvda settings might be worthy to consider.

For the same reason as before, they are not included, because you may want to toggle a parameter without being bothered by a speech feedback.

The beep mode by the way is very useful, especially when you work with 2 sessions of Nvda one on a local and one on a virtual machine, especially when it is not allowed to use the remote addon due to restrictions via security policies.

I do not contest the usefulness of the beep mode for some users. I was just worrying of the increasing number of speech mode, when the vast majority of users will use only two of them: normal speech and either off or "on demand".

Naming this mode speech on demand totally makes sense, because it is consistent with other speech modes already in place.

OK thanks for the positive feedback.

In my view say all could be implemented on a later stage, if the users demand it. It should not prevent this PR from being merged.

Agree with this plan if NV Access also agrees since this PR is already an improvement. Still, I will try to investigate the say all issue in the next days.

But how should we handle reporting commands introduced by addons such as Windows magnifier addon?

In the specific case of Windows Magnifier add-on, all the commands speak after an associated action, e.g. move something, change a setting, etc. Thus they should be muted in the "on demand" mode.

More generally however, the add-on authors may use the "speakOnDemand" parameter of the script decorator to indicate if their scripts should speak when speech mode is "on demand".

It would maybe make sense to include all commands which contain the nvda key except for the ones used for moving system focus, carret, review cursor, virtual cursor and mouse cursor. This includes also commands for navigation such as object navigation and review, jumping to last rows or columns in tables etc. or such commands for navigations introduced by addons such as golden cursor or objnav. So maybe there could be a condition be implemented where NVDA looks for the movements of these cursors and then speech is not fired. Might be more efficient than the command by command implementation.

The use or not of NVDA key is and should not be a criterion since keys could be reassigned.

More generally, you seem to have an idea of something more verbose than I regarding the "speech on demand" mode. The mode as I have implemented it seems to match more or less the one in Jaws; thus, I imagine (since it is not so new), that the use case has been confirmed among users. If there is a need though, we may imagine different levels of verbosity for the "on demand" mode. To define a different verbosity, please provide a concrete use case as well as a precise criterion to determine if a given command (script) should speak or not.

* Regarding UX, was it a good solution to add a fourth speech mode? There is already an add-on to remove the beep mode from the speech mode toggle command...
Could the speech modes be made opt out, at least the beeps and on demant modes? That would make the no beeps mode add-on obsolete, but I think that would be the best solution.

Technically, all can be done. I am asking from a UX point of view. Is it better to add a new GUI control so that people can choose which speech mode is available in NVDA+S command? Or is it just cluttering the GUI with a parameter considered obscure for most users? In the latter case, the "no beep speech mode" add-on could be improved to provide this feature for those who need it (cc @ABuffEr).

XLTechie · 2023-11-20T08:37:58Z

Thanks for this work @CyrilleB79. I will review the specifics on Monday or Tuesday, depending on time. I would like to say that I agree with @LeonarddeR. Some checkboxes in the speech category to hide beeps mode, and to hide on-demand speech mode, both unchecked by default. Doing that, makes including these in speech modes to be reasonable. Which is where I think they should be. Given how many people desired the no beeps mode add-on over the years, making a checkbox for this finally does seem warranted, though I personally love beeps mode.

CyrilleB79 · 2023-11-20T10:31:33Z

I have just added say all scripts and input help in the "on demand" mode and updated the dev doc. And I have updated the initial description according to these last changes and also included relevant information from our discussion.

Regarding a configuration to filter the speech modes available in NVDA+S loop, I prefer to wait for NV Access review before implementing something. I am not totally convinced that it's the best way to handle the "too many speech modes" issue.
As an alternative, we can also merge this PR as is and think to the number of speech modes in NVDA+S while it is tested in alpha since a solution can easily be merged later in alpha cycle (or even after 2024.1) so that we get more feedback.

ABuffEr · 2023-11-20T11:53:59Z

Hi,
about UX, I agree to have two checkbox, like "Include beeps in speech modes" and "Include on-demand in speech modes"; about checked status, maybe it'll be better both checked, to warn users about all actually available modes.
Anyway, I'll be absolutely happy to pension NoBeepsSpeechMode 😁

source/appModules/miranda32.py

source/appModules/vipmud.py

source/scriptHandler.py

source/speech/speech.py

LeonarddeR · 2023-11-20T20:06:27Z

I would personally go for a checkable list, similar to the NVDA modifier keys list.

lukaszgo1 · 2023-11-20T21:31:50Z

I have created #15806 to discuss configurability of speech modes switching.

Adriani90 · 2023-11-20T21:34:56Z

we may imagine different levels of verbosity for the "on demand" mode.

I think this might indeed make things to complicated. My use case was not really well developped yet in my mind, I think your approach suits better as it is. I guess if users need more commands to speak in on demand mode, then this can be implemented later on.

I would personally go for a checkable list, similar to the NVDA modifier keys list.

I like this idea as well. The less we have to tab through dialogs, the better. :-) However, there is a risk with these checkboxes: imagine a new user disables by accident the speech mode speak and presses nvda+s afterwards, NVDA would change to one of the less verbose or no verbose modes. There is no way of enabling the speak mode again unless you know the menu structure by hard or you use on demand mode to report the currently focused object with a command to include speech mode speak again into the nvda+s command but this does not feel intuitive.

Another better alternative in my view would be to let both speech mode speak and speech mode off as they are, and include also a speech mode category in the synth settings ring which contains all 4 speech modes. Then, in case you enable speech mode on demand, beeps or off from the synth settings ring, pressing nvda+s switches to speech mode speak again. So speech mode speak has always priority when pressing nvda+s.

Adriani90 · 2023-11-20T21:39:49Z

Ofcourse my proposal would mean we have to enhance the synth settings ring to a speech and synth settings ring but this would improve things anyway.

codeofdusk · 2023-11-22T11:51:39Z

Other than some question as to whether it should be "on-demand" instead of "on demand"

"on demand"

CyrilleB79 · 2023-11-22T22:09:40Z

In the end, I have added a paragraph in section 4 of the User Guide. Not in section 12 since section 12 describes the GUI (menus and dialogs) whereas this option is not configurable through dialogs.

Since the description of each mode is now in the User Guide, I have shortened the input help which was way too long: I have removed the descriptions of each speech mode from input help. @XLTechie, I have taken into account your review on the input help to write the paragraph in the User Guide.

seanbudd

Thanks @CyrilleB79

seanbudd · 2023-11-22T23:14:39Z

user_docs/en/userGuide.t2t

+* Talk: NVDA will just speak normally. This is the default speech mode.
+* On-demand: NVDA will only speak when calling commands whose goal is to speak an information (e.g. report the title of the window); but it will not speak in reaction to actions such as moving the focus or the cursor.
+* Off: NVDA will not speak anything. 
+* Beeps: NVDA will replace normal speech with quiet beeps.


I believe these lists also need a terminator. Is there a reason * was used over -?

Suggested change

* Beeps: NVDA will replace normal speech with quiet beeps.

* Beeps: NVDA will replace normal speech with quiet beeps.

*

Thanks for the formatting fix. No reason to use * instead of -. I'll change it.

seanbudd · 2023-11-22T23:14:40Z

user_docs/en/userGuide.t2t

+* Talk: NVDA will just speak normally. This is the default speech mode.
+* On-demand: NVDA will only speak when calling commands whose goal is to speak an information (e.g. report the title of the window); but it will not speak in reaction to actions such as moving the focus or the cursor.
+* Off: NVDA will not speak anything. 
+* Beeps: NVDA will replace normal speech with quiet beeps.


I believe these lists also need a terminator. Is there a reason * was used over -?

Suggested change

* Beeps: NVDA will replace normal speech with quiet beeps.

* Beeps: NVDA will replace normal speech with quiet beeps.

*

seanbudd · 2023-11-22T23:14:59Z

user_docs/en/userGuide.t2t

+* Off: NVDA will not speak anything. 
+* Beeps: NVDA will replace normal speech with quiet beeps.
+
+A gesture allows to cycle through the various speech modes:


Suggested change

A gesture allows to cycle through the various speech modes:

A gesture allows cycling through the various speech modes:

XLTechie

I'm pretty sure this command should no longer be called a toggle. You can't toggle between multiple options, not in the normal usage of that word (N.B. I am aware of three position toggle switches, but that's not how people normally understand it, I think).

XLTechie · 2023-11-23T01:08:35Z

source/globalCommands.py

@@ -2008,18 +2023,15 @@ def script_review_currentSymbol(self,gesture):
 	@script(
 		description=_(
 			# Translators: Input help mode message for toggle speech mode command.


Shouldn't this now be "cycle speech modes command", or "Switch to next speech mode command"? It is no longer a toggle.

Suggested change

# Translators: Input help mode message for toggle speech mode command.

# Translators: Input help mode message for switch to next speech mode command.

XLTechie · 2023-11-23T01:16:40Z

source/globalCommands.py

-			"When set to off NVDA will not speak anything. "
-			"If beeps then NVDA will simply beep each time it its supposed to speak something. "
-			"If talk then NVDA will just speak normally."
+			"Toggles between the speech modes of off, beep, talk and on-demand."
 		),
 		category=SCRCAT_SPEECH,
 		gesture="kb:NVDA+s"
 	)
 	def script_speechMode(self,gesture):


Can this be linted?

XLTechie · 2023-11-23T01:33:16Z

user_docs/en/changes.t2t

@@ -10,6 +10,8 @@ What's New in NVDA
 - Added support for Bluetooth Low Energy HID Braille displays. (#15470)
 - The Add-on Store now supports installing add-ons in bulk by selecting multiple add-ons. (#15350)
 - From the add-on store, it's possible to open a dedicated webpage to see or provide feedback about the selected add-on. (#15576, @nvdaes)
+- A new "on-demand" speech mode has been added.
+When speech is on-demand, NVDA does not speak automatically (e.g. when moving the cursor) but still speaks when calling commands whose goal is explicitly to report something (e.g. report window title). (#481, @CyrilleB79)


Should this be referencing the issue number or the PR number?

I have put the issue number as it is usually done. If you see a good reason to use the PR number here instead, please let it know.
In any case, someone who want to find the PR will find the reference in the issue.

XLTechie · 2023-11-23T01:46:21Z

user_docs/en/userGuide.t2t

+
+There are four speech modes available.
+* Talk: NVDA will just speak normally. This is the default speech mode.
+* On-demand: NVDA will only speak when calling commands whose goal is to speak an information (e.g. report the title of the window); but it will not speak in reaction to actions such as moving the focus or the cursor.


Since I suspect you will change this to a hyphenated list, I have used that in the below to make it easy to apply my suggestion if you otherwise like it.

I have removed "an information" because "information" is plural in English. I have replaced "calling" (which is often understood in technical circles but may not be how users think of command use), with a more user friendly term.
Lastly, I have added some further clarification about what this mode does.

Suggested change

* On-demand: NVDA will only speak when calling commands whose goal is to speak an information (e.g. report the title of the window); but it will not speak in reaction to actions such as moving the focus or the cursor.

- On-demand: NVDA will only speak when you use commands which speak information (e.g. report the title of the window); but it will not speak in reaction to actions such as moving the focus or the cursor; and will not speak any screen changes, notifications, etc.

I'll take this comment into account. But I want to keep the idea that the goal of the command is to report information. Writing "a command which speaks information" is too broad in my view.

XLTechie · 2023-11-23T01:55:44Z

user_docs/en/userGuide.t2t

+* Talk: NVDA will just speak normally. This is the default speech mode.
+* On-demand: NVDA will only speak when calling commands whose goal is to speak an information (e.g. report the title of the window); but it will not speak in reaction to actions such as moving the focus or the cursor.
+* Off: NVDA will not speak anything. 
+* Beeps: NVDA will replace normal speech with quiet beeps.


I know "quiet" was my word, but it was a mistake.
Also, I have added some explanatory paragraphs about beeps and on-demand modes, since people are always asking what beeps mode is good for.
Lastly, I have used a hyphen for the list marker, and closed the list, since I think you will likely replace the stars used on the other items.

Suggested change

* Beeps: NVDA will replace normal speech with quiet beeps.

- Beeps: NVDA will replace normal speech with short beeps.

-

Beeps mode may be useful when some very verbose output is scrolling in a terminal window, but you don't care what it is, only that it is continuing to scroll; or in other circumstances when the fact that there is output is more relevant than the output itself.

The on-demand mode may be valuable when you don't need constant feedback about what is happening on screen or on the computer, but you periodically need to check particular things using review commands, etc.

Examples include while recording audio, when using screen magnification, or as an alternative to beeps mode.

Thanks. I'll include it and add one more example: during a meeting or a call.

XLTechie · 2023-11-23T01:57:47Z

user_docs/en/userGuide.t2t

@@ -4049,7 +4062,7 @@ Please see the display's documentation for descriptions of where these keys can
 | Route to braille cell | ``routing`` |
 | Report text formatting under braille cell | ``secondary routing`` |
 | Toggle the way context information is presented in braille | ``attribute1+attribute3`` |
-| Toggles between the speech modes of off, beep and talk | ``attribute2+attribute4`` |
+| Toggles between the speech modes of off, beep, speech and on-demand | ``attribute2+attribute4`` |


wmhn1872265132 · 2023-11-23T03:23:06Z

It is recommended that the table introducing the Toggles the speech mode shortcut keys in the user guide be simplified into three columns: Name, Key, and Description to enhance the reading experience.

Qchristensen

Looks good. I made one small suggestion

Qchristensen · 2023-11-23T04:39:20Z

user_docs/en/userGuide.t2t

++ Speech modes ++[SpeechModes]
+
+There are four speech modes available.
+* Talk: NVDA will just speak normally. This is the default speech mode.


Small thing, but I don't like using "just" here. Someone will be reading the user guide because they don't know how things work and "just", to me, implies it is something they should have already known (there are articles on this such as https://www.excitant.co.uk/just-is-a-dangerous-word/ ). Perhaps:

Talk: The Default speech mode, NVDA speaks in reaction to actions such as moving the focus, notifications, or issuing commands.

Also, for consistency, should this group be in the same order as the command itself and the list on line 4065 (last change in this PR)

I agree with @Qchristensen here. I had removed "just" in my original suggestion on the input help text for this, but it slipped back in to the user guide version. I figured @CyrilleB79 really wanted it there, so I didn't comment further.

Suggested change

* Talk: NVDA will just speak normally. This is the default speech mode.

- Talk: NVDA will speak normally in reaction to screen changes, notifications, and actions such as moving the focus, or issuing commands.

@XLTechie, I had missed this from your feedback, but keeping "just" was not intended. Thanks for having insisted on this point.

@Qchristensen wrote:

Also, for consistency, should this group be in the same order as the command itself and the list on line 4065 (last change in this PR)

Yes for consistency, provided "Talk" is in first position since it is the normal mode.

XLTechie · 2023-11-23T06:15:19Z

user_docs/en/userGuide.t2t

+There are four speech modes available.
+* Talk: NVDA will just speak normally. This is the default speech mode.
+* On-demand: NVDA will only speak when calling commands whose goal is to speak an information (e.g. report the title of the window); but it will not speak in reaction to actions such as moving the focus or the cursor.
+* Off: NVDA will not speak anything. 


Suggested change

* Off: NVDA will not speak anything.

- Off: NVDA will not speak anything, however unlike sleep mode it will silently react to commands.

Adriani90 · 2023-11-23T20:50:37Z

Can you change the sentence for on-demand mode in something like this to make it more readable for people who need easy language?

- On-demand: NVDA will speak only when pressing a key command with a reporting function (e.g. report the title of the window) - It will not speak in reaction to actions such as moving the focus or copying content to clipboard.

Von: Cyrille Bougot ***@***.***> Gesendet: Donnerstag, 23. November 2023 21:38 An: nvaccess/nvda ***@***.***> Cc: Adriani90 ***@***.***>; Mention ***@***.***> Betreff: Re: [nvaccess/nvda] Add a speech "on demand" mode (PR #15804) @CyrilleB79 commented on this pull request.

_____ In user_docs/en/userGuide.t2t <#15804 (comment)> :

@@ -519,6 +518,20 @@ When the menu comes up, You can use the arrow keys to navigate the menu, and the

| Report clipboard text | NVDA+c | Reports the Text on the clipboard if there is any. | %kc:endInclude +++ Speech modes ++[SpeechModes] + +There are four speech modes available. +* Talk: NVDA will just speak normally. This is the default speech mode. +* On-demand: NVDA will only speak when calling commands whose goal is to speak an information (e.g. report the title of the window); but it will not speak in reaction to actions such as moving the focus or the cursor. +* Off: NVDA will not speak anything. +* Beeps: NVDA will replace normal speech with quiet beeps. Thanks for the formatting fix. No reason to use * instead of -. I'll change it. — Reply to this email directly, view it on GitHub <#15804 (comment)> , or unsubscribe <https://github.com/notifications/unsubscribe-auth/AGVCP4MUKWBE3Z7YM3XUPODYF6XZNAVCNFSM6AAAAAA7SCE7C2VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMYTONBWHE3TAMJXHE> . You are receiving this because you were mentioned. <https://github.com/notifications/beacon/AGVCP4J3ZGJAEI6AXXSVXULYF6XZNA5CNFSM6AAAAAA7SCE7C2WGG33NNVSW45C7OR4XAZNRKB2WY3CSMVYXKZLTORJGK5TJMV32UY3PNVWWK3TUL5UWJTTIECTEG.gif> Message ID: ***@***.*** ***@***.***> >

CyrilleB79 · 2023-11-23T21:45:34Z

Thanks @XLTechie, @Qchristensen, @Adriani90, @wmhn1872265132 and @seanbudd for all these valuable ideas and comments to improve the documentation.

I have tried to take into account the ideas from everyone which were very valuable.

Let me know if some point is still missing.

AppVeyorBot · 2023-11-23T22:34:12Z

PASS: Translation comments 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/g2kiq8nrn7tmyvyy/artifacts/output/nvda_snapshot_pr15804-30034,38283b3e.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.9,
INSTALL_END 1.0,
BUILD_START 0.0,
BUILD_END 25.4,
TESTSETUP_START 0.0,
TESTSETUP_END 0.3,
TEST_START 0.0,
TEST_END 16.0,
FINISH_END 0.1

See test results for failed build of commit 38283b3e1a

XLTechie

One final comment for your possible consideration, but either way LGTM!
Thanks for going back and forth with me and others over the details.

user_docs/en/userGuide.t2t

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

user_docs/en/userGuide.t2t

Qchristensen

Look good, great work everyone!

…15873) Closes #15806 Summary of the issue: NVDA allows to change the currently used speech mode by pressing NVDA+s. By default this gesture cycles between 'talk', 'beeps', 'on-demand' and 'no speech'. For many users having ability to switch to beeps or on demand is unnecessary, and they have no need for modes different than speech and no speech. For other beeps mode is certainly useful, but it is much more important to be able to quickly switch between speech and no speech, so beeps mode just makes the goal slower to achieve. With the introduction of fourth speech mode in #15804 it has been decided that users should be given ability to disable speech modes they do not need to use. Description of user facing changes The new checkable list containing all speech modes (all are initially checked)has been added into the Speech settings panel. When switching between modes with NVDA+s only modes which are checked in the list are included. When applying settings selected modes are validated, to make sure at least two modes are checked. When the 'talk' mode is disabled user is warned that they may be left without any speech. Description of development approach Configuration spec has been expanded to store list of disabled modes - this ensures that if any new mode is added to NVDA it is enabled by default in the cycling script. Speech settings panel now contains a list of all the speech modes, only enabled one are checked. When introducing validation for the speech settings panel it has been discovered that code responsible for checking panel's validity displays a warning about it being invalid, prevents saving invalid config, yet after dismissing the warning settings dialog gets closed. Since this is not optimal validation for settings dialog has been modified, so that after warning is dismissed settings remain open, and the invalid control is focused. The cycling script has been modified to only cycle between enabled modes. Unit tests verifying its behavior, both when no modes are disabled (the default) and some are disabled, were added. To make them work it has been necessary to perform a small modification to the method which lists configuration profiles in the config module, it assumed that profiles directory always exists, which is not true in unit tests. Now when the directory is missing appropriate warning is logged, and empty list is returned. User guide has been expanded to describe newly added control.

CyrilleB79 added 4 commits November 19, 2023 23:19

Add a speech "on demand" mode

a80234e

First pass on global commands

e119618

All other modules

3e97e23

documentation

2802b68

Linting and slight rewording

cd70958

CyrilleB79 added 3 commits November 20, 2023 10:16

Add input help in "on demand" mode

846b23c

Add say all commands in the speech on demand mode

5ce8cae

Update dev doc

5a324f4

CyrilleB79 added 2 commits November 20, 2023 11:37

Added a point in changes for developers

e84add7

Fix change log syntax

a86b2f9

CyrilleB79 marked this pull request as ready for review November 20, 2023 16:33

CyrilleB79 requested review from a team as code owners November 20, 2023 16:33

CyrilleB79 requested review from Qchristensen and michaelDCurran November 20, 2023 16:33

lukaszgo1 reviewed Nov 20, 2023

View reviewed changes

source/appModules/miranda32.py Show resolved Hide resolved

source/appModules/vipmud.py Show resolved Hide resolved

source/scriptHandler.py Outdated Show resolved Hide resolved

source/scriptHandler.py Outdated Show resolved Hide resolved

LeonarddeR reviewed Nov 20, 2023

View reviewed changes

source/scriptHandler.py Outdated Show resolved Hide resolved

source/speech/speech.py Outdated Show resolved Hide resolved

lukaszgo1 mentioned this pull request Nov 20, 2023

List of speech modes which can be switched to with NVDA+S should be made configurable #15806

Closed

Added a paragraph in the User Guide and shortened input help

2b0e74a

CyrilleB79 marked this pull request as ready for review November 22, 2023 22:10

seanbudd approved these changes Nov 22, 2023

View reviewed changes

XLTechie suggested changes Nov 23, 2023

View reviewed changes

Qchristensen requested changes Nov 23, 2023

View reviewed changes

XLTechie reviewed Nov 23, 2023

View reviewed changes

Apply review suggestions on documentation

e1b3316

Reorder speech modes consistently in doc

13d7841

Bump CI

6796fae

seanbudd approved these changes Nov 23, 2023

View reviewed changes

XLTechie approved these changes Nov 25, 2023

View reviewed changes

user_docs/en/userGuide.t2t Outdated Show resolved Hide resolved

CyrilleB79 changed the title ~~Add a speech "on demand" mode~~ Add an "on-demand" speech mode Nov 25, 2023

Update user_docs/en/userGuide.t2t

547d20a

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

seanbudd requested a review from Qchristensen November 26, 2023 22:27

seanbudd reviewed Nov 26, 2023

View reviewed changes

user_docs/en/userGuide.t2t Outdated Show resolved Hide resolved

user_docs/en/userGuide.t2t Outdated Show resolved Hide resolved

minor fixes

a02cbbf

Qchristensen approved these changes Nov 27, 2023

View reviewed changes

seanbudd merged commit c6489a3 into nvaccess:master Nov 27, 2023
1 check was pending

nvaccessAuto added this to the 2024.1 milestone Nov 27, 2023

CyrilleB79 deleted the speechOnDemand branch November 27, 2023 21:22

lukaszgo1 mentioned this pull request Dec 3, 2023

Make list of speech modes in the NVDA+s cycling script configurable. #15873

Merged

5 tasks

CyrilleB79 mentioned this pull request Dec 16, 2023

Add the support for on-demand mode addonFactory/instantTranslate#31

Merged

	* Beeps: NVDA will replace normal speech with quiet beeps.
	* Beeps: NVDA will replace normal speech with quiet beeps.
	*

	A gesture allows to cycle through the various speech modes:
	A gesture allows cycling through the various speech modes:

	# Translators: Input help mode message for toggle speech mode command.
	# Translators: Input help mode message for switch to next speech mode command.

	* On-demand: NVDA will only speak when calling commands whose goal is to speak an information (e.g. report the title of the window); but it will not speak in reaction to actions such as moving the focus or the cursor.
	- On-demand: NVDA will only speak when you use commands which speak information (e.g. report the title of the window); but it will not speak in reaction to actions such as moving the focus or the cursor; and will not speak any screen changes, notifications, etc.

-* Beeps: NVDA will replace normal speech with quiet beeps.
+- Beeps: NVDA will replace normal speech with short beeps.
+-
+Beeps mode may be useful when some very verbose output is scrolling in a terminal window, but you don't care what it is, only that it is continuing to scroll; or in other circumstances when the fact that there is output is more relevant than the output itself.
+The on-demand mode may be valuable when you don't need constant feedback about what is happening on screen or on the computer, but you periodically need to check particular things using review commands, etc.
+Examples include while recording audio, when using screen magnification, or as an alternative to beeps mode.

	\| Toggles between the speech modes of off, beep, speech and on-demand \| ``attribute2+attribute4`` \|
	\| Toggles between the speech modes of off, beeps, talk and on-demand \| ``attribute2+attribute4`` \|

	* Talk: NVDA will just speak normally. This is the default speech mode.
	- Talk: NVDA will speak normally in reaction to screen changes, notifications, and actions such as moving the focus, or issuing commands.

	* Off: NVDA will not speak anything.
	- Off: NVDA will not speak anything, however unlike sleep mode it will silently react to commands.

Add an "on-demand" speech mode #15804

Add an "on-demand" speech mode #15804

Conversation

CyrilleB79 commented Nov 19, 2023 • edited Loading

Link to issue number:

Summary of the issue:

Description of user facing changes

Description of development approach

Notes for reviewers

Testing strategy:

Known issues with pull request:

Code Review Checklist:

AppVeyorBot commented Nov 20, 2023

Adriani90 commented Nov 20, 2023

Adriani90 commented Nov 20, 2023

LeonarddeR commented Nov 20, 2023

CyrilleB79 commented Nov 20, 2023

XLTechie commented Nov 20, 2023 via email

CyrilleB79 commented Nov 20, 2023

ABuffEr commented Nov 20, 2023

LeonarddeR commented Nov 20, 2023

lukaszgo1 commented Nov 20, 2023

Adriani90 commented Nov 20, 2023 • edited Loading

Adriani90 commented Nov 20, 2023

codeofdusk commented Nov 22, 2023

CyrilleB79 commented Nov 22, 2023

seanbudd left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

XLTechie left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wmhn1872265132 commented Nov 23, 2023

Qchristensen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

XLTechie Nov 23, 2023 • edited Loading

Choose a reason for hiding this comment

Adriani90 commented Nov 23, 2023 via email

CyrilleB79 commented Nov 23, 2023

AppVeyorBot commented Nov 23, 2023

XLTechie left a comment

Choose a reason for hiding this comment

Qchristensen left a comment

Choose a reason for hiding this comment

CyrilleB79 commented Nov 19, 2023 •

edited

Loading

Adriani90 commented Nov 20, 2023 •

edited

Loading

XLTechie Nov 23, 2023 •

edited

Loading