Skip to content
Snippets Groups Projects

Resolve #3277459 "Improve documentation"

Open ressa requested to merge issue/a11y-3277459:3277459-improve-documentation into 2.x
2 files
+ 69
6
Compare changes
  • Side-by-side
  • Inline
Files
2
README.md 0 → 100644
+ 69
0
# Accessibility toolkit
The module seeks to provide reusable tools for developers of Drupal sites to
aid those that have need of assistive technologies and display methods.
Currently it provides a block with granular settings to allow for:
- Dyslexic font support
- High contrast mode
- Inverted Colors mode
- Text scaling
- Keyboard navigation (Only D8/D9)
It does this through aggressive CSS additions and remembers the setting using
Drupal's built in usage of jQuery Cookie.
For a full description of the module, visit the
[project page](https://www.drupal.org/project/a11y).
Submit bug reports and feature suggestions, or track changes in the
[issue queue](https://www.drupal.org/project/issues/a11y).
## Table of contents
- Requirements
- Recommended modules
- Installation
- Configuration
- Maintainers
## Requirements
This module requires no modules outside of Drupal core.
## Recommended modules
- [Speed Reader](https://www.drupal.org/project/speedreader): Isolates text
and can be easier to process for those with visual impairments.
- [Accessibility](https://www.drupal.org/project/accessibility): Gives tips
for content contributors to make sure their content meets different content
guidelines like 508 or WCAG 2.0 AA.
- [Block aria landmark roles](https://www.drupal.org/project/block_aria_landmark_roles):
Helps with applying aria landmark roles to blocks through the block UI.
## Installation
Install as you would normally install a contributed Drupal module. For further information, see [Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-drupal-modules).
## Configuration
For a quick start, install the module and add the A11y block, to allow checking with
"Dyslexic", "Contrast", "Invert", and "Disable animations".
A11y module provides a set of plugins to improve the accessibility which would
be use on A11y blocks. Also, you can implements a custom a11y plugin by
extending from class A11yPluginBase in your custom module. You can see an
example in the Keyboard plugin.
Once your plugin is created, you can implements it creating an A11y entity.
## Maintainers
- 🙄 ✻ - [btopro](https://www.drupal.org/u/btopro)
- Daniel Cimorra - [dcimorra](https://www.drupal.org/u/dcimorra)
Loading