New script to toggle delayed descriptions for characters.

[CyrilleB79]

Link to issue number:

https://nvda.groups.io/g/nvda/message/100197

Summary of the issue:

A script to toggle delayed character description has been asked.

Description of user facing changes

Added a script to toggle delayed character description.

Keep this script unassigned because it does not seem to me that this feature deserve a predefined gesture.

Description of development approach

Added the script in global commands, as other such scripts.

Additional possible changes

I am always a bit disturbed by the wording "Delayed character descriptions" or "Delayed descriptions for characters" with the plural form, specifically in my language (French). The other options, on the contrary, are worded with singular form, e.g. we do not have "Font sizes".
If you agree, while at it, I may reword this option using singular form.
What do you think? CC @Qchristensen

If it's not an issue in English, I'll see on French translation side only.

Testing strategy:

Manual tests:
I have assigned the script and used it. I have checked that:

• the script correctly reports its action
• the option in the GUI is changed adequately
• the feature is enabled/disabled according to the action of the script
• input help is working well

Known issues with pull request:

None.

Change log entries:

An unassigned command has been added to toggle delayed character descriptions.

Code Review Checklist:

• Pull Request description:
  • description is up to date
  • change log entries
• Testing:
  • Unit tests
  • System (end to end) tests
  • Manual testing
• API is compatible with existing add-ons.
• Documentation:
  • User Documentation
  • Developer / Technical Documentation
  • Context sensitive help for GUI changes
• UX of all users considered:
  • Speech
  • Braille
  • Low Vision
  • Different web browsers
  • Localization in other languages / culture than English
• Security precautions taken.

[AppVeyorBot]

• 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/u779m1jvljynsy8o/artifacts/output/nvda_snapshot_pr14267-26837,34232596.exe
• CI timing (mins):
  INIT 0.0,
  INSTALL_START 0.8,
  INSTALL_END 0.8,
  BUILD_START 0.0,
  BUILD_END 22.4,
  TESTSETUP_START 0.0,
  TESTSETUP_END 0.2,
  TEST_START 0.0,
  TEST_END 13.3,
  FINISH_END 0.2

See test results for failed build of commit 34232596c3

[CyrilleB79]

Failing test is "lien Robot.symbolPronunciationTests.tableHeaderSymbols".
Seems completely unrelated.

[seanbudd]

I am always a bit disturbed by the wording "Delayed character descriptions" or "Delayed descriptions for characters" with the plural form, specifically in my language (French). The other options, on the contrary, are worded with singular form, e.g. we do not have "Font sizes".

The current form reads well to me, what do you propose the alternative be?

[CyrilleB79]

I am always a bit disturbed by the wording "Delayed character descriptions" or "Delayed descriptions for characters" with the plural form, specifically in my language (French). The other options, on the contrary, are worded with singular form, e.g. we do not have "Font sizes".

The current form reads well to me, what do you propose the alternative be?

Here is what I have in mind:

• Option name: "Delayed descriptions for characters on cursor movement" to be replaced by "Delayed description for characters on cursor movement"
• In this PR's code: "delayed character descriptions on/off" to be replaced by "delayed character description on/off"
• In this PR's change log entry: "An unassigned command has been added to toggle delayed character descriptions." to be replaced by "An unassigned command has been added to toggle delayed character description."
• Older change log will not be updated as we usually do not modify change log items of a previous release.

Again, English is not my native language. So just let me know if English formulation is correct. Maybe we are just in those cases where English uses plural and French singular. E.g. in the following example:
"The students take off their coats and take out their notebooks.", French would translate "coats" and "notebooks" with singular form since there is only one coat and one notebook per student.

Note: I realize that I have put singular form for "script_toggleDelayedCharacterDescription". If we keep the plural form in English, I should update the script's name.

[seanbudd]

@CyrilleB79 - I think the current form reads better in English