On Tue, 9 May 2017 15:19:13 +0100, sebb wrote:
On 9 May 2017 at 14:28, Gilles <[email protected]> wrote:
On Tue, 9 May 2017 09:03:13 -0400, Raymond DeCampo wrote:
How does MathJax interact with HTML entities?
Seems that javadoc8 breaks the build even before MathJax has the
chance
to interpret the LaTeX code.
See this for a more complete answer:
http://docs.mathjax.org/en/latest/tex.html
WHich says:
"Alternatively, you can use the HTML entities <, > and & to
encode these characters so that the browser will not interpret them,
but MathJax will."
"browser" != "javadoc"
These entities are noisy when reading the _source_ Javadoc, even
more so when they are mixed with LaTeX; hence my suggestion to avoid
them in simple statements (the vast majority of Javadoc comments that
use "less than" or "greater than").
MathJax also provides the "\lt" macro (which at least looks like
LaTeX).
Gilles
My LateX is very rusty - is there a suitable escape sequence (like
the
\leq
used in other parts of the doc) that could be used instead?
See reference above; there is "\lt" (defined by "MathJax", not LaTeX
IIUC).
Anyways, I think that we should try and use "{@code ...}" whenever
the
"formula" is just stating inequalities between simple entities
(numbers).
[See the latest Javadoc changes in branch "task_NUMBERS-33_Gamma".]
+1
But that won't always be possible, in which case HTML entities can be
used.
Gilles
On Tue, May 9, 2017 at 7:17 AM, Gilles
<[email protected]>
wrote:
On Tue, 09 May 2017 11:09:49 -0000, [email protected] wrote:
Avoid "malformed HTML" javadoc error
-1
This is not malformed HTML! It is LateX (to be interpreted by
MathJax).
It *is* malformed HTML.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
