Report the language switched to #17685

nvdaes · 2025-02-08T17:34:08Z

Add ability to report the current language when detecting languages is enabled
Added a command to report the language of the character at the caret

Link to issue number:

#17664

Summary of the issue:

Users may want to know the current language when the language detection is enabled.

Description of user facing changes

When switching to a non default language, NVDA should report it.
Added an unassigned command in the caret system category to know the language of the charácter positioned at the caret.

Description of development approach

In speech.speech.py, a lastReportedLanguage member has been added to the SpeechState dataclass.
In the speak function, the language description is inserted in the speechSequence when appropriate.
In speech.speech.py, a languageIsSupportedfunction has been added. It accept a language parameter to check if it's available in the current synthesizer.
In globalCommands.py, a script has been added to report the language of the carácter at caret.
This is an API break change since the speakfunction is changed.

Testing strategy:

Tested manually in webpages like addons.nvda-project.org, and navigating to nvda.fr, DuckDuckGo, etc, and in VS Code and other places of Windows.

Known issues with pull request:

This needs to be more tested to know if it Works appropriately. In say all, NVDA can report the language when a new paragraph starts.

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

…s enabled

CyrilleB79 · 2025-02-08T21:31:33Z

source/globalCommands.py

+		text = info.text
+		repeats = scriptHandler.getLastScriptRepeatCount()
+		if repeats == 0:
+			ui.message(languageHandler.getLanguageDescription(curLanguage))


Please handle the case where the language is not recognized. I.e. report something like f"Unknown language ({languageCode})" or just f"{languageCode}".

source/globalCommands.py

CyrilleB79 · 2025-02-08T21:39:22Z

source/speech/speech.py

+					speechSequence.insert(1, languageHandler.getLanguageDescription(curLanguage))
+					SpeechState.lastReportedLanguage = curLanguage
+					if not languageIsSupported(curLanguage):
+						log.warn(f"{curLanguage} not supported in {getSynth().name}")


Seems that log.warn is usually not used in NVDA's code base. Any specific reason to use it?

We usually have log.warning (used even at info level), and log .debugWarning, used at the same log level.

Just a mistake from my side. My intention was to use log.debugWarning

CyrilleB79 · 2025-02-08T21:41:32Z

source/speech/speech.py

+	if language is None:
+		return True
+	for lang in getSynth().availableLanguages:
+		if language == lang or language == languageHandler.normalizeLanguage(lang).split("_")[0]:


Should this piece of code depend on the "Automatic dialect switching (when supported)" option?

I think it's better that this doesn't deppend on the automatic dialect switching option, since we can imagine a synthesizer with languages just in the form of dialects. Anyway I'm open to change my opinion.

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

nvdaes · 2025-02-08T22:31:54Z

Seems that, when pressing c to go to the combo box in the old add-ons website, the preferences word is in English but, if it's not spoken, the lastReportedLanguage is set to English, and this causes that the language of the word English in the combo box is not reported. I don't know if this may be fixed with the pre_speech extension point in some way.

CyrilleB79 · 2025-02-09T20:50:53Z

@nvdaes, regarding language translations I guess it would be interesting to list all the specific / corner cases. Then you will be able to determine if they should be handled separately or if they can be ignored.

For example I have the following questions:

zh_CN = Chinese (simplified) and zh_TW = Chinese (Traditional) would be both reported as "Chinese", I guess. Is it OK (cc @cary-rowen)
the language would be reported in the system's language; this would make a difference if you run NVDA in another language than "Windows". Maybe not a big problem, but it's worth informing of this limitation in the PR.
languageHandler.getLanguageDescription('sr'): on my system, it reports (in French): "Serbe (latin)". To be double checked if Serbian tagged webpages are tagged with "sr" or something else and if they are written in Cyrillic or in latin.

nvdaes · 2025-02-10T06:14:33Z

@CyrilleB79 , should the corner cases be addressed in languageHandler.getLanguageDescription?
I'm concerned about the issue regarding pressing c on the add-ons website, since in this case English language may not be reported. So I'm blocked with this.

CyrilleB79 · 2025-02-10T07:01:47Z

@CyrilleB79 , should the corner cases be addressed in languageHandler.getLanguageDescription?

Maybe not; just mentioning in case everyone is aware of it so to decide what to do (accept as is or fix).

nvdaes · 2025-02-10T07:15:35Z

Let's way for comments on this about corner cases, to see how to document it, or if saying that the language description would be reported is enough.
Hope someone can provide ideas to fix the error when jumping to some parts of webpages using quick navigation characters like c to move to combo boxes.

… reporting

nvdaes · 2025-02-18T04:48:17Z

I think that the experience when using this feature with quick navigation or moving the focus with tab is not good, when the language description is reported, then for example the text of a heading and a link, and then the link state like "visited link". In this case "visited link" is pronnounced with a bad entonation, tested with eSpeak-NG. And also, listening the language description for each element, since "visited link" is pronnounced in the default language, is too much.
I think that this should be disabled for quick navigation, unless someone can provide better ideas.

…ends

nvdaes · 2025-02-20T17:26:54Z

Now for me the user experience is acceptable, not perfect, since in say all NVDA can report the language for new paragraphs. See [In-Process 7th February 2025](https://www.nvaccess.org/post/in-process-7th-february-2025/

Copy control+shift+cClose).
If we move the caret to the ending dot of the paragraph with right arrow, and then we make NVDA to say all, this issue seems not to happen.

nvdaes added 2 commits February 8, 2025 12:55

Add ability to report the current language when detecting languages i…

7be8bd2

…s enabled

Added a command to report the language of the character at the caret

f0a9a31

nvdaes changed the title ~~Reportthe language switched to~~ Report the language switched to Feb 8, 2025

CyrilleB79 reviewed Feb 8, 2025

View reviewed changes

source/globalCommands.py Outdated Show resolved Hide resolved

CyrilleB79 reviewed Feb 8, 2025

View reviewed changes

nvdaes and others added 2 commits February 8, 2025 23:16

Apply suggestions from code review

6e4b0b3

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

Address review and minor improvements

79e9bb5

nvdaes and others added 4 commits February 11, 2025 21:54

Use _speechState

2393d8a

Merge remote-tracking branch 'nvaccess/master' into reportSwitchLang

df8d7c2

Fix reporting when using quick navigation, avoiding repetition of the…

bb3b7c6

… reporting

Pre-commit auto-fix

e70b380

nvdaes added 5 commits February 18, 2025 18:24

Don't report language description on quick nav

8e437d0

Suppress language description reporting when reading all and a block …

e898b6c

…ends

Don't try to change behavior in read all, seems to be useless

7123970

Merge remote-tracking branch 'nvaccess/master' into reportSwitchLang

2164376

Prevent insertion of None in speech sequence

2eca960

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Report the language switched to #17685

Report the language switched to #17685

nvdaes commented Feb 8, 2025 •

edited

Loading

CyrilleB79 Feb 8, 2025

CyrilleB79 Feb 8, 2025

nvdaes Feb 8, 2025

CyrilleB79 Feb 8, 2025

nvdaes Feb 8, 2025

nvdaes commented Feb 8, 2025

CyrilleB79 commented Feb 9, 2025

nvdaes commented Feb 10, 2025

CyrilleB79 commented Feb 10, 2025

nvdaes commented Feb 10, 2025

nvdaes commented Feb 18, 2025

nvdaes commented Feb 20, 2025

Report the language switched to #17685

Are you sure you want to change the base?

Report the language switched to #17685

Conversation

nvdaes commented Feb 8, 2025 • edited Loading

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:

CyrilleB79 Feb 8, 2025

Choose a reason for hiding this comment

CyrilleB79 Feb 8, 2025

Choose a reason for hiding this comment

nvdaes Feb 8, 2025

Choose a reason for hiding this comment

CyrilleB79 Feb 8, 2025

Choose a reason for hiding this comment

nvdaes Feb 8, 2025

Choose a reason for hiding this comment

nvdaes commented Feb 8, 2025

CyrilleB79 commented Feb 9, 2025

nvdaes commented Feb 10, 2025

CyrilleB79 commented Feb 10, 2025

nvdaes commented Feb 10, 2025

nvdaes commented Feb 18, 2025

nvdaes commented Feb 20, 2025

nvdaes commented Feb 8, 2025 •

edited

Loading