nvda icon indicating copy to clipboard operation
nvda copied to clipboard

Incompatible add-on dialog messages updated to be more end-user friendly

Open XLTechie opened this issue 2 years ago • 5 comments

Note to Reef/Sean: the commit should be complete for merging, without needing the text of the PR pasted in.

Link to issue number:

Closes #13632

Summary of the issue:

It was thought by some users and developers, that the messages shown when an add-on can not be installed because of being too young or old for the current NVDA version (by indicating API version), were overly developer centric.

Specifically, one of the messages had the potential, if not read with great care and some understanding of NVDA internals, to make users think that the add-on was compatible with the current version of NVDA, even though it wasn't, thus causing confusion as to why it wasn't installable.

Description of how this pull request fixes the issue:

The messages have been updated to present more end-user friendly information, although at the cost of exactitude in the case of the add-on too old message.

Sample of the revised add-on too old for NVDA dialog:

Installation of this add-on has been blocked. Add-on Name version #.# is too
old to work with your version of NVDA.
The add-on is only compatible through the 2021 NVDA series. Please
download a newer version, or contact the add-on's author: Firstname Lastname
<email>, to ask for an update.

Sample of the revised add-on too new for NVDA dialog:

Installation of this add-on has been blocked. Your version of NVDA (2022.2)
is too old to support Add-on Name version #.#.
Please update NVDA to at least version 2025.1, to use this version of
Add-on Name.

Testing strategy:

  • Attempted to install an add-on which was too old for the current NVDA version. Sample: Dev Helper 1.4.
  • Created, and attempted to install, a version of the Numpad Nav Mode add-on, configured for a version of NVDA which does not yet exist. Available here.

Known issues with pull request:

Regarding the add-on too old for NVDA dialog: I am not really satisfied with the presentation of the last supporting NVDA version by year only. However, without a map of NVDA versions to API supported versions being carried somewhere in core, there seems no convenient way to provide an exact final version.

Naturally, such a mapping could be created, but then it must be maintained. I don't think that is desirable. If the current pattern of only breaking API compat on year.1 versions continues, this should only prove incorrect for 2019.3.1 situations, and we're far past that.

Change log entries:

Changes

The dialogs shown when an add-on can not be installed because it is incompatible, have been revised so they are easier to understand by end users. (#13632)

Code Review Checklist:

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

XLTechie avatar May 09 '22 03:05 XLTechie

  • PASS: Translation comments check.
  • PASS: Unit tests.
  • FAIL: Lint check. See test results for more information.
  • FAIL: System tests. See test results for more information.
  • Build (for testing PR): https://ci.appveyor.com/api/buildjobs/yj6p3y7qmcjei4pl/artifacts/output/nvda_snapshot_pr13673-25369,a9a37a4f.exe

See test results for failed build of commit a9a37a4fab

AppVeyorBot avatar May 09 '22 04:05 AppVeyorBot

  • PASS: Translation comments check.
  • PASS: Unit tests.
  • PASS: Lint check.
  • FAIL: System tests. See test results for more information.
  • Build (for testing PR): https://ci.appveyor.com/api/buildjobs/qachvyghr6xb9rfd/artifacts/output/nvda_snapshot_pr13673-25370,f005b199.exe

See test results for failed build of commit f005b19975

AppVeyorBot avatar May 09 '22 04:05 AppVeyorBot

Requested a review from @Qchristensen to provide feedback on the new dialog text (see PR description).

seanbudd avatar May 09 '22 23:05 seanbudd

After some conversation with @feerrenrut in #13632, I have decided to try another approach, rather than the "The add-on is only compatible through the 2021 NVDA series." message for add-ons that are too old. Marking as draft until the code is revised.

XLTechie avatar May 13 '22 10:05 XLTechie

Blocked by #13985

seanbudd avatar Aug 08 '22 08:08 seanbudd

@XLTechie - can this be closed now that https://github.com/nvaccess/nvda/pull/13985 is merged? Do these strings still need improving?

seanbudd avatar Jun 13 '23 04:06 seanbudd

I forgot about this one. It is no longer relevant.

XLTechie avatar Jun 13 '23 08:06 XLTechie