Skip to content

Document axe standard and best-practice options#2105

Draft
cwickham wants to merge 2 commits into
prereleasefrom
axe-standard-option-docs
Draft

Document axe standard and best-practice options#2105
cwickham wants to merge 2 commits into
prereleasefrom
axe-standard-option-docs

Conversation

@cwickham

Copy link
Copy Markdown
Member

Documents the new axe scoping options for Quarto 1.10 on docs/output-formats/html-accessibility.qmd:

  • New section "Checking against a WCAG conformance level": the standard option (nine WCAG version+level values, cumulative semantics), its two side effects (default-disabled rules for the chosen level run, e.g. AAA contrast and WCAG 2.2 target size; best-practice rules are excluded), and best-practice: true/false in both combinations. Links axe-core's rule descriptions for the full rule list.
  • Updates the "Planned work" CDN sentence: axe-core is bundled with Quarto as of 1.10, so checks work offline.
  • Adds fig-alt to the two example screenshots — an axe site audit of this very page flagged them as missing alt text.

Documents quarto-dev/quarto-cli#14682 (standard/best-practice, quarto-dev/quarto-cli#14607) and quarto-dev/quarto-cli#14677 (vendored axe-core). Should merge after those land; draft until then.

Adds a section on scoping accessibility checks to a WCAG conformance
level (quarto-dev/quarto-cli#14607, quarto-dev/quarto-cli#14682) and
updates the CDN note now that axe-core is bundled with Quarto 1.10
(quarto-dev/quarto-cli#14677).

Also adds fig-alt to the two example screenshots — an axe site audit
of this page flagged them as missing alt text (the bracket text of a
figure becomes the caption, not the alt).
@cwickham

Copy link
Copy Markdown
Member Author

Note for before marking ready: the example screenshots (images/axe-violation.png, light/dark) show the current overlay and will be stale once the open quarto-cli axe PRs merge — quarto-dev/quarto-cli#14676 (violations sorted by severity/standard) and quarto-dev/quarto-cli#14680 (left-aligned overlay polish) both change how the report looks, and quarto-dev/quarto-cli#14604 (already merged) added the WCAG conformance labels the current screenshots predate. Redo them against a 1.10 prerelease build that includes the whole stack.

@github-actions

Copy link
Copy Markdown
Contributor

📝 Preview Deployment

🔍 Full site preview: https://deploy-preview-2105.quarto.org

🔄 Modified Documents

@github-actions

Copy link
Copy Markdown
Contributor

📝 Preview Deployment

🔍 Full site preview: https://deploy-preview-2105.quarto.org

🔄 Modified Documents

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant