Interactive Guide to Assist Managing Web Accessibility Evaluations
JavaScript HTML CSS
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
docs
test
.bowerrc
.editorconfig
.gitattributes
.gitignore
.jshintrc
.travis.yml
Gruntfile.js
README.md
bower.json
changelog.md
karma-e2e.conf.js
karma.conf.js
package.json
plugin-guide.md
structure redesign

README.md

WCAG-EM Report tool is an assistant that takes the user through the process of evaluating the accessibility of a website, using the WCAG-EM Evaluation Methodology. The Report Tool runs entirely on the client and so it can be used offline and in any server configuration available to you.

The Report Tool does not save files to a server or in local storage. Rather, load and save functions are available for storing an evaluation to your local file system.

Important references:

The official released version of the Report Tool can be found at http://www.w3.org/WAI/eval/report-tool/. An example of the latest (unapproved by EO) version is available at http://w3c.github.io/wcag-em-report-tool/dist/.

See Change log for details about the latest version of the WCAG-EM Report Tool.

Install

Before you can install the WCAG-EM Report Tool you will need to install a few components:

In addition to these, you will need to install grunt cli. To do so run the following command. This will install the grunt command line interface in a global space on your machine.

npm install grunt-cli -g

Now with all global dependencies installed, the following commands will install the app and its dependencies

git clone git://github.com/w3c/wcag-em-report-tool.git
gem install compass
npm install
bower install

Usage

You can launch a development version by running:

grunt serve

To create a build in the /dist folder run:

grunt build

The build version can be hosted in on any server that available on http(s). WCAG-EM Report Tool runs in your local browser, so it only loads static files from the server.

Translations

The WCAG-EM Report Tool aims to be available for a wide audience. Much effort has been put into making translations as easy as possible. To learn about how to create your own translations read the translation documentation

Get Involved

Did you find a bug, or are you interested in working with us to create new features for the Report Tool, then get involved with the project!

Data Format

Data in the WCAG-EM Report Tool is saved and can again be loaded in a JSON format. The data format is JSON Linked Data, and uses EARL to store the test results.

Custom fields are based on WCAG-EM and are documented in EARL+JSON-LD format definition.