Skip to content

ACR / VPAT Report

Reports_vpat.js generates the Accessibility Conformance Report (ACR, based on the VPAT template) in four editions, defined by acrEnum:

  • WCAG
  • Revised Section 508
  • EN 301 549
  • International

Each edition is always produced as markdown; the user can also select a styled HTML version. Files are named <Company> - <Product> - <Edition> ACR - <date> and written to the audit reports folder, replacing any previous copy.

Conformance logic

getCriteriaConformanceData_ converts audit issues into a conformance level plus remarks for each criterion:

  • Does Not Support applies only when every tested scenario has a Blocking issue for that criterion.
  • Otherwise, criteria with issues get Partially Supports.
  • Criteria without issues use the defaults and boilerplate remarks from Report_na_or_support.js (Supports or Not Applicable), as adjusted by the "Report: NA or Support - v3" sheet.
  • Remarks are assembled per scenario from issue details.

The Section 508 tables are always evaluated against WCAG 2.0 by design.

Functions

Function Description Facing
doGenerateACR_(...) Loops the four editions and generates each one the user selected, reporting sidebar progress from 85% upward. Internal
doCreateACRType_(acrTypeKey, ...) Produces one edition: builds the replacement map, applies it to vpatMDTemplate, writes the .md (and optionally the styled .html) to the reports folder. Internal
getReplacementsForVPAT_(acrTypeKey, ...) The core template filler. Forces WCAG 2.0 for the 508 edition, sets the edition name, pulls report notes and configuration values, builds detailed scenario steps, writes per-edition "applicable standards" blurbs, assembles the WCAG success-criteria table, and appends the 508 and/or EN 301 tables plus their not-applicable-criteria lists. Internal
getVPATWCAGTableAddedTextData_(acrTypeKey, ...) For non-WCAG editions, returns the extra "508 applies to" / "EN 301 applies to" text keyed by criteria display name, drawn from template common data. Internal
getVPAT508TablesData_(...) Builds the "Revised Section 508 Report" markdown section from _508TablesStructure (chapters 3-6). Returns {not_applicable_criterias, tables_text}. Internal
getVPAT301TablesData_(wcagVerNum, ...) Same for the "EN 301 549 Report" section, driven by _EN301TablesStructure (chapters 4-13), including per-chapter notes from the Report Notes sheet. Internal
getCriteriaConformanceData_(criteriaName, ...) Conformance level and remarks for a single criterion (see logic above). Internal

Constants: acrEnum, _VPATTableHeadingCellText, _508TablesStructure, _EN301TablesStructure, _EN301URLToStandard.

Report_na_or_support.js

Almost entirely a data file supporting ACR generation. It defines:

  • reportNaOrSupportV3Columns - the column names for the "Report: NA or Support - v3" sheet (Criteria / Conformance Level / Details / Preview).
  • reportNaOrSupportCommonData - a large lookup table giving, for every WCAG / 508 / EN 301 criterion ref-id, its default conformance stance and the boilerplate "supported" and "not applicable" remarks text.
Function Description Facing
getReportNaOrSupportCommonDataByCriteriaDisplayName(criteriaDisplayName, computed) Reverse lookup: resolves a criterion's display name back to its ref-id and returns the matching defaults and remarks templates. Internal