Page MenuHomePhabricator

Improve accessibility by encouraging editors to add captions to tables
Closed, ResolvedPublic1 Estimated Story Points

Description

Tables without captions are less accessible for people with screen readers (and often less informative to everyone). Setting the default property to 'on' would probably increase the number of people who add captions.

Event Timeline

Restricted Application added a project: VisualEditor. · View Herald TranscriptNov 22 2017, 5:27 PM
Restricted Application added a subscriber: Aklapper. · View Herald Transcript
RexxS added a comment.Nov 22 2017, 8:57 PM

Many screen readers have the ability to call up a list of table captions and allow the user to jump directly to a table, which is very helpful for users who wish to revisit a table, or just look up information from a particular table. Where a table immediately follows a section heading, the caption becomes somewhat redundant if it simply repeats the heading, because screen readers can generally navigate to particular sections (and many users will be accustomed to navigating Wikipedia articles in that manner).

That means that we shouldn't be forcing captions to be written mechanistically, but nevertheless users of screen readers will tell you that adding captions to table is one of the most helpful improvements to their experience that we can make. Setting the caption to "on" by default won't make it any harder for editors to omit a redundant caption, but should encourage editors who would not otherwise consider providing a useful caption to do so.

Change 393062 had a related patch set uploaded (by Esanders; owner: Esanders):
[VisualEditor/VisualEditor@master] TableAction: Add option for creating a table with a caption

https://gerrit.wikimedia.org/r/393062

Change 393077 had a related patch set uploaded (by Esanders; owner: Esanders):
[mediawiki/extensions/VisualEditor@master] Create MW tables with captions by default

https://gerrit.wikimedia.org/r/393077

I tried the effects of these two changes. Even if I totally support the idea presented, I must say I do have some mild concerns with the way this is currently presented to users of the VisualEditor. I believe it's possible to resolve this quite easily:

  1. In all cases where users decide to ignore the empty space above the table they are going to insert, a super-cryptic |+ ends in the wikitext. I think this is effect is unavoidable, but:
  2. VisualEditor presents the caption as an empty space. There is absolutely zero hint at what this space is meant to be. If I focus it, it gets a thin dashed line and an editor cursor. But that's it.

Suggestions:

  • Simply repeat the word "Caption" as a bright gray placeholder text.
  • When I focus the caption, the popup that allows me to open the tables preferences (and disable the caption) must show up. Currently it doesn't.

The |+ is of course the wiki-markup for a caption, so there's nothing more cryptic about it than any other markup.

I'm not sure who the audience might be that would find any problems with the change.

If an editor is accustomed to wiki-text, there's nothing new about |+ and they will know the caption is blank. If the editor normally uses VE, then they see a empty space where captions normally go, so they can see the table has an empty caption. In either case, another editor may be encouraged to add a missing caption.

I suppose an editor who is not used to reading our articles might not expect that we put captions immediately above our tables - is that it?

I agree that the focusing is inconsistent, though. Putting the focus anywhere on the table body initially opens the properties pop-up; whereas putting the focus on the table caption does not.

[…] there's nothing more cryptic about it than any other markup.

I agree. This was only meant as a note.

If the editor […] uses VE […] they can see the table has an empty caption.

This is exactly where I disagree. Yes, I can see there is some empty space. But how should an unexperienced user know what this empty space is supposed to hold? Since this ticket here is about teaching unexperienced users, I suggest to do something about this. I outlined a very trivial solution. It's also possibly to test this very easily with real-world people, which I suggest to do.

Change 393222 had a related patch set uploaded (by Esanders; owner: Esanders):
[VisualEditor/VisualEditor@master] Highlight table caption when table cells selected

https://gerrit.wikimedia.org/r/393222

Yes - it occurred to me that a placeholder would be ideal, but as we don't have any mechanisms for sub-document placeholders, would require a but more work.

In all cases where users decide to ignore the empty space above the table they are going to insert, a super-cryptic |+ ends in the wikitext. I think this is effect is unavoidable, but:

This isn't unavoidable - we mark some paragraphs as generated-empty, and on conversion to HTML discard them if they were left empty by the user, so we could do something similar with table captions. Again it would require a fair bit more work.

Change 393062 merged by jenkins-bot:
[VisualEditor/VisualEditor@master] TableAction: Add option for creating a table with a caption

https://gerrit.wikimedia.org/r/393062

Change 393222 merged by jenkins-bot:
[VisualEditor/VisualEditor@master] Highlight table caption when table cells selected

https://gerrit.wikimedia.org/r/393222

Change 393617 had a related patch set uploaded (by Jforrester; owner: Jforrester):
[mediawiki/extensions/VisualEditor@master] Update VE core submodule to master (6c0b7407f)

https://gerrit.wikimedia.org/r/393617

Change 393617 merged by jenkins-bot:
[mediawiki/extensions/VisualEditor@master] Update VE core submodule to master (6c0b7407f)

https://gerrit.wikimedia.org/r/393617

Jdforrester-WMF closed this task as Resolved.Nov 27 2017, 6:48 PM
Jdforrester-WMF assigned this task to Esanders.
Jdforrester-WMF triaged this task as Medium priority.
Jdforrester-WMF set the point value for this task to 1.
Jdforrester-WMF moved this task from To Triage to TR1: Releases on the VisualEditor board.
Jdforrester-WMF removed a project: Patch-For-Review.
Restricted Application added a project: User-Ryasmeen. · View Herald TranscriptNov 27 2017, 6:48 PM

Change 393077 merged by jenkins-bot:
[mediawiki/extensions/VisualEditor@master] Create MW tables with captions by default

https://gerrit.wikimedia.org/r/393077