Document axe standard and best-practice options - #2105
Conversation
|
Note for before marking ready: the example screenshots ( |
📝 Preview Deployment🔍 Full site preview: https://deploy-preview-2105.quarto.org 🔄 Modified Documents |
📝 Preview Deployment🔍 Full site preview: https://deploy-preview-2105.quarto.org 🔄 Modified Documents |
📝 Preview Deployment🔍 Full site preview: https://deploy-preview-2105.quarto.org 🔄 Modified Documents |
📝 Preview Deployment🔍 Full site preview: https://deploy-preview-2105.quarto.org 🔄 Modified Documents |
📝 Preview Deployment🔍 Full site preview: https://deploy-preview-2105.quarto.org 🔄 Modified Documents
|
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).
686ca81 to
ecd4379
Compare
📝 Preview Deployment🔍 Full site preview: https://deploy-preview-2105.quarto.org 🔄 Modified Documents |
📝 Preview Deployment🔍 Full site preview: https://deploy-preview-2105.quarto.org 🔄 Modified Documents |
- Promote the interactive workflow to its own section and move the example up into it, with a new DevTools console screenshot for the default axe: true output - Rename Customization to Output location and attach the existing overlay screenshots to output: document - Reframe Planned work as Site-wide accessibility checks - Add capture-axe-devtools.mjs (window-ID capture of headed Chromium with DevTools open) and a console.qmd example page
Adds a manual array to manifest.json for screenshots capture.js can't produce (currently axe-console, which needs the DevTools panel). The schema validates entries, --list and list.js show them, and --name <manual-entry> points at the producing script instead of failing.
3a123d8 to
59e721f
Compare
📝 Preview Deployment🔍 Full site preview: https://deploy-preview-2105.quarto.org 🔄 Modified Documents |
|
@cderv I ended up re-working this page to clarify the structure, but that involved a new screenshot that didn't fit great in the existing screenshotting infrastructure. I'm merging now so I can refer to this in the 1.10 blog post, but you might want to take a look at the changes I made in |
|
Successfully created backport PR for |
* Document axe standard and best-practice options 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). * Clarify that choosing a standard never adds deprecated rules * Update axe overlay fig-alt to describe severity and conformance label * Add prerelease callout for 1.10 axe options * Remove prerelease callout shortcode * Replace introduced-in callout notes with prerelease-callout shortcodes * Simplify * Dedent best-practice YAML example left over from removed bullet list * Reorganize accessibility page around interactive and site-wide checks - Promote the interactive workflow to its own section and move the example up into it, with a new DevTools console screenshot for the default axe: true output - Rename Customization to Output location and attach the existing overlay screenshots to output: document - Reframe Planned work as Site-wide accessibility checks - Add capture-axe-devtools.mjs (window-ID capture of headed Chromium with DevTools open) and a console.qmd example page * Register manual captures in the screenshot manifest Adds a manual array to manifest.json for screenshots capture.js can't produce (currently axe-console, which needs the DevTools panel). The schema validates entries, --list and list.js show them, and --name <manual-entry> points at the producing script instead of failing. (cherry picked from commit 6979d02) Co-authored-by: Charlotte Wickham <charlotte.wickham@posit.co>
1 participant
Documents the new
axescoping options for Quarto 1.10 ondocs/output-formats/html-accessibility.qmd:standardoption (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), andbest-practice: true/falsein both combinations. Links axe-core's rule descriptions for the full rule list.fig-altto 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.