Table of contents entries in the reference guide have no space between number and title for screen readers
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 70/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- css, html, javascript
- Domain
- accessibility, documentation
Research direction
Open wicket-user-guide/src/main/asciidoc/js/guide.js and read followSections(): it splits each TOC link into a span.toc-num plus a text node and drops the whitespace between them. Keep the space in the text node (e.g. append ' ' + match[2]), then remove the margin-right on .toc-num in wicket.css so the visual gap does not double. Build the guide and confirm the TOC looks unchanged and a link's accessible name reads "3. Why should I learn Wicket?". Coordinate with #1904, which edits the same lines and should land first.
Written by the indexing model from the issue text.
Description
The entries in the reference guide's table of contents have no space between the section number and the title in their text. Screen readers announce them as, for example, "3.Why should I learn Wicket?" and "13.4.Pageable repeaters".
The cause is followSections() in wicket-user-guide/src/main/asciidoc/js/guide.js. It splits each TOC link into a span.toc-num holding the number and a text node holding the title, and drops the whitespace in between. The visual gap comes from margin-right on .toc-num in wicket.css, so on screen it looks fine, but the link's text content and accessible name have no space. This was introduced in #1845.
The same text ends up in other names built from the link. In #1904 the disclosure buttons are labelled "Sections for 3.Why should I learn Wicket?".
Fix: keep the space in the text when the link is split up. One way is to append ' ' + match[2] instead of match[2] and drop the margin-right from .toc-num. Then check that the TOC still looks the same and that the accessible names read "3. Why should I learn Wicket?".
This touches the same lines in guide.js as #1904, so it should wait until #1904 is merged.
- Dominant language
- Java
- Stars
- 800
- Forks
- 423
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 170
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apache/wicket
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Fix dark-mode table headers and phone-width overflow in the reference guide's CSSPossibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
apache/wicket#1891 · 1 comment ·
Maintainers usually reply within 1 day
-
Document and enforce pull request review guidelinesPossibly taken @dashorst claimed this 7 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
COOP and COEP exemptions compare with the context path, so page exemptions never matchPossibly taken @asvanberg claimed this 25 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
apache/wicket#1661 · 1 comment · 1 reaction ·
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
Maintainers usually reply within 1 day
-
RIS export splits an organization name containing “and” into multiple authorsPossibly taken @Gautam-aman claimed this today. Openstatus: needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
JabRef/jabref#17821 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day