The IndexReport

Report

A LaTeX project in. Its accessibility report out: each WCAG 2.1 criterion with its verdict, and, by line in your own source, what still needs a person, such as a figure to describe.

Open now

A project in, a verdict for each criterion out A zipped LaTeX project goes in. Back comes a list of WCAG 2.1 criteria: three passed, one that software cannot decide, and one that needs a person at line 42 to describe Figure 3. YOU SEND lecture-04.zip BACK 1.3.1 Info and relationshipspassed 1.4.1 Use of colorpassed 2.4.2 Page titledpassed ? 1.4.3 Contrastnot established ! 1.1.1 Non-text contentline 42: describe Figure 3
What a report looks like. The criteria and verdicts here are an example; a real report covers every criterion it can speak to.

What it is for

  • Sorting a semester of materials before deciding which documents need a person, and where in them.
  • A check in a publishing workflow that stops a release when a document gets worse.
  • An agent deciding what to fix first, with the file and the line in hand.

What it will not say

It never says "compliant". Where software can decide a criterion, it gives the verdict. Where it cannot, such as whether a description says what a figure shows, it says "not established" and names the place a person should look. What a machine check cannot say draws that line in more detail.

Price

Three cents a page. With the PDF, the web page and an archival copy, all of it costs ten cents a page, and the PDF and the page each carry the report's verdict inside them.

Documentation

POST https://api.intex.institute/v1/report

The same request as every project service: your key in the Authorization header, and the project as a form upload in project, with main when the archive holds more than one main file. The details are in the docs.

The response

{
  "verdict": "not established",
  "criteria": [
    {"criterion": "1.1.1", "name": "Non-text Content", "verdict": "needs a person",
     "places": [{"file": "lecture-04.tex", "line": 42,
                 "needs": "The figure's alt text is copied from its caption."}]},
    {"criterion": "1.3.1", "name": "Info and Relationships", "verdict": "passed", "places": []}
  ],
  "other": [{"file": "lecture-04.tex", "line": 88,
             "needs": "\\cite{knuth} has no entry in the bibliography: it reads [?]."}],
  "text": "The report in plain sentences, as the PDF carries it."
}

Shortened, and an example. verdict is the headline for the whole document: yes, no or not established. Each criterion's verdict is passed, failed, not established or needs a person, with its places. other holds the places a person is needed that no criterion covers, such as a citation with no entry or a date to decide.

Related