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

Accessibility issues with HTML publishing of "Backlinks" and "Children" #3369

Open
1 of 7 tasks
kap42 opened this issue Aug 10, 2022 · 4 comments
Open
1 of 7 tasks

Accessibility issues with HTML publishing of "Backlinks" and "Children" #3369

kap42 opened this issue Aug 10, 2022 · 4 comments
Assignees
Labels
scope.publish Static site generation, sending note links and anything to do with publishing your notes. type.bug Something isn't working

Comments

@kap42
Copy link

kap42 commented Aug 10, 2022

Please select the area your bug applies to. (Multiple selections are Possible. You can leave blank if you're not sure.)

  • Workspace. VSCode workspace, vaults, Intellisense/autocomplete, Dendron settings
  • Lookup. Dendron's Lookup Command
  • Views. Dendron Preview, Tree View, Side Panels in the UI
  • Schema. Dendron Schemas
  • Pod. Data import from / export to Dendron
  • Publish. External Site Publish
  • Markdown. Markdown features, such as syntax support and features

Describe the bug

The headings for "Backlinks" and "Children" in the HTML output are rendered as "<strong>", but for accessibility reasons, they should use headings. This is important for things like screen readers, where the headings are used for quick navigation on a page.

To Reproduce

Steps to reproduce the behavior:

  1. Go to any documentation page that have backlinks and/or children.

Expected behavior

There should be headings instead of plain <strong>.

Screenshots

If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information)

  • OS: Windows 11
  • Browser: Chrome
  • Versions (all that apply to bug):
    • Dendron Extension: 0.106.0
    • VS Code version: 1.69.2
    • Dendron CLI: 0.106.0

Additional context

Add any other context about the problem here.

Dendron Log file

Please attach the output of > Dendron:Dev: Open Logs here
dendron.log

@github-actions github-actions bot added scope.publish Static site generation, sending note links and anything to do with publishing your notes. status.triage-needed type.bug Something isn't working labels Aug 10, 2022
@hikchoi
Copy link
Contributor

hikchoi commented Aug 11, 2022

Thank you for the report. We'll keep track of this and let you know when this gets resolved.

@Harshita-mindfire
Copy link
Contributor

This was a breaking change introduced in Dendron v0.76: https://wiki.dendron.so/notes/MQpi87qLnzKK5iK3FlxUp/#breaking-changes

@namjul
Copy link
Contributor

namjul commented Aug 26, 2022

Do we have a papertrail to the source of that change made in v0.76. It seems the idea behind that change was to remove it from the toc section. So maybe this issue is about replacing back to headings but not getting shown inside the toc section.

@kap42
Copy link
Author

kap42 commented Aug 26, 2022

If headings aren't a good fit, then you might use ARIA's "role=heading". See: https://www.w3.org/TR/WCAG20-TECHS/ARIA12.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope.publish Static site generation, sending note links and anything to do with publishing your notes. type.bug Something isn't working
Projects
None yet
Development

No branches or pull requests

4 participants