The tables below relate information about requirements and implementations of etended descriptions. This is intended to help the community settle on a path. Known relevant resources from which this draws:
The following table outlines proposed approaches to provide extended descriptions. Along with a brief description, the table presents pros, cons, and possible ways of mitigating the cons. Whether an approach meets use cases comprehensively enough is a pro / con but that is addressed in the following table, use cases and technological approaches. Approaches also only work if they are implemented, detailed in the third table.
Description | Pro | Con | Mitigation | |
---|---|---|---|---|
description links | Author provides a link to a desciption near the object. Link text is by convention but not requirement "[D]". |
|
|
|
longdesc | URI to a description is provided in the "longdesc" attribute of the <img> element. |
|
|
|
aria-describedby | Pointer to a description on the same page provided on any object via the "aria-describedby" attribute. This is automatically exposed to the accessibility API. |
|
|
|
aria-describedat | URI to a description is provided in the "aria-describedat" attribute of any object. |
|
|
|
figure with details | <figure> contains a <figcaption> which contains a <details> providing the description. |
|
|
|
figure with details and embedded iFrame | <figure> contains a <figcaption> which contains a <details> which contains an <iframe> that loads the description. |
|
|
|
figure with details with src and role attributes | <figure> contains a <figcaption> which contains a <details> which loads an external description from the "src" attribute and clarifies it's a description with the "role" attribute |
|
|
|
accessible SVG | Native SVG features provide description. |
|
|
|
SVG wrapping bitmap | SVG with description loads a raster image for the presentation. |
|
|
|
link in figure caption | Description link provided in <figcaption>. |
|
|
|
hidden iframe |
|
|
||
client-side image map |
|
|||
web annotations | Description treated as an annotation, externally stored and related to the object. |
|
|
The grid below is intended to map known extended description requirements to technological ways to meet them. Approaches that meet more use cases will generally be preferred, though the other pros and cons also need to be considered.
description links | longdesc | aria-describedby | aria-describedat | figure with details | figure with details and embedded iFrame | figure with details with src and role attributes | accessible SVG | SVG wrapping bitmap | link in figure caption | hidden iframe | client-side image map | web annotations | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Not restricted to images | yes | no | yes | yes | ? | ? | ? | no | no | ? | no | no | yes |
Can hold rich content | yes | yes | no | yes | yes | yes | yes | yes | yes | yes | yes | ? | yes |
Same technique for different objects | yes | no | yes | yes | ? | ? | ? | no | no | ? | ? | ? | yes |
Reusable in multiple content | yes | yes | no | yes | no | yes | yes | no | no | yes | yes | ? | yes? |
Description clearly associated with object | no | yes | yes | yes | yes | yes | yes | yes | yes | yes | no | yes | yes? |
Clear which associated object is the description | no | yes | yes | yes | no | no | yes | yes | yes | no | no | yes? | yes? |
Not bloat primary content page | yes | yes | no | yes | no | yes | yes | no | no | yes | yes | ? | yes |
Not required to be visible in standard content view | yes | yes | ? | yes | ? | ? | ? | ? | ? | yes | ? | ? | yes |
Discoverable by AT | no | yes | yes | yes | yes | yes | yes | yes | yes | ? | ? | yes | ? |
Available on demand to AT users | no | yes | yes | yes | yes | yes | yes | yes | yes | ? | ? | yes | yes? |
Skippable by AT | yes | yes | ? | yes | yes | yes | yes | ? | ? | yes | ? | yes | yes |
Able to pass structured content to an additional specialized user agent | yes | yes | no | yes | yes | yes | yes | yes | yes | yes | yes | ? | ? |
Easily usable by non-AT users | yes | no | no | no | no | no | no | ? | ? | yes | ? | yes? | yes? |
Information about the known implementation of particular approaches is provided here. An approach that has, or is expected soon to have, more implementation will tend to be preferred. Note: implementation information below refers to implementation needed to make the description available to assistive technology, not simply implementation of the base feature in mainstream user agents.
Webkit | Blink | Gecko | IE | Edge | |
---|---|---|---|---|---|
description links | N/A | N/A | N/A | N/A | N/A |
longdesc | No | ? | ? | ? | ? |
aria-describedby | ? | ? | ? | ? | ? |
aria-describedat | No | ? | ? | ? | ? |
figure with details | ? | ? | ? | ? | ? |
figure with details and embedded iFrame | Yes? | Yes? | ? | ? | ? |
figure with details with src and role attributes | No | ? | ? | ? | ? |
accessible SVG | ? | ? | ? | ? | ? |
SVG wrapping bitmap | ? | ? | ? | ? | ? |
link in figure caption | ? | ? | ? | ? | ? |
hidden iframe | ? | ? | ? | ? | ? |
image map | ? | ? | ? | ? | ? |
web annotations | ? | ? | ? | ? | ? |
Information about how difficult it is likely to be to implement, both for authors (who must implement a lot) and user agents (who must implement once, but with attention to impacts).
Authors | UA | |
---|---|---|
description links | low | N/A |
longdesc | med | low |
aria-describedby | med | med |
aria-describedat | med | low |
figure with details | med | low |
figure with details and embedded iFrame | high | med |
figure with details with src and role attributes | high | med |
accessible SVG | high | high |
SVG wrapping bitmap | med | high |
link in figure caption | low | low |
hidden iframe | med | low |
image map | med | low |
web annotations | high | high |
Information about how difficult it is likely to be to implement, both for authors (who must implement a lot) and user agents (who must implement once, but with attention to impacts).
Uses AAPI | Requires Script | |
---|---|---|
description links | no | no |
longdesc | yes | no |
aria-describedby | yes | no |
aria-describedat | yes | no |
figure with details | no | ? |
figure with details and embedded iFrame | no | ? |
figure with details with src and role attributes | no | ? |
accessible SVG | yes | no |
SVG wrapping bitmap | yes | no |
link in figure caption | no | no |
hidden iframe | no | ? |
image map | no | no |
web annotations | no | yes? |