BarisW / quail

Accessibility testing in the browser and on the server.

Development

Commands you can run as a developer:

CLI tools:

quail --help

Running assessments unit tests (via Selenium and Karma)

Unit tests

karma start ./config/karma-unit.conf.js

All assessments

Fast in PhantomJS

node ./test/assessmentSpecs/testrunner.js

In a specific browser

_BROWSER=chrome node ./test/assessmentSpecs/testRunner.js

A single assessments

node ./test/assessmentSpecs/testrunner.js -I aAdjacentWithSameResourceShouldBeCombined

Quail: Accessibility Information Library

The project website is quailjs.org.

A jQuery plugin that lets you easily check HTML for adherence to accessibility standards. It comes with over 200 tests which implement Open Accessibility Tests and comes with WCAG 1.0, WCAG 2.0, and Section 508 guidelines.

Developers can build their own guidelines, or easily build a custom guideline that integrates with their project. While the project supports checking entire HTML pages, integration with a CMS to check partial HTML content is probably the most popular use case.

Installing via Bower

You can include Quail into your project using Bower by using the command bower install quail.

Building Quail

If you are not familiar with using grunt or just want to download a pre-built version of quail, visit the releases page for the project.

If you are checking out quail from a repository, you will notice there is no /dist directory, quail must be built using Grunt. Use the following steps to get started (this is assuming you already have Node installed on your machine):

cd quail
npm install
grunt build

This does two things: it downloads libraries (like qunit and jQuery) into the /lib directory, and builds quail (both a development version and a minified, production version) into the /dist directory.

Command line

Quail has an executable file that will run the test suite against the a specific URL.

To use this executable locally, you will need to add it to your path. In your .bashrc (or equivalent) add something like this.

export PATH=~/Code/quailjs/quail/bin:$PATH

Quit the editor and source the bash file.

source ~/.bashrc .

The quail command should be exectuable. If you run which quail, you should see that path to the executable displayed. If it wasn't added to your path, you can also run the script directly:

node ./bin/quail

If it is not, try running the following:

grunt chmod

Which will attempt to set the permissions of this file to 711, an executable. Try running this from the Quail project directory.

sudo chmod 711 ./bin/quail

Once the command is set up, you can run the following to test any addressable web page.

quail --url=http://some.domain.com/page.html

The script will run and write the output to ./analyses

Documentation

Full documentation is available via readthedocs.org.

Contributing

Pull requests should be made against the dev branch, as master is only for tracking releases.

Credits

• Quail is maintained by Kevin Miller
• Part of Quail development is supported by Cal State Monterey Bay
• Many thanks to Jesse Renée Beach for promoting Quail and the many commits.
• Thanks to the hosts of Chez JJ, who housed Kevin for a week while he worked on Quail 2.

Legal

QUAIL is covered under the MIT License, and is copyright (c) 2013 by Kevin Miller. Current license is at http://quailjs.org/license.