Enhance Microsoft Word Comment Command: Press Twice to Present Comment Content in Browsable message. #16800
Conversation
…t Content in Browsable message.
WalkthroughThe changes in the NVDA screen reader's codebase enhance the functionality of scripts in Microsoft Word documents. Specifically, the updates enable better interaction with the system caret and comments, allowing users to open comments in a browsable dialog on a repeated key press and providing improved message handling based on script repetitions. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant NVDA
participant WordDocument
User->>+NVDA: Press NVDA + Alt + C
NVDA->>+WordDocument: Fetch comment text where caret is located
WordDocument-->>-NVDA: Return comment text
NVDA->>-User: Report comment text
User->>+NVDA: Press NVDA + Alt + C again
NVDA->>+WordDocument: Fetch comment text where caret is located
WordDocument-->>-NVDA: Return comment text
NVDA->>+User: Open browsable dialog with comment text
Assessment against linked issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Co-authored-by: Sean Budd <[email protected]>
Co-authored-by: Sean Budd <[email protected]>
|
Thanks @cary-rowen |
|
@cary-rowen can you confirm you've tested the latest changes you've pushed? |
|
I wonder if we cannot propose another UX here, e.g.:
This would allow to navigate in the comment, but also in the answers of the comment. Also, it's worth noting that there are various issues related to Word comments (#14985, #9685, #4336). The use case of comments with replies is much less common than single comments. But should we really continue to ignore it totally in the UX. Of course, a third path can be to merge this PR as is and to modify again the UX when the other issues are handled, with the risk though that users used to the new UX provided in this PR (the browseable message) be disappointed if it is removed in the future. It should be NV Access decision (@seanbudd, @Qchristensen), but I just write this here to have all the related issues in mind for everyone. |
|
cc @seanbudd
|
|
Hi @CyrilleB79
I just to confirm, by "comment area" you mentioned here, do you mean "sidetrack" which can be focused with Alt+F12?
Yes, I'm aware of these reported issues as well, especially #14985 which deserves to be fixed in a separate PR. Regarding the UX considerations you mentioned, I'd also like to hear NV Access's thoughts. Especially if Alt+F12 can focus the sidetrack. |
See test results for failed build of commit 4fdf7880a8 |
seanbudd
added
the
blocked/needs-product-decision
On my end, |
|
Hi @CyrilleB79 Due to the differences between Office versions, I'm not quite sure what we can do in this PR to unify the UX. Whether it is Office365 or 2016, Office seems to have native shortcut keys for focusing on the comment area. NVDA users will not be unfamiliar with browsable dialog. For NVDA, such browsable message are used very widely, such as report formatting information. @seanbudd Any idea? |
seanbudd
added
conceptApproved
|
we are happy to accept this as-is. In the future we can consider performing alt+f12 on triple press |
See test results for failed build of commit 01ff017f55 |
|
@cary-rowen wrote:
Actually, I didn't know that there were a native shortcut to edit a comment in Word 365. I do not know of an equivalent shortcut in Word 2016, except of course the sequential one corresponding to what is found in the ribbon. @cary-rowen also wrote:
I agree that the browseable message is very familiar for NVDA users and is probably easier to navigate than Word's native comment area. If possible, a second step (in a separate PR) could be to add the replies in the browseable message, in HTML, with separators between each one. |
|
Please disregard previous comment Can you please fix the lint @cary-rowen - I'm not sure what's wrong with the lint artifacts, can you run |
|
Hi @seanbudd |
|
Hi @CyrilleB79 Thank you for your previous thoughts in bringing these existing issues to the attention of the community.
This is a good idea. I find it very useful. |
|
@cary-rowen - is that after merging the latest master? There really shouldn't be that many changes. |
See test results for failed build of commit 5a6bf0ea46 |
|
@cary-rowen - see the lint results here: https://ci.appveyor.com/project/NVAccess/nvda/builds/50189139#L5378 |
For Git for Windows, it seems that even if you merge the latest master, the local files don't update to the end of the LF line. It also doesn't seem to create new commits after committing those changes though? My git settings should be checkout as is. |
Link to issue number:
Partially fixed #14628
Replaces abandoned #15987
Thanks to @tseykovets for most of the work.
Summary of the issue:
Sometimes the text of comment is too long, in order to understand, we may need to navigate by sentence or by word.
Description of user facing changes
This pull request adds the ability to present the text of a comment in browse mode by pressing command twice (NVDA+Alt+C).
Description of development approach
A handler for the number of presses has been added to the script (if repeats).
If pressed twice, presents the information in browse mode (ui.browseableMessage).
Testing strategy:
Tested manually in Microsoft Word.
Known issues with pull request:
Unknown
Code Review Checklist:
Summary by CodeRabbit