Add buildHTMLTree #1022
Add buildHTMLTree #1022
Conversation
| ): domTree.span { | ||
| const options = optionsFromSettings(settings); | ||
| const htmlNode = buildHTML(tree, options); | ||
| const katexNode = buildCommon.makeSpan(["katex"], [htmlNode]); |
There was a problem hiding this comment.
Is the katexNode necessary here? Why not just return htmlNode?
There was a problem hiding this comment.
Hmm, good question. htmlNode would be natural too. My reasoning here was that there are various CSS rules that only apply with the .katex-display .katex nesting...
|
@rrandallcainc I think because we haven't released a version with this change (right?) it's probably OK, though obviously not ideal. |
|
Yup, agreed that this should not be an issue. Forgot it hasn't been released. |
|
@edemaine These changes look fine to me. What were you thinking for the new naming convention? |
|
How about the following?
Hmm, maybe we should have |
|
Using the existing "render" nomenclature sounds good. I agree that consistency would be nice here. |
|
OK, I did the renames. I also added some clarifying documentation so it's clear what the different functions provide. It occurs to me that a "no MathML" option would still be neat in that it would allow |
|
🎉 |
|
@rrandallcainc Thanks for the quick review! |
This is a followup to #1017 (Exposing the build tree). It includes a new
generateBuildHTMLTreefunction that skips the MathML step, and exposes that function as__getBuildHTMLTree. See #800 for discussion.I'd like to have a discussion about the naming of these functions. I find the naming of these functions, and the
generateBuildTreeand__getBuildTreethat come from #1017, to be "incorrect". I don't think these were ever supposed to be called "build trees". "Build" inbuildTreewas meant as a verb, as in "build a tree". I think it would make more sense to renamebuildTreetodomTreeor something. Alternatively, we could renamegenerateBuildTreetoparseAndBuildTreeor something like this, which is what it's doing. I also am not a fan of thegetin__get. If there's consensus, I can rename in this PR.