[Django] #32860: Improve accessability of permalinks in django docs

14 views
Skip to first unread message

Django

unread,
Jun 17, 2021, 3:00:36 PM6/17/21
to django-...@googlegroups.com
#32860: Improve accessability of permalinks in django docs
-----------------------------------------+------------------------
Reporter: Tim McCurrach | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 3.2
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-----------------------------------------+------------------------
In the docs generated via `make html`:
- The permalinks are not focusable
- This is because they are hidden via `visibility:hidden`, and hidden
elements are not focusable.

This provides a bad experience for people using the keyboard to navigate
through the document.

The version of the docs generated for `djangoproject.com` is slightly
better:
- It uses `opacity:0` to hide them.
- This means they are focusable.
- Currently they are still not visible when focused though.

This provides a confusing experience for sighted users who prefer keyboard
navigation for accessability (or other) reasons. It means that when you
'tab through' the page, the focus seems to 'disappear' before re-appearing
some number of tabs later.

I propose we update the CSS in both locations to provide focusable
permalinks that are also visible whilst focused.

(I appologise if this is not the correct place to raise issues about
djangoproject.com - I wasn't sure. But since it relates to the docs
anyway, I figured there would be no harm in doing so.)

--
Ticket URL: <https://code.djangoproject.com/ticket/32860>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Jun 17, 2021, 3:00:47 PM6/17/21
to django-...@googlegroups.com
#32860: Improve accessability of permalinks in django docs
-------------------------------+-----------------------------------------
Reporter: Tim McCurrach | Owner: Tim McCurrach
Type: Uncategorized | Status: assigned
Component: Documentation | Version: 3.2
Severity: Normal | Resolution:

Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+-----------------------------------------
Changes (by Tim McCurrach):

* owner: nobody => Tim McCurrach
* status: new => assigned


--
Ticket URL: <https://code.djangoproject.com/ticket/32860#comment:1>

Django

unread,
Jun 18, 2021, 4:22:16 AM6/18/21
to django-...@googlegroups.com
#32860: Improve accessability of permalinks in django docs
-------------------------------+-----------------------------------------
Reporter: Tim McCurrach | Owner: Tim McCurrach
Type: Bug | Status: assigned
Component: Documentation | Version: 3.2
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+-----------------------------------------
Changes (by Carlton Gibson):

* has_patch: 0 => 1
* type: Uncategorized => Bug
* stage: Unreviewed => Accepted


Comment:

OK, happy to take a look at this yes. Thanks.

--
Ticket URL: <https://code.djangoproject.com/ticket/32860#comment:2>

Django

unread,
Jun 18, 2021, 7:10:37 AM6/18/21
to django-...@googlegroups.com
#32860: Improve accessability of permalinks in django docs
-------------------------------+-----------------------------------------
Reporter: Tim McCurrach | Owner: Tim McCurrach
Type: Bug | Status: assigned
Component: Documentation | Version: 3.2

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+-----------------------------------------

Comment (by Nick Pope):

[https://github.com/django/django/pull/14537 PR] for django.
[https://github.com/django/djangoproject.com/pull/1100 PR] for
djangoproject.com.

--
Ticket URL: <https://code.djangoproject.com/ticket/32860#comment:3>

Django

unread,
Jun 20, 2021, 7:46:04 PM6/20/21
to django-...@googlegroups.com
#32860: Improve accessibility of permalinks in Django docs

-------------------------------+-----------------------------------------
Reporter: Tim McCurrach | Owner: Tim McCurrach
Type: Bug | Status: assigned
Component: Documentation | Version: 3.2

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+-----------------------------------------

--
Ticket URL: <https://code.djangoproject.com/ticket/32860#comment:4>

Django

unread,
Jun 21, 2021, 8:07:24 AM6/21/21
to django-...@googlegroups.com
#32860: Improve accessibility of permalinks in Django docs
-------------------------------+-----------------------------------------
Reporter: Tim McCurrach | Owner: Tim McCurrach
Type: Bug | Status: closed
Component: Documentation | Version: 3.2
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+-----------------------------------------
Changes (by Mariusz Felisiak <felisiak.mariusz@…>):

* status: assigned => closed
* resolution: => fixed


Comment:

In [changeset:"4659a790cf5d0036c3c7488877b4365d948ccb01" 4659a790]:
{{{
#!CommitTicketReference repository=""
revision="4659a790cf5d0036c3c7488877b4365d948ccb01"
Fixed #32860 -- Made docs permalinks focusable to improve accessibility.
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/32860#comment:5>

Django

unread,
Jun 21, 2021, 8:07:54 AM6/21/21
to django-...@googlegroups.com
#32860: Improve accessibility of permalinks in Django docs
-------------------------------+-----------------------------------------
Reporter: Tim McCurrach | Owner: Tim McCurrach
Type: Bug | Status: closed
Component: Documentation | Version: 3.2

Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+-----------------------------------------

Comment (by Mariusz Felisiak <felisiak.mariusz@…>):

In [changeset:"3d51e1635ab50c9ad7d60e553813f41429b6219c" 3d51e163]:
{{{
#!CommitTicketReference repository=""
revision="3d51e1635ab50c9ad7d60e553813f41429b6219c"
[3.2.x] Fixed #32860 -- Made docs permalinks focusable to improve
accessibility.

Backport of 4659a790cf5d0036c3c7488877b4365d948ccb01 from main
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/32860#comment:6>

Reply all
Reply to author
Forward
0 new messages