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

Resolve inconsistent use of headers #680

Open
wenkokke opened this issue Jun 9, 2022 · 0 comments
Open

Resolve inconsistent use of headers #680

wenkokke opened this issue Jun 9, 2022 · 0 comments
Labels
accessibility Relates to accessibility. bug Something is broken. markup Issues with the use of markup.

Comments

@wenkokke
Copy link
Collaborator

wenkokke commented Jun 9, 2022

For screen readers, LaTeX and EPUB, and many other ways to read the book that aren’t simply a live website, it is important that headers are used consistently, i.e., starting at h1 and increasing by one header level at a time.

Our current convention always uses h4 for exercises, which leads to inconsistent increases, often jumping from h2 to h4.

If there’s no current use of h3, we could simply lift all exercises. Otherwise, we may have to find another way of marking exercises, without using headers—at least in the generated HTML.

If we need to systematically rewrite these, we can rely on—and codify—the convention that “#### Exercise” is always used for exercises.

@wenkokke wenkokke added bug accessibility Relates to accessibility. bug Something is broken. markup Issues with the use of markup. and removed bug labels Jun 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accessibility Relates to accessibility. bug Something is broken. markup Issues with the use of markup.
Projects
None yet
Development

No branches or pull requests

1 participant