Skip to content

Commit

Permalink
Clarify that alttext and altimg are not to be used
Browse files Browse the repository at this point in the history
Closes #30 and the solution is based on the discussion of poor support and no need from the agencies.
  • Loading branch information
samimaattaCelia committed Dec 31, 2024
1 parent 8922287 commit 291b866
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions Guidelines/Nordic MathML Guidelines 2024-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,19 @@ The `<math>` element should use the namespace `http://www.w3.org/1998/Math/MathM

Declaring the namespace in the `<math>` element replaces the deprecated practice of declaring the namespace globally for the document and using the prefix `m:` in all MathML elements.

#### alt-attributes
#### MathML `alttext` and `altimg` attributes

Don't use either of the attributes. The support for the attributes is not good, while support for MathML has improved.

<!-- Sami: I didn't have the heart to straight up delete this if we want to return to discussing this, so it is just commented out.
A `<math>` element has two different alt-attributes:
1. `alttext`
2. `altimg`.
The attribute `alttext` is used to provide an **alternative text** fallback for mathematical content when a reading system doesn't support MathML markup. Usually it is ASCIIMath or LaTeX as these formats are well known in STEM subjects. The Ordering Agency may decide which kind of content should be in the `alttext` attribute.
The attribute `altimg` is used to provide an **alternative image** fallback for mathematical content. Usually this is just a screenshot of the rendered equation. It should be used with caution, since MathML Core does not support the `altimg` attribute. It is also only a visual fallback, because you can't provide an alternative text for the fallback image. The Ordering Agency may decide if the attribute is used.
The attribute `altimg` is used to provide an **alternative image** fallback for mathematical content. Usually this is just a screenshot of the rendered equation. It should be used with caution, since MathML Core does not support the `altimg` attribute. It is also only a visual fallback, because you can't provide an alternative text for the fallback image. The Ordering Agency may decide if the attribute is used. -->

#### Block vs Inline

Expand Down

0 comments on commit 291b866

Please sign in to comment.