Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wagtail-nest/wagtail-accessibility
✅ Accessibility content checks for Wagtail websites
https://github.com/wagtail-nest/wagtail-accessibility
accessibility django wagtail
Last synced: about 2 months ago
JSON representation
✅ Accessibility content checks for Wagtail websites
- Host: GitHub
- URL: https://github.com/wagtail-nest/wagtail-accessibility
- Owner: wagtail-nest
- License: bsd-3-clause
- Created: 2016-02-22T05:08:35.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-12-19T13:59:04.000Z (9 months ago)
- Last Synced: 2023-12-20T12:01:53.505Z (9 months ago)
- Topics: accessibility, django, wagtail
- Language: Python
- Homepage: https://wagtail-nest.github.io/wagtail-accessibility/
- Size: 435 KB
- Stars: 30
- Watchers: 5
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-wagtail - Wagtail Accessibility
README
# [wagtail-accessibility](https://pypi.org/project/wagtail-accessibility/)
✅ Accessibility content checks for Wagtail websites. Try it out on our [static demo page](https://wagtail-nest.github.io/wagtail-accessibility/)!
---
[](https://wagtail-nest.github.io/wagtail-accessibility/)
## Why you need this
As of Wagtail 4.2, Wagtail has [built-in accessibility checks](https://wagtail.org/blog/introducing-wagtails-new-accessibility-checker/). However those checks are only based on automation – and are only set up for scenarios where the checks can always provide correct results, rather than leaving room for interpretation.
In contrast, wagtail-accessibility focuses on providing tools to support CMS users with their _manual_ testing:
- Visualising headings in use on the page, to check whether there are enough
- Checking for color contrast
- Checking link text for common possible mistakes
- Identifying inputs with missing labels
- Highlighting images without alt text
- Visualising landmarks in use on the page
It also integrates a "screen reader wand", for CMS users to preview how a given element would appear for a screen reader.
---
For more details about the future of accessibility checks in Wagtail, read [Looking for sponsorship – Accessibility checks for site administrators](https://wagtail.org/blog/looking-for-sponsorship-accessibility-checks-for-site-administrators/).
## Installing
Install using pip:
``` bash
pip install wagtail-accessibility
```
Then add `wagtailaccessibility` to your `INSTALLED_APPS`. It works with Wagtail 5.2 and upwards.
## Using
This plugin, when added to your template, will add [tota11y](https://github.com/jdan/tota11y) to all page previews.
Tota11y is an accessibility visualization toolkit.
To use it, simply include this in your template, and from now on all page previews will include it.
```jinja2
{% load wagtailaccessibility_tags %}
{% tota11y %}
```
## Jinja2
This plugin also contains a jinja2 implementation, to use it, include
the following in your config.
```python
{
'BACKEND': 'django.template.backends.jinja2.Jinja2',
'OPTIONS': {
'extensions': [
# […]
'wagtailaccessibility.jinja2tags.tota11y',
],
},
}
```
The template tag can then be used like so:
```jinja2
{{ tota11y() }}
```
## Release process
This section is for maintainers of this package.
1. Ensure `CHANGELOG.md` is up to date.
- Don't forget to update the release date
- Consider the perspective of the person reading the changelog. What do they need to know? Keep it short and to the point, most important bits first.
2. Check the version number in `setup.py` and update it if necessary. Follow [semantic versioning](https://semver.org/).
3. Commit and push the changes
4. From the GitHub interface, create a new release, using the version number as the tag name (GitHub will create the tag for you)
- GitHub Actions will automatically build and publish the new version to PyPI when a GitHub release is created
5. Back to development: Update the version number in `setup.py` to the next version, and add a new section to `CHANGELOG.md` for the next release (with a date of "unreleased")