Skip to content

Fix up user-facing Remote Access terminology - #17943

Merged
seanbudd merged 17 commits into
betafrom
remoteTerminology
Apr 28, 2025
Merged

Fix up user-facing Remote Access terminology#17943
seanbudd merged 17 commits into
betafrom
remoteTerminology

Conversation

@SaschaCowley

@SaschaCowley SaschaCowley commented Apr 11, 2025

Copy link
Copy Markdown
Member

Link to issue number:

Fixes #17815

Summary of the issue:

NVDA's new Remote Access feature currently uses inconsistent terminology.

Description of user facing changes

Remote Access:

  • Is consistently referred to as "Remote Access".
  • Uses the term "computer" to refer to clients.
    • Previously both "computer" and "machine" were used. I also considered "device", as this seems to be the preferred terminology in Windows.
  • Uses the word "send" instead of "push" for sending the clipboard to connected clients.
  • Has descriptive help items for its menu items, all of which are complete sentences.
  • Uses sentence fragments for UI messages where appropriate

Description of development approach

Generated a pot file, and searched for the word "remote" therein. If it was referring to Remote Access, and some other name was used, replaced it with Remote Access.

Searched for the word "remote" in the user guide and edited as appropriate. Also did a full readthrough of the remote section.

Reviewed the strings in the settings dialog, menu, and cues explicitly and edited as appropriate.

Calculated the diff 1b4a28d4d...9833d7812. Searched in it for newly introduced translator comments, and edited them if related to Remote Access and I thought they were unclear.

Calculated the diff 9833d7812...42aaea791. Reviewed it for any changed strings that used gettext (_(...)), and changed to use pgettext (pgettext("remote", ...)).

Testing strategy:

pre-commit.
Unit tests.
Checking the generated pot file.

Known issues with pull request:

The remote section of the user guide still needs some TLC, however I believe this is best worked through in a separate PR with input from @qchristenson.

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.

@coderabbitai summary

@SaschaCowley
SaschaCowley marked this pull request as ready for review April 11, 2025 09:57
@SaschaCowley
SaschaCowley requested review from a team as code owners April 11, 2025 09:57
@SaschaCowley
SaschaCowley changed the base branch from master to beta April 11, 2025 10:01

@CyrilleB79 CyrilleB79 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Here are various comments.

  • Translators comments: some of them still use remote or NVDA remote.
  • Other comments (code comment): idem

Maybe you missed them. Searching the whole code could be better than doing it on a diff? I have flagged some of them but there are more of them.

I have also made other little remarks. If you find them off-topic, let me know and I'll add them in a separate issue or PR if needed.

Comment thread source/gui/settingsDialogs.py Outdated
Comment thread source/gui/settingsDialogs.py Outdated
Comment thread source/gui/settingsDialogs.py
Comment thread source/globalCommands.py Outdated
Comment thread source/_remoteClient/client.py Outdated
Comment thread source/_remoteClient/client.py Outdated
Comment thread source/_remoteClient/dialogs.py Outdated
Comment thread source/_remoteClient/menu.py Outdated
Comment thread source/_remoteClient/menu.py Outdated
Comment thread source/_remoteClient/menu.py Outdated
@LeonarddeR LeonarddeR closed this Apr 11, 2025
@LeonarddeR

LeonarddeR commented Apr 11, 2025

Copy link
Copy Markdown
Collaborator

Sorry for the close/reopen mess I made there.
Now that Terminologie is being looked at, I like to ask attention to the following.
There is still #3564. I wrote the RDAccess add-on for that. That add-on has a "remote desktop" category in settings, and mostly refers to remote desktop.
I'm considering donating at least parts of that add-on to core, but I expect a conflict in terminology. Any thoughts on that matter? Or may be that's more for a follow up. I'm bringing this up here because this seems to be a moment to discuss it.

@LeonarddeR LeonarddeR reopened this Apr 11, 2025
@CyrilleB79

Copy link
Copy Markdown
Contributor

"Mute remote" is still there, for "Mute remote computer". But maybe in menus, we want to keep something very short.

Unfortunately, to translate (French), we'll need to make something much longer. English language has the capability to precisely express an idea with very few words, but other languages are not so good at it...

Comment thread source/_remoteClient/localMachine.py Outdated
Comment thread source/gui/settingsDialogs.py Outdated
Comment thread source/gui/settingsDialogs.py
Comment thread source/gui/settingsDialogs.py Outdated
Comment thread source/gui/settingsDialogs.py Outdated
Comment thread source/gui/settingsDialogs.py Outdated
Comment thread user_docs/en/userGuide.md Outdated
Comment thread user_docs/en/userGuide.md Outdated
Comment thread user_docs/en/userGuide.md Outdated
Comment thread user_docs/en/userGuide.md Outdated
@seanbudd seanbudd added this to the 2025.1 milestone Apr 15, 2025
@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Apr 15, 2025
Comment thread source/gui/settingsDialogs.py Outdated
SaschaCowley and others added 2 commits April 16, 2025 15:02
Co-authored-by: Sean Budd <sean@nvaccess.org>
Co-authored-by: Sean Budd <sean@nvaccess.org>
@seanbudd
seanbudd marked this pull request as draft April 22, 2025 01:56
@SaschaCowley
SaschaCowley marked this pull request as ready for review April 23, 2025 04:36
Comment thread user_docs/en/userGuide.md Outdated
Comment thread source/globalCommands.py Outdated
Comment thread source/globalCommands.py Outdated
Comment thread source/globalCommands.py Outdated
Comment thread source/globalCommands.py Outdated
Comment thread source/_remoteClient/menu.py Outdated
Comment thread source/_remoteClient/client.py Outdated
Comment thread source/_remoteClient/cues.py Outdated
Comment thread source/_remoteClient/cues.py Outdated
Comment thread source/_remoteClient/menu.py Outdated
SaschaCowley and others added 2 commits April 24, 2025 13:03
@SaschaCowley
SaschaCowley requested a review from seanbudd April 24, 2025 03:11

@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.

UserGuide Reads well!

@seanbudd
seanbudd merged commit d6fb03e into beta Apr 28, 2025
@seanbudd
seanbudd deleted the remoteTerminology branch April 28, 2025 00:48
seanbudd pushed a commit that referenced this pull request May 4, 2025
…18038)

Summary of the issue:
In the user guide section for the Remote Access automatic connection mode, the definitions for "Control another computer" and "Allow this computer to be controlled" were swapped.

Description of user facing changes
The definitions have been swapped, so they are now correctly paired.
"machine" has been replaced with "computer" per Fix up user-facing Remote Access terminology #17943.
Description of development approach
Modify the table in user_docs/en/userGuide.md.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Consistant name for NVDA remote in NVDA

5 participants