Skip to content

User guide: clarify the usage of character level in the Punctuation/symbol pronunciation dialog#14737

Merged
seanbudd merged 3 commits into
nvaccess:masterfrom
CyrilleB79:docSymbLevel
Mar 27, 2023
Merged

User guide: clarify the usage of character level in the Punctuation/symbol pronunciation dialog#14737
seanbudd merged 3 commits into
nvaccess:masterfrom
CyrilleB79:docSymbLevel

Conversation

@CyrilleB79

Copy link
Copy Markdown
Contributor

Link to issue number:

Reported on NVDA mailing list in this thread.

Summary of the issue:

People are
In Punctuation/symbol pronunciation dialogue, in the level field, there is an options named "character". People are wondering what this option does since it is not documented in the user guide.

Description of user facing changes

Added a sentence in the doc to describe it.

Description of development approach

N/A

Testing strategy:

  • Manual test: check the doc generated by appVeyor.
  • Also inform on the mailing list so that people can confirm if the new sentence is understood.

Known issues with pull request:

None

Change log entries:

Doc only; not needed.

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.

@CyrilleB79 CyrilleB79 marked this pull request as ready for review March 23, 2023 22:37
@CyrilleB79 CyrilleB79 requested a review from a team as a code owner March 23, 2023 22:37
@CyrilleB79 CyrilleB79 requested a review from Qchristensen March 23, 2023 22:37
@britechguy

Copy link
Copy Markdown

I'm not quite sure how one is supposed to comment on this sort of change, and I do believe it's needed. I believe that @CyrilleB79 has suggested the following as the text to use in the documentation:
If you set the level on "character", the symbol will not be spoken regardless of the symbol level you are using, except when you navigate by character or when some text is spelt.

I would propose this alternative:
If the level is set to character, the symbol will not be spoken regardless of the symbol level in use, with the following two exceptions:

  1. When navigating character by character.
  2. When NVDA is spelling any text containing that symbol.

@LittleStar-VIP

LittleStar-VIP commented Mar 24, 2023

Copy link
Copy Markdown

Hello,
Thanks for bringing up this issue.

I have the following comments:

  1. I think it is strange to mention only the 'character' option here, as there are also several other options regarding the drop down menue of the level option, e.g., none, all, etc. Could the user guide list out what does each option of the level does? I think the user guide should not assumed that user already know what do the other options do.
  2. if the paragraph here is saying that character will be applied to situation where nvda is spelling out a text, please give example, e.g. pressing nvda+up arrow twice

@XLTechie

XLTechie commented Mar 24, 2023 via email

Copy link
Copy Markdown
Collaborator

@Brian1Gaff

Brian1Gaff commented Mar 24, 2023 via email

Copy link
Copy Markdown

@CyrilleB79

Copy link
Copy Markdown
Contributor Author

Thanks for the feedback.

I have rephrased the paragraph according to @britechguy and @LittleStar-VIP's comments.

Note: @britechguy, maybe you are not used to reviewing PRs. Going in the tab labeled "Files changed" you will see how the file has been modified in this PR. The modified lines in the file start with + or - indicating if they have been added or removed. Let us know if it's clear for you. And I hope you do not mind this note if you already knew all this.

@AppVeyorBot

Copy link
Copy Markdown

See test results for failed build of commit f6dd135470

@AppVeyorBot

Copy link
Copy Markdown

See test results for failed build of commit 44eb6f19ff

@Qchristensen Qchristensen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good and should ease confusion around the setting, thanks!

@seanbudd seanbudd merged commit 5182cd9 into nvaccess:master Mar 27, 2023
@nvaccessAuto nvaccessAuto added this to the 2023.2 milestone Mar 27, 2023
@CyrilleB79 CyrilleB79 deleted the docSymbLevel branch March 27, 2023 13:55
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.

9 participants