Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restore numbering for TOC, add TOC to keyCommands #16226

Merged
merged 10 commits into from Feb 28, 2024
Merged

Restore numbering for TOC, add TOC to keyCommands #16226

merged 10 commits into from Feb 28, 2024

Conversation

seanbudd
Copy link
Member

@seanbudd seanbudd commented Feb 26, 2024

Link to issue number:

Fixes #16059
Closes #16106

Summary of the issue:

Due to markdown limitations, numbered headings and a numbered table of contents was removed from the user and dev guide when migrating from t2t to markdown.
However, these can be restored with CSS.

Description of user facing changes

Restores numbered headings to the table of contents and the headings within the user guide and developer guide.

Added TOC to key commands guide. Numbered heading are avoided as they don't match the user guide and may be misleading.

Description of development approach

Testing strategy:

Generated docs and compared to 2023.3 documentation for english and arabic.
Compared dev guide, changes, key commands and the user guide.

Known issues with pull request:

None

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.

@seanbudd seanbudd added this to the 2024.1 milestone Feb 26, 2024
@seanbudd seanbudd marked this pull request as ready for review February 26, 2024 04:48
@seanbudd seanbudd requested a review from a team as a code owner February 26, 2024 04:48
@seanbudd seanbudd requested review from michaelDCurran and removed request for a team February 26, 2024 04:48
@AppVeyorBot
Copy link

See test results for failed build of commit 7f27720d43

michaelDCurran
michaelDCurran previously approved these changes Feb 26, 2024
Copy link
Member

@michaelDCurran michaelDCurran left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assuming this works okay with rtl, then this looks okay to me.
One thing just to note though is that in comparison with the 2023.3 user guide, the numbers in the table of contents now appear in place of the bullets, rather than inside the links. I don't necessarily have an issue with this, but just pointing it out.

@seanbudd
Copy link
Member Author

@michaelDCurran - I've fixed RTL languages for the TOC, unfortunately there is unexpected behaviour for arabic-indic numbers when using counters for automatic nested/recursive counters, so we have to define our own manual nesting for each level

@seanbudd
Copy link
Member Author

One thing just to note though is that in comparison with the 2023.3 user guide, the numbers in the table of contents now appear in place of the bullets, rather than inside the links.

This could easily be fixed if it's a better idea. I might run it by quentin as there is a visual difference, I find keeping it out of the link tag visually nicer but it's definitely a preference thing

@AppVeyorBot
Copy link

See test results for failed build of commit 3e8de111e5

@seanbudd seanbudd merged commit 07ec0a5 into beta Feb 28, 2024
3 checks passed
@seanbudd seanbudd deleted the fix-TOC branch February 28, 2024 02:41
Adriani90 pushed a commit to Adriani90/nvda that referenced this pull request Mar 13, 2024
Fixes nvaccess#16059
Closes nvaccess#16106

Summary of the issue:

Due to markdown limitations, numbered headings and a numbered table of contents was removed from the user and dev guide when migrating from t2t to markdown.
However, these can be restored with CSS.

Description of user facing changes

Restores numbered headings to the table of contents and the headings within the user guide and developer guide.

Added TOC to key commands guide. Numbered heading are avoided as they don't match the user guide and may be misleading.
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.

None yet

3 participants