repository·main·Indexed 23 days ago
https://github.com/w3c/wcagDevelopment environment and build system for Web Content Accessibility Guidelines (WCAG) 2, including understanding documents and techniques. This repository uses an Eleventy-based build system with Liquid templating and Cheerio to compile specifications. It provides JSON serializations of WCAG 2.1 and 2.2, including principles, guidelines, success criteria, and glossary terms.
The sufficient array can contain technique entries or subsection entries (situations).
Subsections are used to define multiple situations (e.g., "Situation A:"). A subsection must contain:
title: Required (HTML allowed).techniques: Required (array of technique entries).note: Optional (HTML allowed).groups: Optional (array of objects with id, title, and techniques).Defining groups automatically implies a "using" relationship for the techniques within those groups.
Content for WCAG 2.1 and later is organized by versioned directories. The {version} placeholder refers to the WCAG version (e.g., 20 for WCAG 2.0, 21 for WCAG 2.1, 22 for WCAG 2.2).
guidelines/index.html: The main guidelines file.guidelines/sc/{version}/*.html: Individual HTML fragments for each success criterion.guidelines/terms/{version}/*.html: Individual HTML fragments for each definition.understanding/{version}/*.html: Understanding files for each success criterion.When working within techniques or understanding folders, you can control how version numbers and updates appear in informative documents.
Insert {{ versionDecimal }} to display the decimal-point-delimited version number (e.g., 2.1 or 2.2).
To show content only in newer versions with a prefix:
class="wcagXY" to the surrounding element (e.g., class="wcag22" for WCAG 2.2).New in WCAG X.Y: [content] in applicable versions.If you use class="wcagXY" alongside the note class, the note title will be appended with (New in WCAG X.Y) in applicable versions, and the note will be hidden in earlier versions.
Techniques are standalone HTML files located in the techniques folder, grouped by technology into sub-folders. Each file must follow a specific structure using top-level <section> elements with the following IDs:
meta: Provides context for authoring (removed during publication).applicability: (Recommended) Describes when the technique applies.description: (Required) Explains the technique.examples: (Recommended) Demonstrates the technique.tests: (Required) Provides ways to test the technique.related: (Optional) Links to other techniques.resources: (Optional) Provides additional resources.The technique title must be placed in an <h1> element.
Note on instructions: Elements with class="instructions" are used to guide template population. They are ignored by the generator, but you should remove them once the technique is developed. Do not copy class="instructions" into real content.
To use the editor's draft stylesheet, add this to the <head>:
<link rel="stylesheet" type="text/css" href="../../css/editors.css"/>
When an erratum relates to a specific section or term, include a link using the trUrl variable.
dfn- prefix followed by the term name as the fragment.Example phrasing for a success criterion:
In <a href="{{ trUrl }}#target-size-minimum">2.5.8 Target Size (Minimum)</a>Example phrasing for a term definition:
In the definition for <a href="{{ trUrl }}#dfn-single-pointer">single pointer</a>In <a href="{{ trUrl }}#target-size-minimum">2.5.8 Target Size (Minimum)</a>In the definition for <a href="{{ trUrl }}#dfn-single-pointer">single pointer</a>You are permitted to use the WCAG JSON data, in full or in part, under the following conditions:
For more details, refer to the W3C Document license and W3C Intellectual rights.
The WCAG 2 data is serialized into JSON format and published monthly. This JSON includes Principles, guidelines, success criteria, glossary terms, and associations between normative success criteria and informative techniques. You can access the latest versions at the following URLs:
https://www.w3.org/WAI/WCAG22/wcag.jsonhttps://www.w3.org/WAI/WCAG21/wcag.jsonErrata for WCAG 2.1 and 2.2 are maintained within this repository.
guidelines/ directory on the WCAG-2.1 branch.main branch for use in builds.For detailed authoring instructions, refer to the Errata README.
To contribute a new or updated success criterion (SC), follow these steps:
https://github.com/w3c/wcag.git.guidelines/sc/21/ (or the appropriate version folder) and any required definitions in guidelines/terms/21/.guidelines/index.html and remove the comment marks surrounding the lines referencing your edited SC and terms to include them in the main document.#1).New techniques should be created in a new branch using the create-techniques.sh script. This automates branch creation, file copying from the template, and setting up the meta section.
Command Syntax:
bash create-techniques.sh <technology> <filename> <type> "<title>"Arguments:
<technology>: The technology directory (e.g., html).<filename>: The temporary filename without extension.<type>: Either technique or failure."<title>": The title of the technique, enclosed in quotes with special characters escaped with \.Working examples are comprehensive code samples (including full styles, scripts, and images) that demonstrate a technique in action. They are stored in the working-examples directory.
To create a new working example:
example-, e.g., example-alt-attribute.working-examples/, use the semantic name without the prefix, e.g., working-examples/alt-attribute/.index.html if the primary example is HTML; otherwise, use a suitable filename.../css/example.css).working-examples/css, working-examples/img, or working-examples/script.working-examples/alt-attribute/css/alt.css).https://rawgit.com/w3c/wcag/main/working-examples/alt-attribute/).main branch.