Organize MathML into Guides and Reference #38379

pepelsbey · 2025-02-28T17:08:41Z

Moves MathML reference and guides into subfolders

- mathml/authoring/index.md
+ mathml/guides/authoring/index.md

- mathml/attribute/index.md
+ mathml/reference/attribute/index.md

Groups the loose guide into a tutorial

- mathml/guides/getting_started/index.md
+ mathml/tutorials/for_beginners/index.md
+ mathml/tutorials/for_beginners/getting_started/index.md

Removes the Examples landing page in favor of Guides

- mathml/examples/index.md

The content went to the Guides landing page.

Creates a landing page for the reference and tutorials

+ mathml/reference/index.md
+ mathml/tutorials/index.md

Uses front-matter sidebar

- {{MathMLRef}}
+ sidebar: mathmlref

Adds short-titles to make the sidebar look better

title: MathML attributes
+ short-title: Attributes

Normalizes titles using sentence case

- title: Deriving the Quadratic Formula
+ title: Deriving the quadratic formula

Motivation

Docs IA & maintenance, see mdn/mdn#637

github-actions · 2025-02-28T17:10:08Z

Preview URLs (73 pages)

Flaws (241)

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

URL: /en-US/docs/Glossary/MathML
Title: MathML
Flaw count: 2

broken_links:
- /en-US/docs/Glossary/browser is ill cased
macros:
- Macro produces link /en-US/docs/Glossary/browser which is a redirect

URL: /en-US/docs/Mozilla/Firefox/Releases/7
Title: Firefox 7 for developers
Flaw count: 20

broken_links:
- /en-US/docs/Web/API/HTMLelement/dir is ill cased
- /en-US/docs/Web/API/window/deviceorientation_event is ill cased
- /en-US/docs/Web/API/window/devicemotion_event is ill cased
- /en-US/docs/Web/API/window is ill cased
- /en-US/docs/Web/API/window/resizeTo is ill cased
- and 3 more flaws omitted
macros:
- Macro produces link /en-US/docs/Web/MathML/Element/mpadded which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/math which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mstyle which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mfrac which is a redirect
- Macro produces link /en-US/docs/Web/API/HTMLelement/dir which is a redirect
- and 7 more flaws omitted

URL: /en-US/docs/Mozilla/Firefox/Releases/12
Title: Firefox 12 for developers
Flaw count: 8

broken_links:
- /en-US/docs/Web/API/element/getBoundingClientRect is ill cased
macros:
- Macro produces link /en-US/docs/Web/API/element/getBoundingClientRect which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/math which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mrow which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mstyle which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/munder which is a redirect
- and 2 more flaws omitted

URL: /en-US/docs/Mozilla/Firefox/Releases/15
Title: Firefox 15 for developers
Flaw count: 2

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/maction which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mpadded which is a redirect

URL: /en-US/docs/Mozilla/Firefox/Releases/24
Title: Firefox 24 for developers
Flaw count: 3

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/math which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mrow which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/menclose which is a redirect

URL: /en-US/docs/Mozilla/Firefox/Releases/71
Title: Firefox 71 for Developers
Flaw count: 3

broken_links:
- /en-US/docs/Web/API/navigator/mediaSession is ill cased
macros:
- Macro produces link /en-US/docs/Web/HTTP/Headers/Server-Timing which is a redirect
- Macro produces link /en-US/docs/Web/API/navigator/mediaSession which is a redirect

URL: /en-US/docs/Web/CSS/@namespace
Title: @namespace
Flaw count: 3

broken_links:
- Can't resolve /en-US/docs/Web/CSS/url-modifier
- Can't resolve /en-US/docs/Web/CSS/url-token
- Can't resolve /en-US/docs/Web/CSS/url-modifier

URL: /en-US/docs/Web/MathML/Guides/Authoring
Title: Authoring MathML
Flaw count: 3

broken_links:
- /en-US/docs/Web/MathML/Element/mspace is a redirect
- /en-US/docs/Web/MathML/Element/mpadded is a redirect
- /en-US/docs/Web/HTTP/Browser_detection_using_the_user_agent is a redirect

URL: /en-US/docs/Web/MathML/Guides/Deriving_the_quadratic_formula
Title: Deriving the quadratic formula
Flaw count: 2

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/mtable which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/annotation which is a redirect

URL: /en-US/docs/Web/MathML/Guides/Proving_the_Pythagorean_theorem
Title: Proving the Pythagorean theorem
Flaw count: 2

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/mtable which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/annotation which is a redirect

URL: /en-US/docs/Web/MathML/Reference/Attribute
Title: MathML attributes
Flaw count: 65

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/mo which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mover which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/munderover which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/munder which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/munderover which is a redirect
- and 60 more flaws omitted

URL: /en-US/docs/Web/MathML/Reference/Element
Title: MathML elements
Flaw count: 64

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/math which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/maction which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/annotation which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/annotation-xml which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/menclose which is a redirect
- and 59 more flaws omitted

URL: /en-US/docs/Web/MathML/Reference/Element/annotation
Title: <annotation>
Flaw count: 1

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/semantics which is a redirect

URL: /en-US/docs/Web/MathML/Reference/Element/annotation-xml
Title: <annotation-xml>
Flaw count: 1

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/semantics which is a redirect

URL: /en-US/docs/Web/MathML/Reference/Element/mfenced
Title: <mfenced>
Flaw count: 2

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/mrow which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mo which is a redirect

URL: /en-US/docs/Web/MathML/Reference/Element/mmultiscripts
Title: <mmultiscripts>
Flaw count: 6

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/msubsup which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mprescripts which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mrow which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/msub which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/msup which is a redirect
- and 1 more flaws omitted

URL: /en-US/docs/Web/MathML/Reference/Element/mover
Title: <mover>
Flaw count: 2

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/munder which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/munderover which is a redirect

URL: /en-US/docs/Web/MathML/Reference/Element/mpadded
Title: <mpadded>
Flaw count: 2

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/mphantom which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mspace which is a redirect

URL: /en-US/docs/Web/MathML/Reference/Element/mphantom
Title: <mphantom>
Flaw count: 2

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/mspace which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mpadded which is a redirect

URL: /en-US/docs/Web/MathML/Reference/Element/mprescripts
Title: <mprescripts>
Flaw count: 4

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/mmultiscripts which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/msub which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/msup which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/msubsup which is a redirect

URL: /en-US/docs/Web/MathML/Reference/Element/mroot
Title: <mroot>
Flaw count: 1

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/msqrt which is a redirect

URL: /en-US/docs/Web/MathML/Reference/Element/mrow
Title: <mrow>
Flaw count: 2

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/mi which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mn which is a redirect

URL: /en-US/docs/Web/MathML/Reference/Element/mspace
Title: <mspace>
Flaw count: 2

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/mpadded which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mphantom which is a redirect

URL: /en-US/docs/Web/MathML/Reference/Element/msqrt
Title: <msqrt>
Flaw count: 1

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/mroot which is a redirect

URL: /en-US/docs/Web/MathML/Reference/Element/msub
Title: <msub>
Flaw count: 3

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/msup which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/msubsup which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mmultiscripts which is a redirect

URL: /en-US/docs/Web/MathML/Reference/Element/msubsup
Title: <msubsup>
Flaw count: 3

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/msub which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/msup which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mmultiscripts which is a redirect

URL: /en-US/docs/Web/MathML/Reference/Element/msup
Title: <msup>
Flaw count: 3

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/msub which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/msubsup which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mmultiscripts which is a redirect

URL: /en-US/docs/Web/MathML/Reference/Element/mtable
Title: <mtable>
Flaw count: 4

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/mtr which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mtd which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mtd which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mtr which is a redirect

URL: /en-US/docs/Web/MathML/Reference/Element/mtd
Title: <mtd>
Flaw count: 7

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/mtr which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mtable which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mtr which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mtable which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mtr which is a redirect
- and 2 more flaws omitted

URL: /en-US/docs/Web/MathML/Reference/Element/mtext
Title: <mtext>
Flaw count: 4

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/mi which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mn which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mo which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/ms which is a redirect

URL: /en-US/docs/Web/MathML/Reference/Element/mtr
Title: <mtr>
Flaw count: 6

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/mtable which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mtd which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mtable which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mtable which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mtable which is a redirect
- and 1 more flaws omitted

URL: /en-US/docs/Web/MathML/Reference/Element/munder
Title: <munder>
Flaw count: 2

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/mover which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/munderover which is a redirect

URL: /en-US/docs/Web/MathML/Reference/Element/munderover
Title: <munderover>
Flaw count: 2

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/munder which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/mover which is a redirect

URL: /en-US/docs/Web/MathML/Reference/Element/semantics
Title: <semantics>
Flaw count: 2

macros:
- Macro produces link /en-US/docs/Web/MathML/Element/annotation which is a redirect
- Macro produces link /en-US/docs/Web/MathML/Element/annotation-xml which is a redirect

URL: /en-US/docs/Web/MathML/Reference/Global_attributes
Title: MathML global attributes
Flaw count: 1

macros:
- Can't resolve /en-US/docs/Web/MathML/Element/style

URL: /en-US/docs/Web/MathML/Tutorials/For_beginners/Tables
Title: MathML tables
Flaw count: 1

broken_links:
- Can't resolve /en-US/docs/Learn_web_development/Core/Structuring_content/HTML_table_basics/Basics#allowing_cells_to_span_multiple_rows_and_columns

External URLs (19)

URL: /en-US/docs/Mozilla/Firefox/Releases/12
Title: Firefox 12 for developers

https://www.w3.org/TR/arabic-math/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Mozilla/Firefox/Releases/71
Title: Firefox 71 for Developers

https://bugzil.la/1571487 (2 times) (Note! This may be a new URL 👀)

URL: /en-US/docs/Mozilla/Firefox/Releases/83
Title: Firefox 83 for developers

https://bugzil.la/1666075 (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Mozilla/Firefox/Releases/106
Title: Firefox 106 for developers

https://bugzil.la/1588733 (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Mozilla/Firefox/Releases/118
Title: Firefox 118 for developers

https://bugzil.la/1788223 (1 time) (Note! This may be a new URL 👀)
https://bugzil.la/1845461 (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/CSS/@namespace
Title: @namespace

https://html.spec.whatwg.org/multipage/syntax.html (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/MathML
Title: MathML

🚨 http://eyeasme.com/Joe/MathML/MathML_browser_test.html (1 time) (Note! This may be a new URL 👀)
https://en.wikipedia.org/wiki/Computers_and_Typesetting (1 time) (Note! This may be a new URL 👀)
https://en.wikipedia.org/wiki/LaTeX (3 times) (Note! This may be a new URL 👀)
https://fred-wang.github.io/MathFonts/%CE%A3%CF%85%CE%BD%CE%AC%CF%81%CF%84%CE%B7%CF%83%CE%B7_%CE%B6%CE%AE%CF%84%CE%B1_%CE%A1%CE%AE%CE%BC%CE%B1%CE%BD.html (1 time) (Note! This may be a new URL 👀)
https://fred-wang.github.io/MathFonts/mozilla_mathml_test/ (1 time) (Note! This may be a new URL 👀)
https://fred-wang.github.io/TeXZilla/examples/customElement.html (1 time) (Note! This may be a new URL 👀)
https://fred-wang.github.io/TeXZilla/examples/toImageWebGL.html (1 time) (Note! This may be a new URL 👀)
https://greekfontsociety-gfs.gr/ (1 time) (Note! This may be a new URL 👀)
https://people.igalia.com/fwang/lovelace-jsclass-mathml/ (1 time) (Note! This may be a new URL 👀)
https://people.igalia.com/fwang/pell-bigint-mathml/ (1 time) (Note! This may be a new URL 👀)

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

https://w3c.github.io/mathml-core/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/MathML/Tutorials/For_beginners/Three_famous_mathematical_formulas
Title: Challenge: Three famous mathematical formulas

https://fred-wang.github.io/TeXZilla/ (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2025-03-13 17:04:23)

pepelsbey · 2025-03-11T12:38:02Z

@bsmth @fred-wang it’s ready :) Thanks!

files/sidebars/mathmlref.yaml

bsmth

Checked again and everything looking as expected, +1 from me

pepelsbey · 2025-03-13T09:30:40Z

@fred-wang We’re mostly moving stuff around in these PRs to organize them into tutorials, guides, and reference folders. We barely touch content, and when we do, it’s just some editorial changes. So I wouldn’t worry too much about reviewing these changes from the expert point of view.

github-actions · 2025-03-13T12:50:42Z

This pull request has merge conflicts that must be resolved before it can be merged.

bsmth · 2025-03-14T11:56:27Z

TODOs as a follow-up in rari:

https://github.com/mdn/rari/blob/main/crates/rari-doc/src/templ/templs/links/mathmlxref.rs

See:

fix: update paths for HTTP section move rari#155

pepelsbey · 2025-03-14T12:29:52Z

Follow-up PR for rari mdn/rari#156

pepelsbey marked this pull request as ready for review March 3, 2025 12:44

pepelsbey requested review from a team as code owners March 3, 2025 12:44

pepelsbey requested review from fred-wang, estelle and bsmth and removed request for a team, fred-wang and estelle March 3, 2025 12:44

github-actions bot added the merge conflicts 🚧 [PR only] label Mar 6, 2025

pepelsbey force-pushed the move/mathml branch from 7d6f441 to 0686973 Compare March 11, 2025 12:30

github-actions bot removed the merge conflicts 🚧 [PR only] label Mar 11, 2025

pepelsbey marked this pull request as ready for review March 11, 2025 12:37

pepelsbey requested a review from fred-wang March 11, 2025 12:37

bsmth reviewed Mar 11, 2025

View reviewed changes

files/sidebars/mathmlref.yaml Outdated Show resolved Hide resolved

bsmth approved these changes Mar 12, 2025

View reviewed changes

github-actions bot added the merge conflicts 🚧 [PR only] label Mar 13, 2025

pepelsbey removed the request for review from fred-wang March 13, 2025 16:35

pepelsbey force-pushed the move/mathml branch from 5d014ff to ad49c61 Compare March 13, 2025 16:51

pepelsbey added 10 commits March 13, 2025 18:02

Organize MathML into Guides and Reference

2182070

Use sidebar instead of macro

1348145

Use sentence case

fc92ca3

Add short titles

b627684

Add link to the Reference

3a1592f

Move beginner’s tutorial to Tutorials section

699604d

Create a separate tutorial

497e586

Cross-link tutorials, guides, reference

101ed3d

Apply suggestion

bfc619c

Add Guides section

a834f7b

pepelsbey force-pushed the move/mathml branch from ad49c61 to a834f7b Compare March 13, 2025 17:02

github-actions bot removed the merge conflicts 🚧 [PR only] label Mar 13, 2025

pepelsbey merged commit c263f06 into mdn:main Mar 13, 2025
8 of 9 checks passed

pepelsbey deleted the move/mathml branch March 13, 2025 17:05

pepelsbey mentioned this pull request Mar 14, 2025

fix: update paths for SVG/MathML section move mdn/rari#156

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Organize MathML into Guides and Reference #38379

Organize MathML into Guides and Reference #38379

pepelsbey commented Feb 28, 2025 •

edited

Loading

github-actions bot commented Feb 28, 2025 •

edited

Loading

pepelsbey commented Mar 11, 2025

bsmth left a comment

pepelsbey commented Mar 13, 2025

github-actions bot commented Mar 13, 2025

bsmth commented Mar 14, 2025 •

edited

Loading

pepelsbey commented Mar 14, 2025

Organize MathML into Guides and Reference #38379

Organize MathML into Guides and Reference #38379

Conversation

pepelsbey commented Feb 28, 2025 • edited Loading

Moves MathML reference and guides into subfolders

Groups the loose guide into a tutorial

Removes the Examples landing page in favor of Guides

Creates a landing page for the reference and tutorials

Uses front-matter sidebar

Adds short-titles to make the sidebar look better

Normalizes titles using sentence case

Motivation

github-actions bot commented Feb 28, 2025 • edited Loading

pepelsbey commented Mar 11, 2025

bsmth left a comment

Choose a reason for hiding this comment

pepelsbey commented Mar 13, 2025

github-actions bot commented Mar 13, 2025

bsmth commented Mar 14, 2025 • edited Loading

pepelsbey commented Mar 14, 2025

pepelsbey commented Feb 28, 2025 •

edited

Loading

github-actions bot commented Feb 28, 2025 •

edited

Loading

bsmth commented Mar 14, 2025 •

edited

Loading