mirror of
https://github.com/django/django.git
synced 2025-06-08 13:09:13 +00:00
125 lines
4.8 KiB
Plaintext
125 lines
4.8 KiB
Plaintext
=============
|
||
Accessibility
|
||
=============
|
||
|
||
The Django project is committed to being accessible to everyone in all
|
||
possible ways. We work to conform to established accessibility standards, an
|
||
also to meet our own targets for supporting specific input devices and
|
||
assistive technologies.
|
||
|
||
.. _accessibility-standards:
|
||
|
||
Accessibility standards
|
||
=======================
|
||
|
||
We work to conform with the `Web Content Accessibility Guidelines`_ (WCAG),
|
||
version 2.2, at the AA level. WCAG is the most established standard for web
|
||
accessibility. AA-level guidelines are the most common legal compliance target
|
||
worldwide.
|
||
|
||
We also attempt to follow other best practices, such as:
|
||
|
||
* WCAG 2.2 AAA-level guidelines.
|
||
* The upcoming `WCAG 3.0`_ guidelines.
|
||
* `Authoring Tool Accessibility Guidelines`_ (ATAG) 2.0 – guidelines for
|
||
software and services that are used to produce web content.
|
||
|
||
To learn more about accessibility without diving straight into standards, we
|
||
recommend `The A11Y Project`_, a community-driven effort to make digital
|
||
accessibility easier.
|
||
|
||
.. _Web Content Accessibility Guidelines: https://www.w3.org/TR/WCAG22/
|
||
.. _WCAG 3.0: https://www.w3.org/TR/wcag-3.0/
|
||
.. _Authoring Tool Accessibility Guidelines: https://www.w3.org/TR/ATAG20/
|
||
.. _The A11Y Project: https://www.a11yproject.com/
|
||
|
||
.. _accessibility-support-targets:
|
||
|
||
Accessibility support targets
|
||
=============================
|
||
|
||
Beyond standards, we want to make sure Django actually works for people using
|
||
a wide range of input devices and assistive technologies. This has benefits to
|
||
make sure Django works better `for everyone`_. The best way to do this
|
||
effectively is to take accessibility considerations into account as part of
|
||
designing features. If in doubt, consult with users who rely on assistive
|
||
technologies or with accessibility experts.
|
||
|
||
.. _for everyone: https://en.wikipedia.org/wiki/Curb_cut_effect
|
||
|
||
.. _accessibility-testing-baseline:
|
||
|
||
Accessibility testing baseline
|
||
------------------------------
|
||
|
||
Design the UI with accessibility in mind, and the testing will only be needed
|
||
as a final check. For more complex interfaces, confer with other contributors
|
||
to decide on testing targets. Reach out to the `Accessibility team`_ for
|
||
support and to coordinate testing.
|
||
|
||
Always test user interface changes with:
|
||
|
||
* Keyboard-only navigation
|
||
* The `Accessibility Insights`_ browser extension's automated checks feature,
|
||
or an equivalent tool with the `Axe`_ checker.
|
||
|
||
Where the UI changes could affect those modalities, also test with:
|
||
|
||
* Touch-only navigation
|
||
* 400% browser zoom
|
||
* Forced-colors mode (for example Windows Contrast Themes)
|
||
|
||
.. _assistive-technologies:
|
||
|
||
Assistive technologies
|
||
----------------------
|
||
|
||
Where the UI changes could affect assistive technologies, here are popular
|
||
free options we recommend testing with:
|
||
|
||
* `NVDA`_ on Windows with Firefox ESR
|
||
* `VoiceOver`_ on macOS with Safari
|
||
* `Orca`_ on Linux with Firefox ESR
|
||
* `Narrator`_ on Windows with Microsoft Edge
|
||
* Windows Magnifier and macOS Zoom
|
||
* Windows Speech Recognition and macOS Voice Control
|
||
* VoiceOver on iOS, or TalkBack on Android
|
||
* `Contrast themes`_ on Windows
|
||
|
||
If you have the expertise or you can work with someone who does, also test
|
||
with:
|
||
|
||
* `JAWS`_ on Windows
|
||
* `Dragon`_ on Windows
|
||
|
||
.. _Accessibility Insights: https://accessibilityinsights.io/
|
||
.. _Axe: https://github.com/dequelabs/axe-core
|
||
.. _NVDA: https://www.nvaccess.org/
|
||
.. _Narrator: https://support.microsoft.com/en-us/windows/complete-guide-to-narrator-e4397a0d-ef4f-b386-d8ae-c172f109bdb1
|
||
.. _VoiceOver: https://support.apple.com/en-gb/guide/voiceover-guide/welcome/web
|
||
.. _TalBack: https://support.google.com/accessibility/android/answer/6283677
|
||
.. _Contrast themes: https://support.microsoft.com/en-us/windows/change-color-contrast-in-windows-fedc744c-90ac-69df-aed5-c8a90125e696
|
||
.. _JAWS: https://www.freedomscientific.com/products/software/jaws/
|
||
.. _Dragon: https://www.nuance.com/en-gb/dragon.html
|
||
.. _Orca: https://help.gnome.org/users/orca/stable/
|
||
|
||
.. _accessibility-known-issues-how-to-help:
|
||
|
||
Known issues and how to help
|
||
============================
|
||
|
||
There are some parts of Django that do not meet our accessibility targets at
|
||
the moment. We actively work on fixing issues, both as part of ongoing
|
||
maintenance and bigger overhauls. To learn about known issues, and get
|
||
involved, see:
|
||
|
||
* ``#accessibility`` on the `Django Discord server`_.
|
||
* `Accessibility issues on the ticket tracker`_.
|
||
* Our `django accessibility improvements`_ project board.
|
||
* The `Accessibility team`_.
|
||
|
||
.. _Django Discord server: https://discord.gg/xcRH6mN4fa
|
||
.. _Accessibility issues on the ticket tracker: https://code.djangoproject.com/query?status=!closed&keywords=~accessibility
|
||
.. _django accessibility improvements: https://github.com/orgs/django/projects/7
|
||
.. _Accessibility team: https://www.djangoproject.com/foundation/teams/#accessibility-team
|