Skip to content

Parse LaTeX in the user guide to MathML#19304

Merged
seanbudd merged 1 commit into
masterfrom
latexUg
Nov 30, 2025
Merged

Parse LaTeX in the user guide to MathML#19304
seanbudd merged 1 commit into
masterfrom
latexUg

Conversation

@SaschaCowley

Copy link
Copy Markdown
Member

Link to issue number:

Closes #19014

Summary of the issue:

Since #18323, there has been LaTeX included in the User Guide. However, it was not parsed, just left as source.

Description of user facing changes:

The newly added LaTeX is now parsed to MathML, meaning it may be interacted with using MathCAT, and should be displayed in modern browsers.

Description of developer facing changes:

None

Description of development approach:

  • Added l2m4m to as a dependency.
  • Added its LaTeX2MathMLExtension to the extensions used when converting the user guide.
  • Whitelisted the MathML tags that we currently use in the user guide.
  • Allowed the display attribute on <math> tags.
  • Added an attribute filter callable that strips the display attribute on <math> tags if its value is inline, as this is redundant.

Testing strategy:

Built the user guide and read the relevant sections with NVDA. Also inspected the generated HTML to make sure it was sensible.

Known issues with pull request:

None

Code Review Checklist:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

@SaschaCowley SaschaCowley requested a review from a team as a code owner November 30, 2025 03:35

@seanbudd seanbudd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice, thanks

@seanbudd seanbudd merged commit 7285300 into master Nov 30, 2025
41 checks passed
@seanbudd seanbudd deleted the latexUg branch November 30, 2025 23:22
@github-actions github-actions Bot added this to the 2026.1 milestone Nov 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Process LaTeX embedded in the user guide

2 participants