Skip to content

Normalize references to Insert keys#16489

Merged
seanbudd merged 1 commit into
nvaccess:masterfrom
truthless-dev:insert-key
May 9, 2024
Merged

Normalize references to Insert keys#16489
seanbudd merged 1 commit into
nvaccess:masterfrom
truthless-dev:insert-key

Conversation

@truthless-dev

@truthless-dev truthless-dev commented May 6, 2024

Copy link
Copy Markdown
Contributor

Link to issue number:

Fixes #13648

Summary of the issue:

The Welcome Screen and User Guide used different terms, "main Insert" and "Extended Insert" respectively, to refer to the same key.

Description of user facing changes

Both the Welcome Screen and User Guide now call Extended/main Insert by simply "Insert."

Description of development approach

Modified wording in userGuide and startupDialogs files, as well as the startup system test that checks the Welcome Screen text.

Testing strategy:

Rebuilt NVDA with scons source user_docs and scons dist and checked both places where changes are made. Ran all system tests.

Known issues with pull request:

  • No translations of either the Welcome Screen or User Guide were updated.

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.

Notes

Translations were not attempted, as I don't speak any other languages, and it looks to me like there are other people and processes to handle that. I am new to NVDA, though, so if I need to do anything to make that happen, or if I forgot anything or made any errors in the code or starting the PR, please let me know. Thank you in advance.

@truthless-dev truthless-dev marked this pull request as ready for review May 6, 2024 17:03
@truthless-dev truthless-dev requested review from a team as code owners May 6, 2024 17:03
@zstanecic

Copy link
Copy Markdown
Contributor

Hi,
I am rather against this change. Main insert and extended insert are keys which are located in a different places on a keyboard. You need to make differences somehow.

@AppVeyorBot

Copy link
Copy Markdown

See test results for failed build of commit a230d1e813

@truthless-dev

Copy link
Copy Markdown
Contributor Author

Thanks for the quick feedback, @zstanecic. :)

The few commenters on #13648 seemed all to agree that the naming conventions should be made the same in both areas. So, to clarify, should I have called it something other than simply "Insert", or is the change not needed overall? I know it's a pretty old issue, so maybe thoughts on it have changed since then.

Thank you again. :)

@zstanecic

Copy link
Copy Markdown
Contributor

In my opinion, change is not needed overall, because we have two insert keys, which are differently named in the windows terminology. This change may confuse users.

@CyrilleB79

Copy link
Copy Markdown
Contributor

@zstanecic main insert and extended insert refer to the same key in NVDA's documentation and GUI. On a normal keyboard, it's located on the 6-key pad above the 4 arrow keys. On the other side, you have the numpad insert key, which is the 0 key of the numpad when numlock is off.

Thus, you have the numpad insert key and the other one. The current PR'aims to use a unique term (or expression) for this other insert key.

@seanbudd

seanbudd commented May 7, 2024

Copy link
Copy Markdown
Member

Unfortunately you'll need to redraft this due to the timing of #16419 and #16492, to update your changes to markdown in userGuide.md

@seanbudd seanbudd marked this pull request as draft May 7, 2024 05:46
@truthless-dev truthless-dev reopened this May 7, 2024
@truthless-dev truthless-dev changed the title Normalize references to Insert keys GH-13648 Normalize references to Insert keys #13648 May 7, 2024
@truthless-dev

Copy link
Copy Markdown
Contributor Author

Sorry about that. I should've double-checked the status of the freeze before posting.

Updated my branch and redid my changes. Should be good now. If not, I'm happy to fix anything I broke. :)

@truthless-dev truthless-dev marked this pull request as ready for review May 7, 2024 20:09
@AppVeyorBot

Copy link
Copy Markdown

See test results for failed build of commit 3502b71ef5

@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. I have never found a reference to "Extended insert". The Microsoft Style Guide only references the "Insert key" (although doesn't distinguish between the two): https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/keys-keyboard-shortcuts

@seanbudd

seanbudd commented May 8, 2024

Copy link
Copy Markdown
Member

Could you please update the system tests so that they pass? The strings in the welcome dialog need updating

@seanbudd seanbudd changed the title Normalize references to Insert keys #13648 Normalize references to Insert keys May 8, 2024
The Welcome Screen and User Guide used different terms, "main Insert"
and "Extended Insert", to refer to the same key. Call it simply the
"Insert" key in both places so that terminology is consistent. Also
update system startup tests to reflect the new Welcome Screen text.
@truthless-dev

truthless-dev commented May 8, 2024

Copy link
Copy Markdown
Contributor Author

@seanbudd I seem to be having the same problem with running system tests as was raised in #13894, where crash dumps are not being generated during the crash tests, causing those three to fail. I've spent quite a while looking through the test libraries, my temp directories, running tests individually, running on a fresh repo, etc., and can't figure what's going on.

The "read welcome dialog" test is passing now, though, and only the "restart on * crash" tests fail, so I decided to push changes and see what AppVeyor says, based on your feedback in that issue linked above. Hope that's acceptible.

And this is why I started with a very small issue...

@seanbudd seanbudd merged commit faf2789 into nvaccess:master May 9, 2024
@nvaccessAuto nvaccessAuto added this to the 2024.3 milestone May 9, 2024
@truthless-dev truthless-dev deleted the insert-key branch May 9, 2024 04:11
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.

Use consistent terminology for insert key between User Guide and Welcome Screen

7 participants