Make UIA in MS Word optional again, through an Advanced Settings category#9200
Conversation
…eady. Rather, still allow it to be used byased on the useInMSwordWhenAvailable config option.
…tains all config options that were previously not accessible from the GUI. this includes: Use UIA in MS Word, caret movement timeout, and the debug log categories.
| "louis", | ||
| "timeSinceInput", | ||
| ): | ||
| checkbox=debugLogGroup.addItem(wx.CheckBox(self, label=key)) |
There was a problem hiding this comment.
Have you considered making this a checkable list? You can use the keyboard layouts list as an example.
|
|
||
| +++ Advanced Settings +++ | ||
| Warning! The settings in this category are for advanced users and may cause NVDA to not function correctly if configured in the wrong way. | ||
| Only make changes to these settings if you are sure you know what you are doing or if you have been specifically instrructed to by an NVDA developer. |
There was a problem hiding this comment.
instrructed = instructed
… and fixed typo in userGuide.
LeonarddeR
left a comment
There was a problem hiding this comment.
The code looks ok, just some user guide things
|
|
||
| ==== Use UI automation to access Microsoft Word document controls when available ==== | ||
| When this option is enabled, NVDA will try to use the Microsoft UI Automation accessibility api in order to fetch information from Microsoft Word document controls. | ||
| this includes in Microsoft Word itself, and also the Microsoft Outlook message viewer and composer. |
There was a problem hiding this comment.
Doesn't start with a capital T
| this includes in Microsoft Word itself, and also the Microsoft Outlook message viewer and composer. | |
| This includes documents in Microsoft Word itself, and also the Microsoft Outlook message viewer and composer. |
| ==== Use UI automation to access Microsoft Word document controls when available ==== | ||
| When this option is enabled, NVDA will try to use the Microsoft UI Automation accessibility api in order to fetch information from Microsoft Word document controls. | ||
| this includes in Microsoft Word itself, and also the Microsoft Outlook message viewer and composer. | ||
| For the most recent versions of Microsoft Office 2016/365 running on windows 10, UI Automation support is complete enough to provide access to Microsoft Word documents almost on par with NvDA's existing Microsoft Word support, with the added advantage that responsiveness is majorly increased. |
There was a problem hiding this comment.
What do you mean with "on par"? I assume it's a typo? Also, note the lower case v in NvDA's
There was a problem hiding this comment.
@LeonarddeR "on par" is used in golf, and at least quite commonly in Australia, apparently comes from Latin to mean equal to. As a suggestion, the phrase "feature parity" might be preferable.
| If you find that NVDA seems to be incorrectly tracking the caret E.g. it seems to be always one character behind or is repeating lines, then you may wish to try increasing this value. | ||
|
|
||
| ==== Debug logging categories ==== | ||
| The checkboxes in this group allow you to enable specific categories of debug messages in NVDA's log. |
There was a problem hiding this comment.
This is now a list instead of a group, though the list has its own group
|
Describing hwIo, audioDucking, gui, louis and timeSinceInput in the User Guide would be nice. |
|
@DrSooom: I don't think it will add anything useful. These are debug flags that should usually only be set when a developer asks you. If a user doesn't know what they mean, it is probably not necessary for that user to consider checking them. |
|
@LeonarddeR: That's right, but the user should be able to control and understand the developer's choice. In the end he always can (and should) read the log file before sending/uploading it. So updating this wiki article should be enough. I'm not sure if the User Guide contains links to wiki articles. If not, then the User Guide is already okay. Edit: And maybe parts of the wiki article Log Files and Crash Dumps should be updated too. |
| return True | ||
| if ( | ||
| versionMajor<minMSWordUIAVersion.major | ||
| or versionMajor==minMSWordUIAVersion.major and versionMinor==minMSWordUIAVersion.minor and versionBuild<minMSWordUIAVersion.build |
There was a problem hiding this comment.
I think we should leave in place checks that exclude versions that we know will not work. Though this should be reflected in the user guide; "This setting will not enable UIA in MS Word versions below 16.0.9000"
|
@feerrenrut If we did what you proposed, this would be a change to the
current behaviour in 2018.4. Enabling the option allows UIA to work in
MS Word where ever it is implemented. Which happens to be Office 2016.
True that the UIA implementation pre build 9000 had some bugs, it was
still quite usable.
Note also that even in master right now, if that option is manually
enabled, the version check is overridden and it will work for all of
Office 2016 builds.
I would prefer to keep it as is for now, as it is much easier for users
to understand "I have Office 2016" rather than "I have Office 2016 post
build 9000".
|
…e improvements due to UIA support. This was disabled by default in #9200.
Link to issue number:
None.
Summary of the issue:
NVDA switched to using UI Automation to access Microsoft Word document controls by default for Office 2016/365, however Office's UIA support is still not 100% complete.
This should be left optional for 2019.1 at least.
Description of how this pull request fixes the issue:
UIA is no longer used by default in MS Word. However, there is now a new Advanced Settings category in NVDA's settings dialog which contains a checkbox to turn this on for testing this feature out.
The Advanced Settings category also contains all other config options previously not in the GUI. these include caret movement timeout, and the Debug log categories.
Testing performed:
Tested each option in the Advanced settings category to ensure that their setting is remembered when opening the Settings dialog again, and that the option is truly activated / deactivated in NVDA itself.
Known issues with pull request:
Although there is a panel caption warning the user to be careful with these settings, it is not automatically read by NVDA when tabbing from the categories list into the settings themselves. This is similar to the Document Formatting settings caption which is also not read.
Change log entry:
New features:
A new Advanced Settings category has been added to NVDA's Settings dialog, including an option to try out NVDA's new support for Microsoft Word via the Microsoft UI Automation API.