Skip to content

Make figure reporting configureable, and figures quick navigable#16176

Merged
seanbudd merged 11 commits into
nvaccess:masterfrom
SaschaCowley:figure_script
Feb 22, 2024
Merged

Make figure reporting configureable, and figures quick navigable#16176
seanbudd merged 11 commits into
nvaccess:masterfrom
SaschaCowley:figure_script

Conversation

@SaschaCowley

@SaschaCowley SaschaCowley commented Feb 14, 2024

Copy link
Copy Markdown
Member

Link to issue number:

fixes #10826
Fixes #14349

Summary of the issue:

It has hitherto not been possible to navigate by figure with quick navigation keys, or to disable the reporting of figures and captions.

Description of user facing changes

Added a script to jump to next/previous figure in browse mode. Added an option to disable the reporting of figures and captions, and a script to toggle this setting.

Description of development approach

Examined similar code and based new code on existing code.

Testing strategy:

Manually tested the changes using a demo page. Ran unit and translation tests.

Known issues with pull request:

Only tested to work in firefox, as there is a problem with figures in Chromium (#16137).

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.

@cary-rowen

cary-rowen commented Feb 14, 2024

Copy link
Copy Markdown
Contributor

Thanks for your efforts, this is great. I looked at the source code and noticed you assigned the y key to this, could you mention this gesture in the description?

@SaschaCowley

SaschaCowley commented Feb 14, 2024

Copy link
Copy Markdown
Member Author

I looked at the source code and noticed you assigned the y key to this, could you mention this gesture in the description?

Bother, I meant to remove this assignment before opening the PR. I shall remove it now, as I don't think most users will want this assigned by default.

@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Feb 19, 2024
@SaschaCowley SaschaCowley marked this pull request as ready for review February 20, 2024 22:46
@SaschaCowley SaschaCowley requested review from a team as code owners February 20, 2024 22:46
seanbudd
seanbudd approved these changes Feb 21, 2024
View reviewed changes
Comment thread source/globalCommands.py Outdated
Comment thread source/textInfos/__init__.py Outdated
Comment thread user_docs/en/changes.t2t Outdated
Comment thread user_docs/en/changes.t2t Outdated
Qchristensen
Qchristensen approved these changes Feb 22, 2024
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, great job Sascha!

@seanbudd seanbudd merged commit 96bf998 into nvaccess:master Feb 22, 2024
@nvaccessAuto nvaccessAuto added this to the 2024.2 milestone Feb 22, 2024
This was referenced Feb 23, 2024
Closed
Closed
@SaschaCowley

SaschaCowley commented Feb 28, 2024

Copy link
Copy Markdown
Member Author

Disabling reporting of figures and captions as implemented here also disables reporting of table captions. While usage is quite similar, I feel that users may want to be able to configure table caption reporting in table formatting settings. Thoughts, @Adriani90, @michaelDCurran?

@Adriani90

Adriani90 commented Feb 28, 2024

Copy link
Copy Markdown
Collaborator

There is issue #14874 which mostly leads to the reason in general why users would disable reporting of captions. This also affects table captions.
I agree though table captions should be treated separately in the table formating settings.
For captions which span on multiple lines, In my view hearing the "title" from captions when navigating to them might be useful, but if I navigate the caption with arrow keys then i expect NVDA to report "title" only when entering the caption and "end of title" when leaving the caption.
However, this affects also other elements displayed on multiple lines such as links, buttons etc.

Adriani90 pushed a commit to Adriani90/nvda that referenced this pull request Mar 13, 2024
@SaschaCowley @Adriani90
Make figure reporting configureable, and figures quick navigable (nva…
f723272 
…ccess#16176)

fixes nvaccess#10826
Fixes nvaccess#14349

Summary of the issue:
It has hitherto not been possible to navigate by figure with quick navigation keys, or to disable the reporting of figures and captions.

Description of user facing changes
Added a script to jump to next/previous figure in browse mode. Added an option to disable the reporting of figures and captions, and a script to toggle this setting.

Description of development approach
Examined similar code and based new code on existing code.
@SaschaCowley SaschaCowley deleted the figure_script branch August 22, 2024 05:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@seanbudd seanbudd seanbudd approved these changes

@Qchristensen Qchristensen Qchristensen approved these changes

Assignees

No one assigned

Labels

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

Projects

None yet

Milestone

2024.2

6 participants

@SaschaCowley @cary-rowen @Adriani90 @seanbudd @Qchristensen @nvaccessAuto