Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Context Sensitive Help in NVDA Dialogs #7757

Closed
ThomasStivers opened this issue Nov 14, 2017 · 4 comments · Fixed by #11456, #11711 or #11743
Closed

Context Sensitive Help in NVDA Dialogs #7757

ThomasStivers opened this issue Nov 14, 2017 · 4 comments · Fixed by #11456, #11711 or #11743
Labels
feature
Milestone
2020.4

Comments

@ThomasStivers
Copy link
Contributor

Steps to reproduce:

  • NVDA has a well thought out user guide, but it is prohibitively long for new users. A new user needs to be able to get help relevant to what they are doing while they are working in various dialogs and controls with NVDA.
  • Some controls in NVDA preferences dialogs have long labels which cause them not to fit well visually (see The text for some options could be shortened #6345). These labels can be shortened if additional help for these controls is readily available with F1 or by pressing a Help button.

Expected behavior:

  1. Explicit anchors should be added to all sections of the NVDA User Guide so that it can be opened to the correct place when context help is invoked.
  2. When in an NVDA preference dialog a Help button should be available to open the NVDA User Guide for all controls in that dialog.
  3. Optionally, pressing F1 on any control within an NVDA Preference dialog should open the NVDA User Guide to the section describing the function of that specific control if one exists, or for the dialog if no explicit help exists.

Actual behavior:

Currently NVDA's preferences dialogs do not have a help button and do not respond to the F1 key. The NVDA User Guide explains NVDA's dialogs and controls in detail, but new users find it daunting to locate information quickly.

Similar issues which this is not:
@feerrenrut
Copy link
Contributor

This sounds like a good idea. Happy to accept a PR for this, though I would suggest the work is split into 3 PR's one for each of the points listed under expected behaviour.

@ThomasStivers ThomasStivers mentioned this issue Nov 15, 2017
Merged
@leonardder
Copy link
Collaborator

If we want to use context sensitive help from the user guide, I belief it would help a lot if we'd show the user guide in a ui.browseableMessage

@PratikP1
Copy link

@ThomasStivers commented:

  1. Optionally, pressing F1 on any control within an NVDA Preference dialog should open the NVDA User Guide to the section describing the function of that specific control if one exists, or for the dialog if no explicit help exists.

It seems like pulling up the entire user guide and pointing to specific sections for each control might be a more intensive process. I have thought for some time that NVDA help in the form of a long document, while extremely useful, is becoming less manageable from a usability perspective. I would encourage NVAccess to consider a modular approach to help and documentation that could support tutorial work as well as the current set of user documentation.

@josephsl
Copy link
Collaborator

josephsl commented Nov 20, 2017 via email •
edited by feerrenrut

feerrenrut pushed a commit that referenced this issue Dec 21, 2017
@ThomasStivers @feerrenrut
Added explicit anchors to section headings in the user guide. (PR #7762)
0f86440 
Explicit anchors to section headings in the user guide for use by context help.

Part of issue #7757
@Adriani90 Adriani90 mentioned this issue Jan 26, 2020
Closed
@feerrenrut feerrenrut mentioned this issue Aug 3, 2020
Merged
feerrenrut added a commit that referenced this issue Sep 9, 2020
@feerrenrut @ThomasStivers @leonardder
Context sensitive help (PR #11456)
423674e 
Fixes #7757
Fixes #8354
Supersedes PR #8355

Add initial support for opening the user guide at a particular section based on the context when the user presses F1 (in NVDA dialogs). For the sake of simplicity, this is done by opening the user guide in the browser. Unfortunately, this results in a lot of unnecessary verbosity. However, this is still quicker for the user than manually opening the user guide separately (also in a browser) and navigating to the chosen section manually. 

Co-authored-by: ThomasStivers <thomas.stivers@gmail.com>
Co-authored-by: Leonard de Ruijter <leonardder@users.noreply.github.com>
@nvaccessAuto nvaccessAuto modified the milestone: 2020.4 Sep 9, 2020
dawidpieper pushed a commit to dawidpieper/nvda that referenced this issue Sep 13, 2020
@feerrenrut @ThomasStivers
@leonardder @dawidpieper
Context sensitive help (PR nvaccess#11456)
90e89f3 
Fixes nvaccess#7757
Fixes nvaccess#8354
Supersedes PR nvaccess#8355

Add initial support for opening the user guide at a particular section based on the context when the user presses F1 (in NVDA dialogs). For the sake of simplicity, this is done by opening the user guide in the browser. Unfortunately, this results in a lot of unnecessary verbosity. However, this is still quicker for the user than manually opening the user guide separately (also in a browser) and navigating to the chosen section manually. 

Co-authored-by: ThomasStivers <thomas.stivers@gmail.com>
Co-authored-by: Leonard de Ruijter <leonardder@users.noreply.github.com>
@CyrilleB79 CyrilleB79 mentioned this issue Oct 1, 2020
Merged
@CyrilleB79 CyrilleB79 mentioned this issue Oct 9, 2020
Merged
feerrenrut added a commit that referenced this issue Nov 17, 2020
@CyrilleB79 @feerrenrut
Context help: support more controls and dialogs (PR #11743)
aecff99 
* Context help:
- Added missing helpId in some dialogs/panels
- Fixed some helpId
- Added calls to self.bindHelpEvent
- Fixed parameters (anchor) of some calls to self.bindHelpEvent
* Changed the behaviour with voice settings:
- if the setting is a standard setting, go to the paragraph that describes this specific setting in User Guide
- if the setting is not standard, i.e. specific to a third-party synth, go to speech settings in the User Guide
* Rewrite rate boost paragraph as per review comments.

Fixes #7757
Follow-up of #11456

No change log entry required.

Co-authored-by: Reef Turner <reef@nvaccess.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature
Projects
None yet
Milestone
2020.4
6 participants
@leonardder @feerrenrut @josephsl @ThomasStivers @PratikP1 @nvaccessAuto