Menu
▾
▴
[Docutils-checkins] SF.net SVN: docutils:[9514] trunk/docutils
|
From: <mi...@us...> - 2024-01-15 16:10:45
|
Revision: 9514
http://sourceforge.net/p/docutils/code/9514
Author: milde
Date: 2024-01-15 16:10:42 +0000 (Mon, 15 Jan 2024)
Log Message:
-----------
latex2mathml revision
Simplify/clarify code.
Raise MathError when pretty-printing a node with missing children
(e.g. the conversion of `\frac{1}` or `x_`).
Better rendering of math accents.
Modified Paths:
--------------
trunk/docutils/docs/ref/rst/mathematics.txt
trunk/docutils/docutils/utils/math/latex2mathml.py
trunk/docutils/test/functional/expected/math_output_mathml.html
Modified: trunk/docutils/docs/ref/rst/mathematics.txt
===================================================================
--- trunk/docutils/docs/ref/rst/mathematics.txt 2024-01-13 11:10:47 UTC (rev 9513)
+++ trunk/docutils/docs/ref/rst/mathematics.txt 2024-01-15 16:10:42 UTC (rev 9514)
@@ -121,12 +121,12 @@
.. class:: colwidths-auto
- =========== ============= =========== ============= ============== ================
- `\acute{x}` ``\acute{x}`` `\dot{t}` ``\dot{t}`` `\hat{x}` ``\hat{x}``
- `\bar{v}` ``\bar{v}`` `\ddot{t}` ``\ddot{t}`` `\mathring{x}` ``\mathring{x}``
- `\breve{x}` ``\breve{x}`` `\dddot{t}` ``\dddot{t}`` `\tilde{n}` ``\tilde{n}``
- `\check{x}` ``\check{x}`` `\grave{x}` ``\grave{x}`` `\vec{x}` ``\vec{x}``
- =========== ============= =========== ============= ============== ================
+ =========== ============= ============ ============== ============== ================ ========= ===========
+ `\acute{x}` ``\acute{x}`` `\dot{t}` ``\dot{t}`` `\grave{x}` ``\grave{x}`` `\vec{x}` ``\vec{x}``
+ `\bar{v}` ``\bar{v}`` `\ddot{t}` ``\ddot{t}`` `\hat{x}` ``\hat{x}``
+ `\breve{x}` ``\breve{x}`` `\dddot{t}` ``\dddot{t}`` `\mathring{x}` ``\mathring{x}``
+ `\check{x}` ``\check{x}`` `\ddddot{t}` ``\ddddot{t}`` `\tilde{n}` ``\tilde{n}``
+ =========== ============= ============ ============== ============== ================ ========= ===========
When adding an accent to an i or j in math, dotless variants can be
obtained with ``\imath`` and ``\jmath``: `\hat \imath`, `\vec{\jmath}`.
@@ -312,6 +312,8 @@
============= =============== ========== ============ ========== ============ =========== =============
+.. _math alphabet:
+
Mathematical Alphabets
----------------------
@@ -374,7 +376,7 @@
mathematical symbol (for other output formats, results are mixed):
.. math::
- \boldsymbol{\cos(x)\pm\alpha \approx 3\Gamma \quad \forall x\in\mathbb{R}}
+ \boldsymbol{V_i x \pm \cos(\alpha) \approx 3\Gamma \quad \forall x\in\mathbb{R}}
Miscellaneous symbols
@@ -882,9 +884,9 @@
The declarations [#]_ ``\displaystyle``, ``\textstyle``,
``\scriptstyle``, and ``\scriptscriptstyle``, select a symbol size and
-spacing that would be applied in (respectively) display math, inline
-math, first-order subscript, or second-order subscript, even when the
-current context would normally yield some other size.
+spacing that would be applied in display math, inline
+math, first-order subscript, or second-order subscript, respectively
+even when the current context would normally yield some other size.
For example ``:math:`\displaystyle \sum_{n=0}^\infty
\frac{1}{n}``` is printed as `\displaystyle \sum_{n=0}^\infty \frac{1}{n}`
@@ -921,24 +923,34 @@
Font changes
~~~~~~~~~~~~
-Math alphabet macros change the default alphabet ("mathvariant" in
-MathML), leaving some symbols unchanged:
+`Math alphabet`_ macros change the default alphabet, leaving some symbols
+unchanged. In MathML core, the corresponding *Mathematical Alphanumeric
+Symbols* should be used.
-:normal: `abs(x) \pm \alpha \approx 3 \Gamma \quad \forall x \in R`
-:mathrm: `\mathrm{abs(x) \pm \alpha \approx 3 \Gamma \quad \forall x \in R}`
-:mathit: `\mathit{abs(x) \pm \alpha \approx 3 \Gamma \quad \forall x \in R}`
-:mathsf: `\mathsf{abs(x) \pm \alpha \approx 3 \Gamma \quad \forall x \in R}`
-:mathbb: `\mathbb{abs(x) \pm \alpha \approx 3 \Gamma \quad \forall x \in R}`
-:mathbf: `\mathbf{abs(x) \pm \alpha \approx 3 \Gamma \quad \forall x \in R}`
-:mathcal: `\mathcal{abs(x) \pm \alpha \approx 3 \Gamma \quad \forall x \in R}`
-:mathscr: `\mathscr{abs(x) \pm \alpha \approx 3 \Gamma \quad \forall x \in R}`
+:default: `V_R x \pm \cos(\alpha) \approx 3 \Gamma \quad \forall x \in \mathbb{R}`
+:mathbb: `\mathbb{V_R x \pm \cos(\alpha) \approx 3 \Gamma \quad \forall x \in \mathbb{R}}`
+:mathbf: `\mathbf{V_R x \pm \cos(\alpha) \approx 3 \Gamma \quad \forall x \in \mathbb{R}}`
+:mathbfit: `\mathbfit{V_R x \pm \cos(\alpha) \approx 3 \Gamma \quad \forall x \in \mathbb{R}}`
+:mathcal: `\mathcal{V_R x \pm \cos(\alpha) \approx 3 \Gamma \quad \forall x \in \mathbb{R}}`
+:mathit: `\mathit{V_R x \pm \cos(\alpha) \approx 3 \Gamma \quad \forall x \in \mathbb{R}}`
+:mathrm: `\mathrm{V_R x \pm \cos(\alpha) \approx 3 \Gamma \quad \forall x \in \mathbb{R}}`
+:mathscr: `\mathscr{V_R x \pm \cos(\alpha) \approx 3 \Gamma \quad \forall x \in \mathbb{R}}`
+:mathsf: `\mathsf{V_R x \pm \cos(\alpha) \approx 3 \Gamma \quad \forall x \in \mathbb{R}}`
+:mathsfbfit: `\mathsfbfit{V_R x \pm \cos(\alpha) \approx 3 \Gamma \quad \forall x \in \mathbb{R}}`
+:mathsfit: `\mathsfit{V_R x \pm \cos(\alpha) \approx 3 \Gamma \quad \forall x \in \mathbb{R}}`
+:mathtt: `\mathtt{V_R x \pm \cos(\alpha) \approx 3 \Gamma \quad \forall x \in \mathbb{R}}`
+LaTeX accepts complex functions inside the math alphabet functions:
+
+:mathrm: `\mathrm{\frac{x}{y}}`
+
+
Without additional packages, LaTeX supports "blackboard-bold" only for
capital Latin letters.
Unicode supports also small Latin letters, some Greek letters, and digits:
`\mathbb{A \ldots Z a \ldots z}
\mathbb\Gamma \mathbb{\Pi} \mathbb {\Sigma} \mathbb\gamma \mathbb \pi
-\mathbb{0 \ldots 9}`.
+\mathbb{0 \ldots 9}` but no italic numbers.
Inferred <mrow>s in MathML
Modified: trunk/docutils/docutils/utils/math/latex2mathml.py
===================================================================
--- trunk/docutils/docutils/utils/math/latex2mathml.py 2024-01-13 11:10:47 UTC (rev 9513)
+++ trunk/docutils/docutils/utils/math/latex2mathml.py 2024-01-15 16:10:42 UTC (rev 9514)
@@ -109,7 +109,6 @@
# operator, fence, or separator -> <mo>
-
stretchables = {
# extensible delimiters allowed in left/right cmds
'backslash': '\\',
@@ -221,25 +220,25 @@
'negthickspace': '-0.2778em', # -5mu = -5/18em
}
-# accents -> <mover stretchy="false">
+# accents: -> <mo stretchy="false"> in <mover>
accents = {
- # TeX: (spacing, combining)
- 'acute': ('´', '\u0301'),
- 'bar': ('ˉ', '\u0304'),
- 'breve': ('˘', '\u0306'),
- 'check': ('ˇ', '\u030C'),
- 'dot': ('˙', '\u0307'),
- 'ddot': ('¨', '\u0308'),
- 'dddot': ('⋯', '\u20DB'),
- 'grave': ('`', '\u0300'),
- 'hat': ('ˆ', '\u0302'),
- 'mathring': ('˚', '\u030A'),
- 'tilde': ('˜', '\u0303'), # tilde ~ or small tilde ˜?
- 'vec': ('→', '\u20d7'), # → too heavy, accents="false"
- # TODO: ddddot
+ # TeX: spacing combining
+ 'acute': '´', # '\u0301'
+ 'bar': 'ˉ', # '\u0304'
+ 'breve': '˘', # '\u0306'
+ 'check': 'ˇ', # '\u030C'
+ 'dot': '˙', # '\u0307'
+ 'ddot': '¨', # '\u0308'
+ 'dddot': '˙˙˙', # '\u20DB' # or … ?
+ 'ddddot': '˙˙˙˙', # '\u20DC' # or ¨¨ ?
+ 'grave': '`', # '\u0300'
+ 'hat': 'ˆ', # '\u0302'
+ 'mathring': '˚', # '\u030A'
+ 'tilde': '~', # '\u0303' # tilde ~ or small tilde ˜?
+ 'vec': '→', # '\u20d7' # → too heavy, use scriptlevel="+1"
}
-# limits etc. -> <mover> or <munder>
+# limits etc. -> <mo> in <mover> or <munder>
over = {
# TeX: (char, offset-correction/em)
'overbrace': ('\u23DE', -0.2), # DejaVu Math -0.6
@@ -340,16 +339,11 @@
ord('&'): '&',
0x2061: '⁡',
}
- _boolstrings = {True: 'true', False: 'false'}
- """String representation of boolean MathML attribute values."""
- html_tagname = 'span'
- """Tag name for HTML representation."""
-
def __init__(self, *children, **attributes):
"""Set up node with `children` and `attributes`.
- Attributes are downcased: Use CLASS to set "class" value.
+ Attributes are downcased to allow using CLASS to set "class" value.
>>> math(mn(3), CLASS='test')
math(mn(3), class='test')
>>> math(CLASS='test').toprettyxml()
@@ -357,8 +351,7 @@
"""
self.children = []
- self.extend(children)
-
+ self += children
self.attributes = {}
for key in attributes.keys():
# Use .lower() to allow argument `CLASS` for attribute `class`
@@ -366,14 +359,13 @@
self.attributes[key.lower()] = attributes[key]
def __repr__(self):
- content = [repr(item) for item in getattr(self, 'children', [])]
+ content = [repr(item) for item in self.children]
if hasattr(self, 'data'):
content.append(repr(self.data))
- if isinstance(self, MathSchema) and self.switch:
+ if getattr(self, 'switch', None):
content.append('switch=True')
content += ["%s=%r"%(k, v) for k, v in self.attributes.items()
if v is not None]
-
return self.__class__.__name__ + '(%s)' % ', '.join(content)
def __len__(self):
@@ -392,8 +384,7 @@
def full(self):
"""Return boolean indicating whether children may be appended."""
- return (self.nchildren is not None
- and len(self) >= self.nchildren)
+ return self.nchildren is not None and len(self) >= self.nchildren
def append(self, child):
"""Append child and return self or first non-full parent.
@@ -414,6 +405,8 @@
self.append(child)
return self
+ __iadd__ = extend # alias for ``+=`` operator
+
def close(self):
"""Close element and return first non-full parent or None."""
parent = self.parent
@@ -421,21 +414,29 @@
parent = parent.parent
return parent
+ # Conversion to (pretty) XML string
def toprettyxml(self):
"""Return XML representation of self as string."""
return ''.join(self._xml())
def _xml(self, level=0):
- return ([self.xml_starttag()]
- + self._xml_body(level)
- + ['</%s>' % self.__class__.__name__])
+ if self.nchildren is not None and len(self) < self.nchildren:
+ raise MathError(f'Node {self.xml_starttag()} misses children.'
+ ' Incomplete source?')
+ return [self.xml_starttag(),
+ *self._xml_body(level),
+ '</%s>' % self.__class__.__name__]
def xml_starttag(self):
- attrs = ('%s="%s"' % (k, str(v).replace('True', 'true').replace('False', 'false'))
- for k, v in self.attributes.items()
- if v is not None)
+ attrs = (f'{k}="{self.a_str(v)}"'
+ for k, v in self.attributes.items() if v is not None)
return '<%s>' % ' '.join((self.__class__.__name__, *attrs))
+ @staticmethod
+ def a_str(v):
+ # Return string representation for attribute value `v`.
+ return str(v).replace('True', 'true').replace('False', 'false')
+
def _xml_body(self, level=0):
xml = []
for child in self.children:
@@ -444,6 +445,7 @@
xml.extend(['\n', ' ' * level])
return xml
+ # display mode
def is_block(self):
"""Return true, if `self` or a parent has ``display='block'``."""
try:
@@ -461,6 +463,9 @@
# '<math>\n <mn>2</mn>\n</math>'
# >>> len(n2)
# 1
+# >>> n2 += [mo('!')]
+# >>> n2
+# math(mn(2), mo('!'))
# >>> eq3 = math(id='eq3', display='block')
# >>> eq3
# math(id='eq3', display='block')
@@ -957,8 +962,8 @@
if name in ordinary:
# <mi mathvariant="normal"> well supported by Chromium but
- # Firefox 115.5.0 puts additional space after the symbol, e.g.
- # <mi mathvariant="normal">∂</mi><mi>t</mi> looks like <mo>∂</mo>…
+ # Firefox 115.5.0 puts additional space around the symbol, e.g.
+ # <mi mathvariant="normal">∂</mi><mi>t</mi> looks like ∂ t, not ∂t
# return node.append(mi(ordinary[name], mathvariant='normal')), string
return node.append(mi(ordinary[name])), string
@@ -1174,10 +1179,12 @@
return entry, string
if name in accents:
- new_node = mover(mo(accents[name][0], stretchy=False), switch=True)
+ accent_node = mo(accents[name], stretchy=False)
+ # mi() would be simpler, but semantically wrong
+ # --- https://w3c.github.io/mathml-core/#operator-fence-separator-or-accent-mo
if name == 'vec':
- new_node.children[0]['accent'] = False # scale down arrow but drop i-dot
- new_node.tex_cmd = name # for HTML export
+ accent_node['scriptlevel'] = '+1' # scale down arrow
+ new_node = mover(accent_node, accent=True, switch=True)
node.append(new_node)
return new_node, string
@@ -1186,7 +1193,6 @@
# but to True on accent node get "textstyle" (full size) symbols on top
new_node = mover(mo(over[name][0], accent=True),
switch=True, accent=False)
- new_node.tex_cmd = name # for HTML export
node.append(new_node)
return new_node, string
@@ -1197,7 +1203,6 @@
if name in under:
new_node = munder(mo(under[name][0]), switch=True)
- new_node.tex_cmd = name # for HTML export
node.append(new_node)
return new_node, string
@@ -1280,7 +1285,7 @@
# >>> handle_cmd('overline', math(), '{981}')
# (mover(mo('_', accent=True), switch=True, accent=False), '{981}')
# >>> handle_cmd('bar', math(), '{x}')
-# (mover(mo('ˉ', stretchy=False), switch=True), '{x}')
+# (mover(mo('ˉ', stretchy=False), switch=True, accent=True), '{x}')
# >>> handle_cmd('xleftarrow', math(), r'[\alpha]{10}')
# (munderover(mo('⟵'), mi('α')), '{10}')
# >>> handle_cmd('xleftarrow', math(), r'[\alpha=5]{10}')
@@ -1387,10 +1392,13 @@
# Return dictionary with attributes to style an <mtable> as align environment:
-# TODO: "columnalign" disregarded by Chromium and webkit
+# TODO: "columnalign" disregarded by Chromium and webkit.
+# Use style="text-align: (right|left|center)" in the <mtd> elements
+# or a (complex) CSS rule for "mtable.align"
def align_attributes(rows):
atts = {'class': 'align',
'displaystyle': True}
+ # get maximal number of (non-escaped) "next column" markup instances:
tabs = max(row.count('&') - row.count(r'\&') for row in rows)
if tabs:
aligns = ['right', 'left'] * tabs
@@ -1407,6 +1415,10 @@
# {'class': 'align', 'displaystyle': True, 'columnalign': 'right left right', 'columnspacing': '0 2em'}
# >>> align_attributes(['a &= b & c &= d'])
# {'class': 'align', 'displaystyle': True, 'columnalign': 'right left right left', 'columnspacing': '0 2em 0'}
+# >>> align_attributes([r'a &= b & c &= d \& e'])
+# {'class': 'align', 'displaystyle': True, 'columnalign': 'right left right left', 'columnspacing': '0 2em 0'}
+# >>> align_attributes([r'a &= b & c &= d & e'])
+# {'class': 'align', 'displaystyle': True, 'columnalign': 'right left right left right', 'columnspacing': '0 2em 0 2em'}
def tex2mathml(tex_math, as_block=False):
@@ -1421,7 +1433,7 @@
math_tree['display'] = 'block'
rows = toplevel_code(tex_math).split(r'\\')
if len(rows) > 1:
- # emulate align* environment with a math table
+ # emulate "align*" environment with a math table
node = mtd()
math_tree.append(mtable(mtr(node),
**align_attributes(rows)))
@@ -1474,10 +1486,6 @@
# </math>
-# TODO: raise error if <sqrt> doesnot have a base character (missing children)
-# >> '\sqrt[3]'
-# Maybe also other nodes...
-
# TODO: look up more symbols from tr25, e.g.
#
#
Modified: trunk/docutils/test/functional/expected/math_output_mathml.html
===================================================================
--- trunk/docutils/test/functional/expected/math_output_mathml.html 2024-01-13 11:10:47 UTC (rev 9513)
+++ trunk/docutils/test/functional/expected/math_output_mathml.html 2024-01-15 16:10:42 UTC (rev 9514)
@@ -195,7 +195,7 @@
</mfrac>
<mi class="capital-greek">Ψ</mi>
<mo>=</mo>
- <mover>
+ <mover accent="true">
<mi>H</mi>
<mo stretchy="false">ˆ</mo>
</mover>
@@ -212,19 +212,19 @@
<dd><table class="borderless" style="width: 100%;">
<tbody>
<tr><td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
- <mover>
+ <mover accent="true">
<mi>a</mi>
<mo stretchy="false">´</mo>
</mover>
</math> <span class="docutils literal">\acute{a}</span></p></td>
<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
- <mover>
+ <mover accent="true">
<mi>t</mi>
<mo stretchy="false">˙</mo>
</mover>
</math> <span class="docutils literal">\dot{t}</span></p></td>
<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
- <mover>
+ <mover accent="true">
<mi>γ</mi>
<mo stretchy="false">ˆ</mo>
</mover>
@@ -231,59 +231,59 @@
</math> <span class="docutils literal"><span class="pre">\hat{\gamma}</span></span></p></td>
</tr>
<tr><td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
- <mover>
+ <mover accent="true">
<mi>a</mi>
<mo stretchy="false">`</mo>
</mover>
</math> <span class="docutils literal">\grave{a}</span></p></td>
<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
- <mover>
+ <mover accent="true">
<mi>t</mi>
<mo stretchy="false">¨</mo>
</mover>
</math> <span class="docutils literal">\ddot{t}</span></p></td>
<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
- <mover>
+ <mover accent="true">
<mi>α</mi>
- <mo stretchy="false">˜</mo>
+ <mo stretchy="false">~</mo>
</mover>
</math> <span class="docutils literal"><span class="pre">\tilde{\alpha}</span></span></p></td>
</tr>
<tr><td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
- <mover>
+ <mover accent="true">
<mi>x</mi>
<mo stretchy="false">˘</mo>
</mover>
</math> <span class="docutils literal">\breve{x}</span></p></td>
<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
- <mover>
+ <mover accent="true">
<mi>t</mi>
- <mo stretchy="false">⋯</mo>
+ <mo stretchy="false">˙˙˙</mo>
</mover>
</math> <span class="docutils literal">\dddot{t}</span></p></td>
<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
- <mover>
+ <mover accent="true">
<mi>ı</mi>
- <mo stretchy="false" accent="false">→</mo>
+ <mo stretchy="false" scriptlevel="+1">→</mo>
</mover>
</math> <span class="docutils literal"><span class="pre">\vec{\imath}</span></span></p></td>
</tr>
<tr><td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
- <mover>
+ <mover accent="true">
<mi>a</mi>
<mo stretchy="false">ˇ</mo>
</mover>
</math> <span class="docutils literal">\check{a}</span></p></td>
<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
- <mover>
+ <mover accent="true">
<mi>a</mi>
<mo stretchy="false">ˉ</mo>
</mover>
</math> <span class="docutils literal">\bar{a}</span></p></td>
<td><p><math xmlns="http://www.w3.org/1998/Math/MathML">
- <mover>
+ <mover accent="true">
<mi>R</mi>
- <mo stretchy="false" accent="false">→</mo>
+ <mo stretchy="false" scriptlevel="+1">→</mo>
</mover>
</math> <span class="docutils literal">\vec{R}</span></p></td>
</tr>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
