BookStack icon indicating copy to clipboard operation
BookStack copied to clipboard

Headings hierarchy could be improved/cleaned for better accessibility (a11y)

Open JocelynDelalande opened this issue 1 year ago • 0 comments

Describe the Bug

Headings hierarchy of content pages have several issues and makes title-based navigation (very common with srceen-reader navigation) difficult. Issues are :

  • Links to books/chapters/pages in « Book navigation » should not be marked up as headings, but rather as bare links in ul / li
  • Details / Actions / Page navigation / Book navigation are <h5>, which is a cosmetic rather than structural use of titles level and breaks title navigation ; should probably be h2 ?
  • h1 includes website title (which is legit in <title> but maybe not in <h1>, probably minor issue if issue at all)
  • in some pages, Details/Actions h5. headings (which are navigation, not content) get « absorbed » into the last content section (see second screenshot, which is from another, private, page).

The heading hierarchy of the content part itself is good though :)

Steps to Reproduce

Open any content page of a BS wiki. (example of the issue with [a page of GRAP wiki](https://librairie.grap.coop/books/odoo-v12/page/un-mot-sur-odoo-et-grap page) )

Expected Behaviour

Use more accessibility-friendly headings hierarchy ; see different possible layouts at w3 website . Remove some heading tags (book nagivation links).

Screenshots or Additional Context

Headings map extension can be used to debug such issues

Good luck with that, and thanks by advance for taking that topic into consideration <3

Browser Details

No response

Exact BookStack Version

v23.08.3

JocelynDelalande avatar Apr 10 '24 11:04 JocelynDelalande