Documentation

Alternative texts

Guideline 1.1 compels us to provide text alternatives for any non-text content so that it can be changed into other forms people need, such as large print, braille, speech, symbols, or simpler language.

To meet this guideline, the mAuthor makes it possible to add descriptions to images. Modules such as Image, Image Identification, Zoom Image, and Image Source have a dedicated property in which you can define the text alternative.

An Image can also be added in the following modules: Choice, Connection, Feedback, Heading, Ordering, Table, and Text. To add a text alternative to an image in one of these modules, you just need to open the HTML Editor (or Items Editor) for this module and double-click on an image. This will open a window in which you can put the text alternative.

With mAuthor, it is possible to deliver content with accessible formulas. The way to provide accessibility is by adding a proper aria-label for a fragment of text containing the formula. Thanks to this option, you can make sure that all formulas are read properly.

To add a text alternative to a fragment of text, you just need to open the HTML Editor for the module containing the text, select it, and click the + button next to the Add alternative text: option. This will open a window in which you can put the text alternative.

You can also just use the \alt{text_shown|text_read}[lang lang_attribute] syntax, and "text_shown" will be displayed (it can also be a LaTeX formula), and “text_read” will be read in the language defined by the lang_attribute.

Alternative Texts: Using Dynamic Gaps

To ensure that mathematical formulas and interactive content remain fully accessible, mAuthor provides a way to include interactive elements within your descriptions. When a module (such as a Math formula or a Text block) contains gaps, you can use the \altGap command within your Alternative Text to represent these input fields.

The \altGap Command

The \altGap command acts as a placeholder that tells screen readers exactly where an interactive gap is located within a complex expression or sentence. This allows users of assistive technologies to understand the context of the empty field they need to fill.

Example Usage

For a complex mathematical expression containing multiple gaps, the Alternative Text should be structured to describe the surrounding operations while marking the gap positions.

Visual Formula:

Editor Configuration: Paste the following syntax into your Text module's content:

\alt{(\int_a^b \cfrac{\gap{}x}{5+\gap{}}\text{d}x)| Definite integral from a to b, of a fraction. Numerator: \altGap multiplied by x. Denominator: five plus \altGap. The whole expression is multiplied by dx.}