Skip to content

Enhance Microsoft Excel notes command: Press twice to present notes content in browsable message.#16878

Merged
seanbudd merged 5 commits into
nvaccess:masterfrom
cary-rowen:BrowsableCommentForExcel
Jul 18, 2024
Merged

Enhance Microsoft Excel notes command: Press twice to present notes content in browsable message.#16878
seanbudd merged 5 commits into
nvaccess:masterfrom
cary-rowen:BrowsableCommentForExcel

Conversation

@cary-rowen

@cary-rowen cary-rowen commented Jul 18, 2024

Copy link
Copy Markdown
Contributor

Link to issue number:

Fixed #14628
Replaces abandoned #15986
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).
Additionally, I added a type hint for the gestures.

Testing strategy:

Manual testing

Known issues with pull request:

Code Review Checklist:

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

Summary by CodeRabbit

  • New Features

    • Enhanced Microsoft Excel notes command: press twice to present notes content in a browsable message.
    • Separate reporting of font attributes in speech and braille.
  • Documentation

    • Updated user guides to reflect new Excel notes command functionality and terminology changes.

@cary-rowen cary-rowen requested review from a team as code owners July 18, 2024 01:37
@coderabbitai

coderabbitai Bot commented Jul 18, 2024

Copy link
Copy Markdown
Contributor

Walkthrough

The changes enhance the Microsoft Excel functionality in NVDA by allowing users to press a key combination twice to present notes content in a browsable message. This feature addresses the need to navigate long comments in Excel more effectively. Additionally, NVDA can now report font attributes in speech and braille separately.

Changes

Files Change Summary
source/NVDAObjects/window/excel.py Added import for inputCore and modified script_reportComment to handle script repeats and display different messages based on repeat count.
user_docs/en/changes.md Documented the enhanced Excel notes command and the ability to report font attributes separately.
user_docs/en/userGuide.md Updated to include details on the new functionality of displaying notes in a browsable message and the renaming of comments to "notes" in Excel.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant NVDA
    participant ExcelObject

    User->>NVDA: Press NVDA+Alt+C
    NVDA->>ExcelObject: Call script_reportComment(gesture)
    ExcelObject-->>NVDA: Report comment text

    User->>NVDA: Press NVDA+Alt+C (Repeat)
    NVDA->>ExcelObject: Call script_reportComment(gesture)
    ExcelObject-->>NVDA: Display browsable dialog with comment text
Loading

Assessment against linked issues

Objective Addressed Explanation
Enhance 'Reports the text of the comment' to support opening in a browsable dialog (#14628)
Document the new feature and changes in user guides and change logs (#14628)

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Comment thread source/NVDAObjects/window/excel.py Outdated
Comment thread source/NVDAObjects/window/excel.py Outdated
Comment thread user_docs/en/changes.md Outdated
Comment thread user_docs/en/userGuide.md Outdated
@cary-rowen

Copy link
Copy Markdown
Contributor Author

I noticed @SaschaCowley helped me make these suggested changes. Many thanks!

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

Userguide looks good, great work Cary!

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.

Feature request: 'Reports the text of the comment where the System caret is located.' supports opening in a browsable dialog

4 participants