wcag-as-json

0.0.1 • Public • Published

WCAG as JSON

This is a JSON formatted version of WCAG 2.0

We created this as a way to be able to quickly insert references to WCAG-related information into other documents.

Structure

The structure of the JSON file closely mirrors the WCAG Standard itself:

  • There are 4 core principles of WCAG
  • Each Principle has Guidelines
  • Each Guideline has Success Criteria

In this JSON format the Success Criteria themselves have been broken down further:

  • Special Cases - additional considerations on the applicability of the SC. There are 3 types of special cases
    • exception - the special case, if satisfied, creates an exception whereby the SC does not apply
    • at_least_one - at least one of the special cases must apply
    • all_true - all of the special cases must apply
  • Notes - any other notes that accompany the SC

A full WCAG SC Entry looks like this:

 {
     "ref_id": "4.1.2",
     "title": "Name, Role, Value",
     "description": "For all user interface components (including but not limited to: form elements, links and components generated by scripts), the name and role can be programmatically determined; states, properties, and values that can be set by the user can be programmatically set; and notification of changes to these items is available to user agents, including assistive technologies.",
     "url": "https://www.w3.org/TR/WCAG20/#ensure-compat-rsv",
     "level": "A",
     "special_cases": null,
     "notes": [{
         "content": "This success criterion is primarily for Web authors who develop or script their own user interface components. For example, standard HTML controls already meet this success criterion when used according to specification."
     }],
     "references": [{
         "title": "How to Meet 4.1.2",
         "url": "http://www.w3.org/WAI/WCAG20/quickref/#qr-ensure-compat-rsv"
     },
     {
         "title": "Understanding 4.1.2",
         "url": "http://www.w3.org/TR/UNDERSTANDING-WCAG20/ensure-compat-rsv.html"
     }]
 }

License

The JSON formatted document has an MIT license.

This software or document includes material copied from or derived from Web Content Accessibility Guidelines (WCAG) 2.0 https://www.w3.org/TR/WCAG20/. Copyright © 2008 W3C® (MIT, ERCIM, Keio, Beihang).

Readme

Keywords

none

Package Sidebar

Install

npm i wcag-as-json

Weekly Downloads

2

Version

0.0.1

License

none

Last publish

Collaborators

  • karlgroves