Accessibility Checker Installation
Installation Guide
The distribution version of Accessibility Checker comes as a a11ychecker.zip
file.
This archive contains the following plugins, each placed in a separate directory:
a11ychecker
– The Accessibility Checker core providing all essential components.balloonpanel
– The GUI element used in Accessibility Checker.
Installation Steps
- Download the
a11ychecker.zip
file into theckeditor/plugins
directory. Use the "Extract here" option on the archive, so that the directories are extracted directly into the
plugins
directory.At this point you can open the sample available in
a11ychecker/samples/index.html
to see how it works for you.To add Accessibility Checker plugin to CKEditor you need to set the
config.extraPlugins
configuration option inckeditor/config.js
.config.extraPlugins = 'a11ychecker';
Please note that there are several methods to define the editor configuration other than using the
config.js
file. You can also use in-page configuration for particluar editor instances or use a custom configuration file. You can find detailed information in the Setting CKEditor Configuration article.
Keep in mind that Quail has a jQuery dependency. It requires you to have a global variable jQuery
defined containing jQuery 1.x. The sample mentioned above is shipped with jQuery, but jQuery is not loaded automatically with Accessibility Checker.
Limitations
Running on local filesystem: You cannot run Accessibility Checker on a local filesystem, since Quail uses an XMLHttpRequest
for fetching its resources. This is not allowed when working with the file://
scheme.
Where Do I Start?
Use the ckeditor/plugins/a11ychecker/samples/index.html
sample loaded from a local web server to test Accessibility Checker.
Contact us:
Toll-free (US/CAN): +1 800 820 4009 Internationally: +1 650 521 9065 sales@cksource.com
Working hours: 1am-3pm PST, 4am-6pm EST, 10am-12am CET