Skip to content

Commit 980c186

Browse files
authored
Merge pull request #520 from dginev/main
Add guidance for using aria-description
2 parents 5395b72 + 8a19efb commit 980c186

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

src/accessibility.html

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -424,6 +424,44 @@ <h5 id="acc_natural_lang">Natural-language Mathematics</h5>
424424

425425
</section>
426426

427+
<section>
428+
<h5 id="acc_descriptions">Accessible Descriptions</h5>
429+
430+
<p>It is sometimes beneficial to a reader to have additional, auxiliary information for a given
431+
mathematical construct. This is particularly the case in educational materials where
432+
newly introduced syntax benefits from repeated reinforcement. Such information is often
433+
too verbose for more familiar readers, indeed even to the same person after their first reading.
434+
Hence, common AT behavior has been to only vocalize an
435+
<a href="https://www.w3.org/TR/accname-1.2/#dfn-accessible-description">accessible description</a>
436+
on user request, omitting it by default.</p>
437+
<p>It is appropriate to provide such descriptions using the ARIA 1.3 attribute
438+
<a href="https://www.w3.org/TR/wai-aria-1.3/#aria-description"><code class="attribute">aria-description</code></a>,
439+
which allows for a literal string value to annotate its host element.
440+
As an example, consider the minimal markup for the circumference formula,
441+
with each non-trivial component described.
442+
</p>
443+
444+
<div class="example mathml mmlcore">
445+
<pre>
446+
&lt;mrow aria-description="circumference of a circle"&gt;
447+
&lt;mn&gt;2&lt;/mn&gt;
448+
&lt;mi aria-description="mathematical constant"&gt;π&lt;/mi&gt;
449+
&lt;mi aria-description="radius variable"&gt;r&lt;/mi&gt;
450+
&lt;/mrow&gt;
451+
</pre>
452+
</div>
453+
454+
<p>While <code class="attribute">aria-description</code> has been used on its own for brevity,
455+
it is recommended to use it together with an <code class="attribute">intent</code> annotation,
456+
as appropriate.
457+
</p>
458+
<p> To ensure equal access, when <code class="attribute">aria-description</code>
459+
or <code class="attribute">intent</code> are used,
460+
useful descriptions should also be made visible on the page.
461+
A common affordance to achieve that is interactively displaying
462+
a tooltip containing the description.
463+
</p>
464+
</section>
427465
</section>
428466
</section>
429467
</section>

0 commit comments

Comments
 (0)