quarto-dev / quarto-dev/quarto-cli
Accessibility suggestions: Footers, table of contents, and headers
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 6k
- Forks
- 458
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 41
Description
This issue came up in the review of the accessible cheatsheets, see https://github.com/mine-cetinkaya-rundel/accessible-cheatsheets/issues/2#issuecomment-1095384374 for the original issue.
The following is a simplified version of the HTML output with format: html and toc: true:
<!DOCTYPE html>
<html lang="en">
<head>
<title>Document Title</title>
</head>
<body>
<div id="quarto-content">
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
TABLE OF CONTENTS...
</div>
<main class="content" id="quarto-document-content">
<header id="title-block-header" class="quarto-title-block default">
<div class="quarto-title">
<h1 class="title">Document Title</h1>
</div>
</header>
DOCUMENT TEXT...
</main>
</div>
</body>
</html>
Three accessibility suggestions are:
- Make
footeravailable to HTML output via the yaml (likepage-footerfor websites, for example). - Move the table of contents into the
header. - Move the
headeroutside ofmain.
Similar to #1030, (2) and (3) might be things to address in Pandoc. I'm guessing (1) is addressable in Quarto.
Contributor guide
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.
Research direction
Start by tracing the HTML output produced with format: html and toc: true, then compare the requested footer configuration with the related Pandoc concerns in the issue. Done means determining which of the three accessibility changes belongs in Quarto versus Pandoc and implementing or clearly scoping the applicable output changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- accessibility
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100