Replaced messages, items and dialog title relating to comments in excel to refer to notes, plus some userguide work#11311
Conversation
…el, they are called notes. Support for new style comment is not added in NVDA yet
|
@feerrenrut, @LeonarddeR could you take a look at this before I request an official review? I think this is something that should be discussed in general, since this issue is somehow blocked until NVDA supports the new style comments in MS Excel (see #9195). Perhaps this can more easily be fixed if an appmodule can support different versions of an app. |
This comment has been minimized.
This comment has been minimized.
|
I got a flake8 error, ET128 (flake8-tabs) unexpected number of tabs and spaces at start of call line (expected 2 tabs and 23 spaces, got 3 tabs and 0 spaces). I think this specific error should be ignored since NVDA uses mostly tabs only in its code syntax. |
|
I don't see a need to have the keystroke for reading a note be specific to Excel. Can't we use NVDA+alt+c for comments/notes/etc everywhere? |
feerrenrut
left a comment
There was a problem hiding this comment.
It would be easier to review this as 3 separate PR's. Two of them could have been merged immediately. In future PR's please submit separate PR's for separate issues, even if the changes are small.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
I'm going to mark this PR as a draft for now. Please mark it "ready for review" when the CI and review comments have been addressed. Thanks for your work on this @Adriani90 |
|
@feerrenrut regarding script decorator, my understanding was that this should be preferably used when addin gestures to input gestures dialog. These gestures are not in the input gestures dialog as far as I can see. I've tried to convert some of them into script decorator, but I get a type error when I tried to convert the list of gestures for the script. changeSelection into script decorator for example. I tried this: I would be very grateful for some hint here ;) |
|
@Adriani90 wrote:
You should wrote this:
not this:
The second parameter passed to each script is not a list of al keyboard shortcuts to which it is assigned but the object re[presenting a gesture (in this case a key press) which invoked it. |
|
Thanks @lukaszgo1 for the clarification. I changed it, but there is still the same error, I have the feeling that this should be very trivial to fix, but I as a spare time python beginner am still struggling with simple things like this ;) |
|
Sorry for not noticing it when reading for the first time - I've assumed you've imported script from scriptHandler but it seems you haven't. You should decorate this method as follows: Also when listing all keyboard shortcuts to which this script is assigned it is a good idea to use tuple rather than list - as we do not need mutability in this case and tuple uses less memory. |
|
Thanks for the good tipp, I converted all the script decorators to touples, this solved the error. It seems it's because in Python 3 lists are not hashable, or at least this is how I understood it. |
|
Overall converting to script decorator saved almost 20 lines in that file. |
|
I tested in MS Excel 365 and 2010, all key strokes are working as expected and all messages are reported correctly (i.e. not on a note, cell x set as column header, etc.). |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
@Adriani90 I hope you are aware that you can run the lint check locally |
This comment has been minimized.
This comment has been minimized.
|
@feerrenrut thank you very much for the suggestion. Is there a possibility to specify in which file the lint should be performed? When I do base=origine/master it fetches all files and this takes very long time. |
|
You should do lint base=master not origin/master. Alternatively you should synchronize your remote master with the NV Access copy. |
This comment has been minimized.
This comment has been minimized.
|
So finally all the actions should be addressed now, the following problem still remains:
For the first problem, is it possible to copy the current controltype which is used and specify another label to it and say that this should be only used for MS Excel 2016 and newer? |
This comment has been minimized.
This comment has been minimized.
Fixes #18709 Follow-up of #11311 Summary of the issue: In Excel (legacy), when entering a cell with a note, Excel reports "Has comment". This is confusing since there are new threaded comment types in newer Excel versions. It was listed as a known issue of #11311. It's worth noting that with Excel UIA, NVDA already reports "Has note" in this case. Description of user facing changes: When moving the focus on a cell with a note, Excel now reports "Has note". It is consistent with NVDA's interface and User Guide which mention note everywhere else. Description of developer facing changes: N/A Description of development approach: Use the new HASNOTE state introduced since then instead of the HASCOMMENT state, as done for UIA.
Fix-up of #11311 ### Summary of the issue: In #11311, it was taken into account that older Excel comments were known as "notes" in newer interfaces, so NVDA's GUI and documentation has been updatedt to be consistent with newer versions. The "Comments" checkbox in the Document formatting settings panel has been updated to "Notes and comments" as part of this work. However, this checkbox does not control Excel's comments/notes reporting; it only controls whether comments in text, e.g. in Word, are reported. ### Description of user facing changes: This checkbox has been renamed back to "Comments" ### Description of developer facing changes: N/A ### Description of development approach: N/A ### Testing strategy: Manual check ### Known issues with pull request: One could argue that this checkbox should instead remain "Notes and comments" and should control Excel's Notes or comments. That's not my approach. And allowing to control "has notes" cell's property while "has formula" cannot be controlled would not be consistent.
Link to issue number:
fixes #10923
fixes #4864
Addresses discussions in #11153.
Summary of the issue:
Outdated system requirements and missing note for braille timeout.
The main issue addressed here however, is the new controltype in MS Excel since version 2016, which introduces new style comments, allowing for replying to comments and creating conversations on a specific cell or cell range. Thus, the comments as they were called in previous MS Office versions are now called "notes". The new style comment editing dialog is different from the notes editing dialog. The notes editing dialog is the former comments editing dialog, which remains also inaccessible in MS Office 2016, 365 and newer.
Description of how this pull request fixes the issue:
Testing performed:
Tested in MS Excel:
Tested in Microsoft Word and Powerpoint:
Known issues with pull request:
Other notes
Change log entry:
Section: Changes,