Skip to content

Rewrote and expanded the Browse mode: Use Screen Layout section in the user guide to correct missing information#13373

Merged
seanbudd merged 2 commits into
nvaccess:masterfrom
XLTechie:screenLayoutRewrite
Mar 4, 2022
Merged

Rewrote and expanded the Browse mode: Use Screen Layout section in the user guide to correct missing information#13373
seanbudd merged 2 commits into
nvaccess:masterfrom
XLTechie:screenLayoutRewrite

Conversation

@XLTechie

@XLTechie XLTechie commented Feb 22, 2022

Copy link
Copy Markdown
Collaborator

Link to issue number:

Addresses a concern raised in #13354

Summary of the issue:

In this comment, @CyrilleB79 pointed out that the user guide does not indicate that screen layout is always used in Outlook, irrespective of the "Use screen layout" setting.
It seems reasonable for the user to assume, since it isn't otherwise indicated, that turning off screen layout will be effective anywhere browse mode is used, when in fact this is not the case.

Description of how this pull request fixes the issue:

I added a note to the section in the user guide, explaining that this option is not applicable to Microsoft Office applications.

While looking at the section, I thought that it didn't really explain well the difference between screen layout and not screen layout, and used terms like "fields" in a way that most users might not associate with the elements changed by the option.

Testing strategy:

N/A

Known issues with pull request:

I'm not convinced that the result is the best way to present screen layout or the option, but I think it is preferable to what was there, at least until something better comes along.

Change log entries:

User Guide: Improved the explanation of the browse mode "Use screen layout" option, now including that it doesn't apply to Outlook, Word, etc.

Code Review Checklist:

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

@XLTechie

Copy link
Copy Markdown
Collaborator Author

CC @Qchristensen

@XLTechie XLTechie marked this pull request as ready for review February 22, 2022 02:42
@XLTechie XLTechie requested a review from a team as a code owner February 22, 2022 02:42
@AppVeyorBot

Copy link
Copy Markdown

See test results for failed build of commit 52bee3df28

@XLTechie

This comment was marked as resolved.

Comment thread user_docs/en/userGuide.t2t Outdated
…the user guide.

* The primary focus was to add a note explaining that the option is inapplicable for Microsoft Office apps. (Per comment on #13354)
* Removed extraneous words ("content in", first sentence), and fixed plural-singular errors.
* Generally expanded the section to better explain the option, and give an example.
@CyrilleB79

Copy link
Copy Markdown
Contributor

Actually, it would be nice to review the User guide for all the options of Browse mode settings.

  • Some apply to browse mode as the window title says, e.g. Audio indication of form mode.
  • Some other only apply to virtual buffers, i.e. not Word or Outlook, e.g. Number of line per page.
  • And some apply to Outlook and browsers but not to Word, e.g. Enable browse mode on page load.

Or better, it would be nice to split the options of this window in two groups, one for browse mode (including Word and Outlook) and one only for virtual buffers in browsers.

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

Thanks @XLTechie for the PR and @CyrilleB79 for your insight as well! The idea of rewriting the Browse mode section of the User Guide came up recently and I have intentions of going through it in more detail.

In the meantime, great work on this.

@seanbudd seanbudd merged commit 2325be8 into nvaccess:master Mar 4, 2022
@nvaccessAuto nvaccessAuto added this to the 2022.1 milestone Mar 4, 2022
@XLTechie XLTechie deleted the screenLayoutRewrite branch March 15, 2022 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants