From 6610e4b3f103a20d2c191dbe21c6e1c6a7a224b1 Mon Sep 17 00:00:00 2001
From: Leonard de Ruijter <3049216+LeonarddeR@users.noreply.github.com>
Date: Mon, 9 Sep 2024 02:34:28 +0200
Subject: [PATCH] Enable unicode normalization by default for speech (#17017)

Fixes #16616

Summary of the issue:
In #16521, Unicode normalization was added, but it is disabled by default.

Description of user facing changes
Unicode normalization is now enabled by default for Speech.

Description of development approach
Change default values
---
 source/config/configSpec.py                                   | 2 +-
 .../system/nvdaSettingsFiles/standard-doShowWelcomeDialog.ini | 1 +
 .../system/nvdaSettingsFiles/standard-dontShowExitDialog.ini  | 1 +
 .../nvdaSettingsFiles/standard-dontShowWelcomeDialog.ini      | 1 +
 user_docs/en/changes.md                                       | 3 +++
 user_docs/en/userGuide.md                                     | 4 ++--
 6 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/source/config/configSpec.py b/source/config/configSpec.py
index 651ca1aecd3..bba71c8a372 100644
--- a/source/config/configSpec.py
+++ b/source/config/configSpec.py
@@ -35,7 +35,7 @@
 	# symbolLevel: One of the characterProcessing.SymbolLevel values.
 	symbolLevel = integer(default=100)
 	trustVoiceLanguage = boolean(default=true)
-	unicodeNormalization = featureFlag(optionsEnum="BoolFlag", behaviorOfDefault="disabled")
+	unicodeNormalization = featureFlag(optionsEnum="BoolFlag", behaviorOfDefault="enabled")
 	reportNormalizedForCharacterNavigation = boolean(default=true)
 	# Deprecated in 2025.1
 	includeCLDR = boolean(default=True)
diff --git a/tests/system/nvdaSettingsFiles/standard-doShowWelcomeDialog.ini b/tests/system/nvdaSettingsFiles/standard-doShowWelcomeDialog.ini
index 480c34e2cb6..a0b21246117 100644
--- a/tests/system/nvdaSettingsFiles/standard-doShowWelcomeDialog.ini
+++ b/tests/system/nvdaSettingsFiles/standard-doShowWelcomeDialog.ini
@@ -9,6 +9,7 @@ schemaVersion = 2
 	allowUsageStats = False
 [speech]
 	synth = speechSpySynthDriver
+	unicodeNormalization = DISABLED
 [development]
 	enableScratchpadDir = True
 [virtualBuffers]
diff --git a/tests/system/nvdaSettingsFiles/standard-dontShowExitDialog.ini b/tests/system/nvdaSettingsFiles/standard-dontShowExitDialog.ini
index 67973f4743f..04b3cb6bbd6 100644
--- a/tests/system/nvdaSettingsFiles/standard-dontShowExitDialog.ini
+++ b/tests/system/nvdaSettingsFiles/standard-dontShowExitDialog.ini
@@ -10,6 +10,7 @@ schemaVersion = 2
 	allowUsageStats = False
 [speech]
 	synth = speechSpySynthDriver
+	unicodeNormalization = DISABLED
 [development]
 	enableScratchpadDir = True
 [virtualBuffers]
diff --git a/tests/system/nvdaSettingsFiles/standard-dontShowWelcomeDialog.ini b/tests/system/nvdaSettingsFiles/standard-dontShowWelcomeDialog.ini
index d8efefe2885..c259ecf3a89 100644
--- a/tests/system/nvdaSettingsFiles/standard-dontShowWelcomeDialog.ini
+++ b/tests/system/nvdaSettingsFiles/standard-dontShowWelcomeDialog.ini
@@ -9,6 +9,7 @@ schemaVersion = 2
 	allowUsageStats = False
 [speech]
 	synth = speechSpySynthDriver
+	unicodeNormalization = DISABLED
 [development]
 	enableScratchpadDir = True
 [virtualBuffers]
diff --git a/user_docs/en/changes.md b/user_docs/en/changes.md
index 2d3f8cc8145..03c0dbfb70a 100644
--- a/user_docs/en/changes.md
+++ b/user_docs/en/changes.md
@@ -5,6 +5,7 @@
 ### Important notes
 
 ### New Features
+
 * The volume of other applications can be adjusted by `NVDA+alt+pageUp` and `NVDA+alt+pageDown`. In order to use this feature, application volume adjuster needs to be enabled in Audio pane of NVDA settings. (#16052, @mltony)
 * Added command to mute or unmute all other applications, assigned to `NVDA+alt+delete`.
 In order to use this feature, the application volume adjuster needs to be enabled in the Audio category of NVDA settings. (#16052, @mltony)
@@ -18,6 +19,8 @@ In order to use this feature, the application volume adjuster needs to be enable
 
 * The Report link destination, Character formatting information, and Speak selection dialogs, now include "Close" and "Copy" buttons for user convenience. (#17018, @XLTechie)
 * The exit dialog now allows you to restart NVDA with add-ons disabled and debug logging enabled simultaneously. (#11538, @CyrilleB79)r
+* Unicode Normalization is now enabled by default for speech output. (#17017, @LeonarddeR).
+  * You can still disable this functionality in the Speech category of the NVDA Settings dialog.
 
 ### Bug Fixes
 
diff --git a/user_docs/en/userGuide.md b/user_docs/en/userGuide.md
index eca0d0a3c80..d018475a2f3 100644
--- a/user_docs/en/userGuide.md
+++ b/user_docs/en/userGuide.md
@@ -1914,8 +1914,8 @@ If you find that NVDA is reading punctuation in the wrong language for a particu
 ##### Unicode normalization {#SpeechUnicodeNormalization}
 | . {.hideHeaderRow} |.|
 |---|---|
-|Options |Default (Disabled), Enabled, Disabled|
-|Default |Disabled|
+|Options |Default (Enabled), Enabled, Disabled|
+|Default |Enabled|
 
 When this option is enabled, unicode normalization is performed on the text that is spoken by NVDA.
 This is beneficial when speaking characters that can be represented in several forms.