Modules
Drupal 7 will no longer be supported after January 5, 2025. Learn more and find resources for Drupal 7 sites
Content accessibility module
To check content on your site, you will need to enable the Content Accessibility module. Once enabled, you can navigate to Administration > Configuration > Accessibility > Content to configure the way the module behaves on your site. Users are able to view accessibility problems with content only if they are in a role granted the permission Check content for accessibility. The following site-wide configuration options are available:
- Automatically check page - If the current user has permission to view errors, show them immediately instead of requiring they click the toggle to do so.
- Show accessibility check toggle - If disabled, the toggle is not shown to the user.
- Toggle settings - Language for the toggle when turning testing on or off.
- You have been prevented from submitting this form because of the following accessibility errors.... - If a field is setup to prevent a form from being saved if there are accessibility problems, this message will help explain what the user should do.
The toggle allows users to turn testing on or off.
Testing occurs only on fields that have been configured to be tested. This allows a lot of flexibility to turn testing on or off only for certain use cases. For example, to enable testing, for the Body field of an article, navigate to the Manage fields section of the content type you wish to edit, then click the edit link for any field that has the type of Long text or Long text with summary. Other fields are ignored (because users cannot enter HTML into them); however, there is an API if you wish to add testing to another field you identify.
When editing an existing field, or creating a new one, you will find the following options:
- Check this field for accessibility - When checked, if this field is displayed, then users with permission will see accessibility checks.
- Block saving content if there are any errors that are... - When checked, whenever a user is editing this field, and a test occurs with any of the enabled severity levels, then the user is prevented from saving the form.
Accessibility WYSIWYG module
Just like the red underlines in text editors gives users instant feedback on spelling errors, the Accessibility WYSIWYG module gives the same sort of interface for accessibility problems. To give your content authors this ability, enable the Accessibility WYSIWYG module, along with either the WYSIWYG module or the CKEditor module, and navigate to the appropriate setting page for those modules to add the accessibility check button to the editor. Any enabled tests on your site are then run against any WYSIWYG editor enabled on your site.
Note: Currently, the Accessibility WYSIWYG module only supports TinyMCE and CKEditor 3 for the WYSIWYG module, and CKEditor 4 for the CKEditor module.
Accessibility Reporting module
To get reports on which pages have the most errors, or other views that are helpful for human reviewers or content editors, enable the Accessibility Reporting module. Once enabled, when any user with the User will report accessibility problems permission views a Long text or Long text with summary field which has the option Report on accessibility problems in this field enabled, their browser will silently scan that field for accessibility problems and post them to your site.
Reports can be built using the Views module, and a sample view is installed when the module is enabled.
Help improve this page
You can:
- Log in, click Edit, and edit this page
- Log in, click Discuss, update the Page status value, and suggest an improvement
- Log in and create a Documentation issue with your suggestion