Skip to content

User Guide fixes#15256

Merged
seanbudd merged 3 commits into
nvaccess:betafrom
CyrilleB79:UGFixes
Aug 4, 2023
Merged

User Guide fixes#15256
seanbudd merged 3 commits into
nvaccess:betafrom
CyrilleB79:UGFixes

Conversation

@CyrilleB79

@CyrilleB79 CyrilleB79 commented Aug 3, 2023

Copy link
Copy Markdown
Contributor

Link to issue number:

Fix-up of #15065

Summary of the issue:

Various issues found in documentation while reviewing translation:

  1. Flattened review:

For example, if you move to the next object in this flattened view and the current object contains other objects, NVDA will automatically move to the first object that contains it.
Should be "that it contains", not "that contains it"!
Cc @LeonarddeR for approval

  1. Excel UIA option not at the correct place in the documentation with respect to its position in the GUI's Advanced settings panel.

  2. Searching for add-ons

-Type a keyword or two for the kind of add-on you're looking for, then tab back to the list of add-ons.
Actually, we tab forward, not back.

  1. Add-on Store spelling: Let's take care to use an unique writing so that people get immediately used:
    So "Add-on Store", not "Add-ons Store".

  2. Key name formatting:
    Key name formatting should always be used for single keys, not for a whole list of keys including separators or parenthesis that do not belong to the name of a key as done for some braille keys.

Description of user facing changes

Fixed all this.

Description of development approach

Modified documentation.

Note:

I was also planning to rewrite the paragraph "Move system caret when routing review cursor" which I find a bit hard to understand; however not sure to have the time for now.
Cc @XLTechie if you are interested and for your opinion on this paragraph.
Also cc @burmancomp and @LeonarddeR for information and for your opinion.

Testing strategy:

  • Review
  • Documentation checked again when translating

Known issues with pull request:

None

Change log entries:

None

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 August 3, 2023 19:48
@CyrilleB79 CyrilleB79 requested a review from a team as a code owner August 3, 2023 19:48
@CyrilleB79 CyrilleB79 requested review from Qchristensen and removed request for a team August 3, 2023 19:48
@CyrilleB79

CyrilleB79 commented Aug 3, 2023

Copy link
Copy Markdown
Contributor Author

Cc @seanbudd:
In addition to @Qchristensen's review, you may want to have a look to have points 4 (Add-on Store spelling) and 5 (key name formatting) so that you keep them in mind when reviewing future PRs, since you sometimes review documentation updates too.

@seanbudd

seanbudd commented Aug 4, 2023

Copy link
Copy Markdown
Member

I don't see any relevant changes in regards to point 4, could you explain why it was raised here?
In regards to point 5, I'm personally unfussed if separators like parenthesis and commas are included in the code formatting

seanbudd
seanbudd previously approved these changes Aug 4, 2023
View reviewed changes
@seanbudd seanbudd added this to the 2023.2 milestone Aug 4, 2023
@seanbudd

seanbudd commented Aug 4, 2023

Copy link
Copy Markdown
Member

I see that there is one usage of "Add-ons store" in the first line of AddonStoreInstalling, was that meant to be changed in this PR?

Qchristensen
Qchristensen previously approved these changes Aug 4, 2023
View reviewed changes

@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, thanks!

seanbudd
seanbudd reviewed Aug 4, 2023
View reviewed changes
Comment thread user_docs/en/userGuide.t2t Outdated
@CyrilleB79 @seanbudd
Update user_docs/en/userGuide.t2t
0af6e19 
Co-authored-by: Sean Budd <seanbudd123@gmail.com>
@CyrilleB79 CyrilleB79 dismissed stale reviews from Qchristensen and seanbudd via 0af6e19 August 4, 2023 06:37
@CyrilleB79

CyrilleB79 commented Aug 4, 2023

Copy link
Copy Markdown
Contributor Author

I see that there is one usage of "Add-ons store" in the first line of AddonStoreInstalling, was that meant to be changed in this PR?

Yes, that was it. I had forgotten to push it yesterday. Now fixed in 7f4b21d.

@CyrilleB79

CyrilleB79 commented Aug 4, 2023

Copy link
Copy Markdown
Contributor Author

In regards to point 5, I'm personally unfussed if separators like parenthesis and commas are included in the code formatting

IMO it's better not to add them, for example:
When writing "Press ctrl+c and ctrl+v", you will not use key name formatting for the word "and". The same way, if you write instead "Press ctrl+c, ctrl+v", the comma should not be formatted as key names. Semantically, "ctrl+c" and "ctrl+v" are two distinctive shortcuts separated by "and" or by a comma.

Of course, in a comma in a sequential shortcut such "alt, f, w" found in Word's ribbons, the comma belongs to the shortcut and should be formatted along with the whole shortcut formatting.

This formatting issue is not very important, so I won't submit a PR to fix them (if any) in the current version of the Guide. But checking this in newly added content could be a good practice IMO.

@XLTechie

XLTechie commented Aug 4, 2023 via email

Copy link
Copy Markdown
Collaborator

@seanbudd seanbudd merged commit 9fb9559 into nvaccess:beta Aug 4, 2023
@CyrilleB79 CyrilleB79 deleted the UGFixes branch August 4, 2023 08:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@seanbudd seanbudd seanbudd left review comments

@Qchristensen Qchristensen Qchristensen left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

2023.2

Development

Successfully merging this pull request may close these issues.

4 participants

@CyrilleB79 @seanbudd @XLTechie @Qchristensen