To help author more accessible content (according to ATAG 2.0) adding specific documentation on D8's accessibility will help people learn what is. In ATAG A.4.2 they outline in more detail best practices in "document the user interface, including all accessibility features."

So on the help pages here /admin/help/views we could add a section at the bottom, something like:

<h3>Accessibility</h3>

<p>Views tables have been improved to include semantic headings/id references for improved accessibility. Views tables are used within the Drupal admin interface, but also for custom Views. </p>

I expect that there are more elements that can be included.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

jhodgdon’s picture

Issue tags: +VDC

This seems like useful information to convey, but we need to figure out where to put it.

hook_help() standards say we have an "About" section (describing what the module does) and a "Uses" section (describing how to use the module).

This sounds like an About.

I suggest adding a section at the end of the About section, like:

---------------
The HTML output of the Views module has several features to promote accessibility:
- (information about tables)
- etc.
---------

Note: We do not want to talk about the evolution of Views. So do not say it has been "improved" or that it's better than previous versions, or mention Drupal 8 in particular. Do not use marketing language, or try to convince anyone that it's excellent. Just document what it currently does.

And we do not need to say what Views are used for in this paragraph/section. That is covered in other sections of the hook_help.

mgifford’s picture

Status: Active » Needs review
FileSize
1.38 KB

I think it needs to be in Uses as I'm explaining how to use the Caption/Summary fields.

jhodgdon’s picture

Status: Needs review » Needs work

Hm. This sentence is garbled:

Views tables have include semantic headings/id references for improved accessibility.

Also, what are "headings/id references"? I do not know what this means, and "ID" should probably be all-caps? ("id" is a psychological term, while "ID" means identifier/identification).

And this sentence:
Views tables are used within the Drupal admin interface, but also for custom views.
why is this relevant?

The header "Expressing table accessibility"... "expressing"? This verb doesn't make sense to me. What are you trying to say?

mgifford’s picture

Status: Needs work » Needs review
FileSize
0 bytes

Ok, I think this might be a bit better. I think I addressed your concerns. I was mostly looking for a non-redundant 'ing verb when I was using "Expressing" in the title.

dawehner’s picture

Status: Needs review » Needs work

I think an empty patch can be committed at any time, but git doesn't allow that :P

mgifford’s picture

But it passed all the tests! :(

Seriously though, not sure what happened there. Will work on a new patch...

mgifford’s picture

This one has bits.

mgifford’s picture

Status: Needs work » Needs review
dawehner’s picture

Status: Needs review » Reviewed & tested by the community

Sounds reasonable!

jhodgdon’s picture

Status: Reviewed & tested by the community » Needs work

I still don't like the header here. It says "Documenting table accessibility", but that is not what someone using this feature is doing. They are providing information about a table, for purposes of accessibility, but they are not documenting that the table is accessible.

I also think this sentence needs a comma:

Using id and headers attributes data cells are automatically associated with header cells.

And we shouldn't be using & in place of "and":

Both the caption & summary ...

And... fundamentally, this documentation doesn't really tell me what I need to do in order to make a table accessible. What attributes do I need, and where, and how do I add them?

mgifford’s picture

Status: Needs work » Needs review
FileSize
1.58 KB

Good points... I reworked it to provide more guidance on caption & summary too.

jhodgdon’s picture

Status: Needs review » Needs work

Hmmm... Our standard for Uses items says they should start with a verb. Perhaps "Improving table accessibility" would be a good header?

Using id and headers, attributes data cells are automatically associated with header cells.

Um... that is confusing. Maybe the comma doesn't belong there... and maybe it would be better to say "Data cells are automatically associated with header cells when their ..." um... really I have no idea what it means actually.

Maybe this would also be clearer if formatted as a UL list within the DD. For instance it could say:

Views tables include semantic markup to improve accessibility:
- (item 1)
- (item 2)
etc.

mgifford’s picture

Status: Needs work » Needs review
FileSize
1.58 KB

Shifting that sentence around makes more sense. Changed the title. Not sure the UL is needed. Not sure how to break it up...

jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

This patch I like. Reads very well, seems clear. I assume that it's accurate (sure looks reasonable). Thanks!

webchick’s picture

Category: Feature request » Task
Status: Reviewed & tested by the community » Fixed

Committed and pushed to 8.x. Thanks!

  • webchick committed 721615e on 8.0.x
    Issue #2308521 by mgifford: Added Document accessibility features in...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.