mirror of
https://github.com/django/django.git
synced 2025-06-05 11:39:13 +00:00
Force-wrap all accessibility docs to 79 characters or below
This commit is contained in:
parent
52660c107d
commit
30d00403f4
@ -2,11 +2,10 @@
|
|||||||
Accessibility
|
Accessibility
|
||||||
=============
|
=============
|
||||||
|
|
||||||
The Django project is committed to being accessible to everyone
|
The Django project is committed to being accessible to everyone in all
|
||||||
in all possible ways.
|
possible ways. We work to conform to established accessibility standards, an
|
||||||
We work to conform to established accessibility standards,
|
also to meet our own targets for supporting specific input devices and
|
||||||
and also to meet our own targets for supporting specific input devices
|
assistive technologies.
|
||||||
and assistive technologies.
|
|
||||||
|
|
||||||
.. _accessibility-standards:
|
.. _accessibility-standards:
|
||||||
|
|
||||||
@ -14,20 +13,20 @@ Accessibility standards
|
|||||||
=======================
|
=======================
|
||||||
|
|
||||||
We work to conform with the `Web Content Accessibility Guidelines`_ (WCAG),
|
We work to conform with the `Web Content Accessibility Guidelines`_ (WCAG),
|
||||||
version 2.2, at the AA level.
|
version 2.2, at the AA level. WCAG is the most established standard for web
|
||||||
WCAG is the most established standard for web accessibility.
|
accessibility. AA-level guidelines are the most common legal compliance target
|
||||||
AA-level guidelines are the most common legal compliance target worldwide.
|
worldwide.
|
||||||
|
|
||||||
We also attempt to follow other best practices, such as:
|
We also attempt to follow other best practices, such as:
|
||||||
|
|
||||||
* WCAG 2.2 AAA-level guidelines.
|
* WCAG 2.2 AAA-level guidelines.
|
||||||
* The upcoming `WCAG 3.0`_ guidelines.
|
* The upcoming `WCAG 3.0`_ guidelines.
|
||||||
* `Authoring Tool Accessibility Guidelines`_ (ATAG) 2.0 – guidelines
|
* `Authoring Tool Accessibility Guidelines`_ (ATAG) 2.0 – guidelines for
|
||||||
for software and services that are used to produce web content.
|
software and services that are used to produce web content.
|
||||||
|
|
||||||
To learn more about accessibility without diving straight into standards,
|
To learn more about accessibility without diving straight into standards, we
|
||||||
we recommend `The A11Y Project`_, a community-driven effort
|
recommend `The A11Y Project`_, a community-driven effort to make digital
|
||||||
to make digital accessibility easier.
|
accessibility easier.
|
||||||
|
|
||||||
.. _Web Content Accessibility Guidelines: https://www.w3.org/TR/WCAG22/
|
.. _Web Content Accessibility Guidelines: https://www.w3.org/TR/WCAG22/
|
||||||
.. _WCAG 3.0: https://www.w3.org/TR/wcag-3.0/
|
.. _WCAG 3.0: https://www.w3.org/TR/wcag-3.0/
|
||||||
@ -40,11 +39,11 @@ Accessibility support targets
|
|||||||
=============================
|
=============================
|
||||||
|
|
||||||
Beyond standards, we want to make sure Django actually works for people using
|
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
|
a wide range of input devices and assistive technologies. This has benefits to
|
||||||
to make sure Django works better `for everyone`_.
|
make sure Django works better `for everyone`_. The best way to do this
|
||||||
The best way to do this effectively is to take accessibility considerations
|
effectively is to take accessibility considerations into account as part of
|
||||||
into account as part of designing features. If in doubt, consult
|
designing features. If in doubt, consult with users who rely on assistive
|
||||||
with users who rely on assistive technologies or with accessibility experts.
|
technologies or with accessibility experts.
|
||||||
|
|
||||||
.. _for everyone: https://en.wikipedia.org/wiki/Curb_cut_effect
|
.. _for everyone: https://en.wikipedia.org/wiki/Curb_cut_effect
|
||||||
|
|
||||||
@ -53,10 +52,10 @@ with users who rely on assistive technologies or with accessibility experts.
|
|||||||
Accessibility testing baseline
|
Accessibility testing baseline
|
||||||
------------------------------
|
------------------------------
|
||||||
|
|
||||||
Design the UI with accessibility in mind,
|
Design the UI with accessibility in mind, and the testing will only be needed
|
||||||
and the testing will only be needed as a final check. For more complex
|
as a final check. For more complex interfaces, confer with other contributors
|
||||||
interfaces, confer with other contributors to decide on testing targets.
|
to decide on testing targets. Reach out to the `Accessibility team`_ for
|
||||||
Reach out to the `Accessibility team`_ for support and to coordinate testing
|
support and to coordinate testing.
|
||||||
|
|
||||||
Always test user interface changes with:
|
Always test user interface changes with:
|
||||||
|
|
||||||
@ -64,7 +63,7 @@ Always test user interface changes with:
|
|||||||
* The `Accessibility Insights`_ browser extension's automated checks feature,
|
* The `Accessibility Insights`_ browser extension's automated checks feature,
|
||||||
or an equivalent tool with the `Axe`_ checker.
|
or an equivalent tool with the `Axe`_ checker.
|
||||||
|
|
||||||
Where appropriate, also test with:
|
Where the UI changes, also test with:
|
||||||
|
|
||||||
* Touch-only navigation
|
* Touch-only navigation
|
||||||
* 400% browser zoom
|
* 400% browser zoom
|
||||||
@ -75,8 +74,8 @@ Where appropriate, also test with:
|
|||||||
Assistive technologies
|
Assistive technologies
|
||||||
----------------------
|
----------------------
|
||||||
|
|
||||||
Where more extensive testing is appropriate,
|
Where more extensive testing is appropriate, here are popular free assistive
|
||||||
here are popular free assistive technologies we recommend testing with:
|
technologies we recommend testing with:
|
||||||
|
|
||||||
* `NVDA`_ on Windows with Firefox ESR
|
* `NVDA`_ on Windows with Firefox ESR
|
||||||
* `VoiceOver`_ on macOS with Safari
|
* `VoiceOver`_ on macOS with Safari
|
||||||
@ -108,9 +107,10 @@ Where expert help is available, also consider testing with:
|
|||||||
Known issues and 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.
|
There are some parts of Django that do not meet our accessibility targets at
|
||||||
We actively work on fixing issues, both as part of ongoing maintenance
|
the moment. We actively work on fixing issues, both as part of ongoing
|
||||||
and bigger overhauls. To learn about known issues, and get involved, see:
|
maintenance and bigger overhauls. To learn about known issues, and get
|
||||||
|
involved, see:
|
||||||
|
|
||||||
* ``#accessibility`` on the `Django Discord server`_.
|
* ``#accessibility`` on the `Django Discord server`_.
|
||||||
* `Accessibility issues on the ticket tracker`_.
|
* `Accessibility issues on the ticket tracker`_.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user