Consistent Rule name and token meta information

[rowanc1]

For the default rule name, it would be great if we could have some consistency with dollarmath package? Maybe math_block_amsmath? Or simply make it a math_block and add some metadata to the token to indicate that it is AMS?

It would be great to have consistency between:

$$
\begin{equation}
Ax = b
\end{equation}
$$ (math)

and

\begin{equation}
\label{math}
Ax = b
\end{equation}

and

```{equation}
:label: math
Ax = b
```

and

$$
Ax = b
$$ (math)

In terms of downstream packages not having to know the intricacies of how the math was parsed, this would mean the tokens in all cases would be something close to:

token.type = 'math_block'
token.content = 'Ax = b' || '\begin{...'
token.meta = {amsmath: true, label: 'math', numbered: true}

Maybe optionally strip out equation environments and parse simple label information. In the future as well, as packages may want to label things on their own.

[chrisjsewell]

Yep I can the see the thinking here; seems reasonable 👍

If we do this, a the thing to bear in mind is that these changes also need to be made in mdit-py-plugins, and then in myst-parser, to keep parity (see e.g. executablebooks/mdit-py-plugins#26)

Maybe optionally strip out equation environments and parse simple label information.

hmm, not sure about that: I think having the package start to actually interpret the LaTeX (or reassemble it) is difficult to do in a robust way, without implementing/depending on a proper parser. I would rather leave that to katex/mathjax

[chrisjsewell]

Note you would also have to bear in mind how myst-parser would need to be changed, to accommodate the different token structures:

• https://github.com/executablebooks/MyST-Parser/blob/553b7b8cbdf0e6a6b1beb7f78b2cd23076fcd028/myst_parser/docutils_renderer.py#L778
• https://github.com/executablebooks/MyST-Parser/blob/553b7b8cbdf0e6a6b1beb7f78b2cd23076fcd028/myst_parser/sphinx_renderer.py#L141

(obviously just changing renders, like in #1, will not affect myst-parser in any way, since it works directly from the tokens)

[chrisjsewell]

See also executablebooks/markdown-it-dollarmath#1