EE Report and Doc Reports¶
Equal Entry report (Reports_ee_report.js)¶
Generates the main Equal Entry audit report, the long-form narrative deliverable, from eeReportMDTemplate. It always writes a markdown file named <Company> - <Product> Report <date> to the audit reports folder (replacing the previous copy) and, when the user ticks "convert to HTML", also a styled HTML file.
| Function | Description | Facing |
|---|---|---|
doGenerateEEReport_(...) |
Fills the template, names and writes the .md file, and optionally produces the .html version. Returns {files: [...]}. |
Internal |
getReplacementsForEEReport_(...) |
Builds every {{TAG}} value for the report: scenarios list, Issue List URL, configuration values (company, product, delivery date, testing tools, platform/browser, high-level summary, project name), detailed scenario steps, WCAG version, one illustrative issue per scenario, top-3 failing criteria and issues, and the results-by-issue, results-by-scenario, and results-by-criteria tables. |
Internal |
All Issues Google Doc (Report_doc.js)¶
The simplest generator: a Google Doc dump of every issue.
| Function | Description | Facing |
|---|---|---|
doGenerateDocs_(...) |
Finds or creates <Product> All Issues in the audit reports folder, clears its body, and appends every issue in sequence: a Heading 1 title plus bolded Issue / WCAG / Testing Tool / Scenario / Description lines (with links on the issue title and success criteria), embedding PNG/JPEG assets at 620x400 and linking MP4 assets. Per-issue failures are logged and skipped rather than aborting the run. |
Internal |