Format and clean up MathML #34430

pepelsbey · 2024-06-26T14:10:11Z

Description

Block-level MathML is marked with display="block"*
Inline-level MathML is properly inlined
Most of the formulas are annotated
Old xmlns attributes are removed
Non-typical formatting is cleaned up
Prettied also took care of some files I touched

* this will help with styling, but that’s another task.

Motivation

MathML clean-up project.

github-actions · 2024-06-26T14:12:13Z

Preview URLs (88 pages)

Flaws (23)

Note! 83 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/RTCIceCandidateStats/priority
Title: RTCIceCandidateStats: priority property
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCAudioSourceStats
Title: RTCAudioSourceStats
Flaw count: 1

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters

URL: /en-US/docs/Web/API/RTCAudioSourceStats/totalAudioEnergy
Title: RTCAudioSourceStats: totalAudioEnergy property
Flaw count: 2

macros:
- Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters
- /en-US/docs/Web/API/RTCInboundRtpStreamStats/totalAudioEnergy does not exist

URL: /en-US/docs/Web/API/DOMMatrix
Title: DOMMatrix (WebKitCSSMatrix)
Flaw count: 18

macros:
- /en-US/docs/Web/API/DOMMatrix/invertSelf does not exist
- /en-US/docs/Web/API/DOMMatrix/is2D does not exist
- /en-US/docs/Web/API/DOMMatrix/multiplySelf does not exist
- /en-US/docs/Web/API/DOMMatrix/preMultiplySelf does not exist
- /en-US/docs/Web/API/DOMMatrix/translateSelf does not exist
- and 13 more flaws omitted

URL: /en-US/docs/Web/API/WebXR_Device_API/Movement_and_motion
Title: Movement, orientation, and motion: A WebXR example
Flaw count: 1

macros:
- /en-US/docs/Web/API/XRWebGLLayer/viewport does not exist

External URLs (4)

URL: /en-US/docs/Web/CSS/transform-function/matrix3d
Title: matrix3d()

https://en.wikipedia.org/wiki/Affine_transformation (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/MathML/Element/menclose
Title: <menclose>

https://en.wikipedia.org/wiki/Actuarial_notation (1 time) (Note! This may be a new URL 👀)
https://en.wikipedia.org/wiki/Modern_Arabic_mathematical_notation (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/MathML/Examples/MathML_Pythagorean_Theorem
Title: Proving the Pythagorean theorem

🚨 http://www.cut-the-knot.org/pythagoras/proof31.gif (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2024-07-09 22:11:11)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Josh-Cena · 2024-06-27T12:41:47Z

For SVG, there's no better way to hand-adjust the content than to manually write it. But MathML is fully reproducible from the TeX source code, which is conveniently embedded via <annotation>, if you ever hand-adjust it, you are just going to make it out of sync with the TeX. It's the same idea as Mermaid-generated SVGs, which I hope you've never hand-adjusted. The workflow should always be like "write TeX -> plug it into TeXZilla -> paste the output here, with no formatting and everything on the same line".

pepelsbey · 2024-07-01T10:17:05Z

MathML is fully reproducible from the TeX source code, which is conveniently embedded via <annotation>

I wish that would be the case. In many cases, the <annotation> is missing. Also, when I try to create MathML from TeX or TeX from MathML, tools often fail to convert for various reasons. So, I started to trust the MathML source more than the annotations while working on this task.

Josh-Cena · 2024-07-01T13:27:05Z

In many cases, the <annotation> is missing.

We should add them, then, otherwise our capability to edit them is severely limited.

Also, when I try to create MathML from TeX or TeX from MathML, tools often fail to convert for various reasons.

In my experience TeXZilla is very stable. We should recommend it (it's made by @fred-wang).

I still don't think you should edit MathML by hand very often. There are a lot of fine tunings to equations such as kernings, offsets, and use of Unicode symbols that are usually missed if you don't do it algorithmically.

dipikabh

I've left a few edit suggestions for the prose touched. For the rest, I am deferring to Frédéric Wang's expertise :)

files/en-us/web/api/baseaudiocontext/createperiodicwave/index.md

files/en-us/web/api/canvasrenderingcontext2d/settransform/index.md

files/en-us/web/api/xrrigidtransform/matrix/index.md

files/en-us/web/javascript/reference/global_objects/math/log1p/index.md

files/en-us/web/mathml/examples/mathml_pythagorean_theorem/index.md

Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>

Josh-Cena · 2024-07-03T17:36:30Z

Thanks 👍 I'm happy as long as they are collapsed!

Are the Prettier comments necessary? I don't think Prettier touches XML markup in Markdown.

Josh-Cena

I don't have the capacity to review other pages (the diff is hard to read on GH and slow to render locally), but I have one suggestion for JS.

files/en-us/web/javascript/reference/global_objects/math/log1p/index.md

pepelsbey · 2024-07-04T08:58:16Z

Are the Prettier comments necessary? I don't think Prettier touches XML markup in Markdown.

@Josh-Cena Unfortunately, Prettier is trying to replace x_2 with x*2 in annotations, and since they have to be literal to be reproducible, I can’t x\_2 them. So, only ignoring helps.

Josh-Cena · 2024-07-04T13:46:15Z

I see.

Josh-Cena

I've applied the Math.log1p change to Math.expm1 for consistency. Merge it when you like.

pepelsbey · 2024-07-09T22:41:57Z

Thank you everyone!

* Format and clean up MathML * Update files/en-us/web/css/transform-function/matrix3d/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Clean up annotations * Apply suggestions from code review Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org> * Apply suggestions from code review Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org> * Apply suggestions from code review Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org> * Fix annotations * Collapse block math, add/fix annotations * Update formula from the spec * Fix annotations * Hide annotation from Prettier * Revert some changes * Fix exp1m * Collapse and add annotations --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org> Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

Format and clean up MathML

32acb9d

pepelsbey requested review from a team as code owners June 26, 2024 14:10

pepelsbey requested review from fred-wang, sideshowbarker and estelle and removed request for a team June 26, 2024 14:10

github-actions bot added Content:CSS Cascading Style Sheets docs Content:WebAPI Web API docs Content:JS JavaScript docs Content:Learn Learning area docs Content:SVG SVG docs Content:Media Media docs Content:MathML MathML docs Content:Games Games docs labels Jun 26, 2024

pepelsbey removed request for a team, fred-wang, sideshowbarker and estelle June 26, 2024 14:10

github-actions bot added the size/xl [PR only] >1000 LoC changed label Jun 26, 2024

pepelsbey requested review from dipikabh and bsmth June 26, 2024 14:10

Update files/en-us/web/css/transform-function/matrix3d/index.md

c79f346

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Clean up annotations

ff9a552

dipikabh approved these changes Jul 3, 2024

View reviewed changes

pepelsbey and others added 5 commits July 3, 2024 17:03

Apply suggestions from code review

a80c8c0

Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>

Apply suggestions from code review

d27b3ef

Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>

Apply suggestions from code review

f5c08e2

Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>

Fix annotations

c862dee

Collapse block math, add/fix annotations

a8c8d72

Josh-Cena requested changes Jul 3, 2024

View reviewed changes

files/en-us/web/javascript/reference/global_objects/math/log1p/index.md Outdated Show resolved Hide resolved

pepelsbey added 2 commits July 9, 2024 12:03

Update formula from the spec

2762793

Fix annotations

0b1cf30

mdn deleted a comment from github-actions bot Jul 9, 2024

pepelsbey and others added 3 commits July 9, 2024 12:30

Hide annotation from Prettier

5682da0

Revert some changes

75ac366

Fix exp1m

3ed650a

Josh-Cena approved these changes Jul 9, 2024

View reviewed changes

pepelsbey force-pushed the math-block-inline branch from a0156ba to 48b438e Compare July 9, 2024 20:20

Collapse and add annotations

4869fc1

pepelsbey force-pushed the math-block-inline branch from 48b438e to 4869fc1 Compare July 9, 2024 21:26

Merge branch 'main' into math-block-inline

b4c7baf

pepelsbey merged commit 4f263d8 into mdn:main Jul 9, 2024
8 checks passed

pepelsbey deleted the math-block-inline branch July 9, 2024 22:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Format and clean up MathML #34430

Format and clean up MathML #34430

pepelsbey commented Jun 26, 2024 •

edited

Loading

github-actions bot commented Jun 26, 2024 •

edited

Loading

Josh-Cena commented Jun 27, 2024

pepelsbey commented Jul 1, 2024

Josh-Cena commented Jul 1, 2024

dipikabh left a comment

Josh-Cena commented Jul 3, 2024

Josh-Cena left a comment

pepelsbey commented Jul 4, 2024

Josh-Cena commented Jul 4, 2024

Josh-Cena left a comment

pepelsbey commented Jul 9, 2024

Format and clean up MathML #34430

Format and clean up MathML #34430

Conversation

pepelsbey commented Jun 26, 2024 • edited Loading

Description

Motivation

github-actions bot commented Jun 26, 2024 • edited Loading

Josh-Cena commented Jun 27, 2024

pepelsbey commented Jul 1, 2024

Josh-Cena commented Jul 1, 2024

dipikabh left a comment

Choose a reason for hiding this comment

Josh-Cena commented Jul 3, 2024

Josh-Cena left a comment

Choose a reason for hiding this comment

pepelsbey commented Jul 4, 2024

Josh-Cena commented Jul 4, 2024

Josh-Cena left a comment

Choose a reason for hiding this comment

pepelsbey commented Jul 9, 2024

pepelsbey commented Jun 26, 2024 •

edited

Loading

github-actions bot commented Jun 26, 2024 •

edited

Loading