Skip to content

improve the input help message and gesture for the image descriptions#19088

Merged
seanbudd merged 18 commits into
nvaccess:masterfrom
tianzeshi-study:improve-gesture
Oct 14, 2025
Merged

improve the input help message and gesture for the image descriptions#19088
seanbudd merged 18 commits into
nvaccess:masterfrom
tianzeshi-study:improve-gesture

Conversation

@tianzeshi-study

Copy link
Copy Markdown
Contributor

Link to issue number:

Fixes #19073
Fixes #19069

Summary of the issue:

The input help message for the image description script doesn't descriptive enough.

The gesture for it is awkward in some case.

Description of user facing changes:

Change gesture for recognise image script from NVDA+Windows+, to NVDA+Windows+D

Make the input help message for recognise image script more descriptive.

Description of developer facing changes:

None

Description of development approach:

None

Testing strategy:

Use new gesture in input help mode.

Known issues with pull request:

None

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.

@wmhn1872265132

Copy link
Copy Markdown
Contributor

Please also update the following lines in changes.md:

You can now use NVDA+Windows+, to describe images you encounter.

@wmhn1872265132

Copy link
Copy Markdown
Contributor

The following content also needs to be updated:

Once the Image Captioner is ready, press the default shortcut NVDA+Windows+, to recognize the image currently navigated by NVDA.

@tianzeshi-study

Copy link
Copy Markdown
Contributor Author

Please also update the following lines in changes.md:

You can now use NVDA+Windows+, to describe images you encounter.

Thanks! I forgot it.

@CyrilleB79

Copy link
Copy Markdown
Contributor

While at it, I think that UI and User Guide may be reworded for clarity to distinguish between image description, image captioner, model, etc. What is the difference, from a user's point of view, between captioner and model?

For example, there is nothing automatic in current image description feature:

When this checkbox is enabled, NVDA will enable automatic image descriptions.
I'd rather write something like:
When this checkbox is enabled, NVDA will load the model in memory, enabling the use of the image description command.

@wmhn1872265132

Copy link
Copy Markdown
Contributor

please note:

CI/CD / Check translator comments (pull_request)Failing after 1m

Comment thread user_docs/en/changes.md Outdated
Comment thread user_docs/en/changes.md Outdated
Comment thread user_docs/en/changes.md Outdated
Comment thread user_docs/en/userGuide.md Outdated
@CyrilleB79

Copy link
Copy Markdown
Contributor

Regarding the wording (model / image captioner / image description), I have reviewed the code changed in this PR, but there is probably some other places to change to be consistent (GUI, script description, ...)

@seanbudd seanbudd requested review from seanbudd and removed request for SaschaCowley October 13, 2025 01:00
Comment thread source/globalCommands.py Outdated
Comment thread user_docs/en/changes.md Outdated
Comment thread user_docs/en/changes.md Outdated
seanbudd and others added 2 commits October 13, 2025 12:18
Co-authored-by: Cyrille Bougot <cyrille.bougot2@laposte.net>
Comment thread user_docs/en/userGuide.md Outdated
Comment thread user_docs/en/userGuide.md Outdated
Comment thread user_docs/en/userGuide.md Outdated
tianzeshi-study and others added 3 commits October 13, 2025 16:34
Co-authored-by: Cyrille Bougot <cyrille.bougot2@laposte.net>
Comment thread source/globalCommands.py Outdated
Comment thread user_docs/en/userGuide.md Outdated
Comment thread user_docs/en/userGuide.md Outdated
@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Oct 14, 2025
Comment thread user_docs/en/userGuide.md Outdated

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

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

Reads well.

@seanbudd seanbudd enabled auto-merge (squash) October 14, 2025 04:38
@seanbudd seanbudd merged commit 6c01c50 into nvaccess:master Oct 14, 2025
29 checks passed
@github-actions github-actions Bot added this to the 2026.1 milestone Oct 14, 2025
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.

Make the input help message for the recognise image script more descriptive Change image-description gesture from NVDA+Windows+, to NVDA+Windows+D

5 participants