docutils.utils.math.latex2mathml Namespace Reference

Functions
	tex_cmdname (string)
	tex_number (string)
	tex_token (string)
	tex_group (string)
	tex_token_or_group (string)
	tex_optarg (string)
	parse_latex_math (root, source)
	handle_cmd (name, node, string)
	handle_math_alphabet (name, node, string)
	handle_script_or_limit (node, c, limits='')
	begin_environment (node, string)
	end_environment (node, string)
	tex_equation_columns (rows)
	align_attributes (rows)
	tex2mathml (tex_math, as_block=False)

Variables
dict	letters = {'hbar': 'ℏ'}
	ordinary = tex2unichar.mathord
dict	greek_capitals
dict	functions
dict	modulo_functions
dict	math_alphabets
dict	stretchables
dict	operators
dict	thick_operators
dict	small_operators
tuple	movablelimits
dict	spaces
dict	accents
dict	over
dict	under
dict	anomalous_chars
dict	mathbb
dict	matrices
dict	layout_styles
dict	fractions
list	delimiter_sizes = ['', '1.2em', '1.623em', '2.047em', '2.470em']
dict	bigdelimiters

Detailed Description

Convert LaTex maths code into presentational MathML.

This module is provisional:
the API is not settled and may change with any minor Docutils version.

Function Documentation

handle_cmd()

docutils.utils.math.latex2mathml.handle_cmd	(		name,
			node,
			string
	)

Process LaTeX command `name` followed by `string`.

Append result to `node`.
If needed, parse `string` for command argument.
Return new current node and remainder of `string`:

>>> handle_cmd('hbar', math(), r' \frac')
(math(mi('ℏ')), ' \\frac')
>>> handle_cmd('hspace', math(), r'{1ex} (x)')
(math(mspace(width='1ex')), ' (x)')

handle_script_or_limit()

docutils.utils.math.latex2mathml.handle_script_or_limit	(		node,
			c,
			limits = ''
	)

Append script or limit element to `node`.

parse_latex_math()

docutils.utils.math.latex2mathml.parse_latex_math	(		root,
			source
	)

Append MathML conversion of `string` to `node` and return it.

>>> parse_latex_math(math(), r'\alpha')
math(mi('α'))
>>> parse_latex_math(mrow(), r'x_{n}')
mrow(msub(mi('x'), mi('n')))

tex2mathml()

docutils.utils.math.latex2mathml.tex2mathml	(		tex_math,
			as_block = False
	)

Return string with MathML code corresponding to `tex_math`.

Set `as_block` to ``True`` for displayed formulas.

tex_cmdname()

docutils.utils.math.latex2mathml.tex_cmdname

(

string

)

Return leading TeX command name and remainder of `string`.

>>> tex_cmdname('mymacro2') # up to first non-letter
('mymacro', '2')
>>> tex_cmdname('name 2') # strip trailing whitespace
('name', '2')
>>> tex_cmdname('_2') # single non-letter character
('_', '2')

tex_group()

docutils.utils.math.latex2mathml.tex_group

(

string

)

Return first TeX group or token and remainder of `string`.

>>> tex_group('{first group} returned without brackets')
('first group', ' returned without brackets')

tex_number()

docutils.utils.math.latex2mathml.tex_number

(

string

)

Return leading number literal and remainder of `string`.

>>> tex_number('123.4')
('123.4', '')

tex_optarg()

docutils.utils.math.latex2mathml.tex_optarg

(

string

)

Return optional argument and remainder.

>>> tex_optarg('[optional argument] returned without brackets')
('optional argument', ' returned without brackets')
>>> tex_optarg('{empty string, if there is no optional arg}')
('', '{empty string, if there is no optional arg}')

tex_token()

docutils.utils.math.latex2mathml.tex_token

(

string

)

Return first simple TeX token and remainder of `string`.

>>> tex_token('\\command{without argument}')
('\\command', '{without argument}')
>>> tex_token('or first character')
('o', 'r first character')

tex_token_or_group()

docutils.utils.math.latex2mathml.tex_token_or_group

(

string

)

Return first TeX group or token and remainder of `string`.

>>> tex_token_or_group('\\command{without argument}')
('\\command', '{without argument}')
>>> tex_token_or_group('first character')
('f', 'irst character')
>>> tex_token_or_group(' also whitespace')
(' ', 'also whitespace')
>>> tex_token_or_group('{first group} keep rest')
('first group', ' keep rest')

Variable Documentation

accents

dict docutils.utils.math.latex2mathml.accents

Initial value:

=  {
    # 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"
}

anomalous_chars

dict docutils.utils.math.latex2mathml.anomalous_chars

Initial value:

=  {'-': '\u2212',  # HYPHEN-MINUS -> MINUS SIGN
                   ':': '\u2236',  # COLON -> RATIO
                   '~': '\u00a0',  # NO-BREAK SPACE
                   }

bigdelimiters

dict docutils.utils.math.latex2mathml.bigdelimiters

Initial value:

=  {'left':  0,
                 'right': 0,
                 'bigl':  1,
                 'bigr':  1,
                 'Bigl':  2,
                 'Bigr':  2,
                 'biggl': 3,
                 'biggr': 3,
                 'Biggl': 4,
                 'Biggr': 4,
                 }

fractions

dict docutils.utils.math.latex2mathml.fractions

Initial value:

=  {
    # name:   attributes
    'frac':   {},
    'cfrac':  {'displaystyle': True,  'scriptlevel': 0,
               'class': 'cfrac'},  # in LaTeX with padding
    'dfrac':  layout_styles['displaystyle'],
    'tfrac':  layout_styles['textstyle'],
    'binom':  {'linethickness': 0},
    'dbinom': layout_styles['displaystyle'] | {'linethickness': 0},
    'tbinom': layout_styles['textstyle'] | {'linethickness': 0},
}

functions

dict docutils.utils.math.latex2mathml.functions

Initial value:

=  {
    # functions with a space in the name
    'liminf': 'lim\u202finf',
    'limsup': 'lim\u202fsup',
    'injlim': 'inj\u202flim',
    'projlim': 'proj\u202flim',
    # embellished function names (see handle_cmd() below)
    'varlimsup': 'lim',
    'varliminf': 'lim',
    'varprojlim': 'lim',
    'varinjlim': 'lim',
    # custom function name
    'operatorname': None,
}

greek_capitals

dict docutils.utils.math.latex2mathml.greek_capitals

Initial value:

=  {
    'Phi': '\u03a6', 'Xi': '\u039e', 'Sigma': '\u03a3',
    'Psi': '\u03a8', 'Delta': '\u0394', 'Theta': '\u0398',
    'Upsilon': '\u03d2', 'Pi': '\u03a0', 'Omega': '\u03a9',
    'Gamma': '\u0393', 'Lambda': '\u039b'}

layout_styles

dict docutils.utils.math.latex2mathml.layout_styles

Initial value:

=  {
    'displaystyle':      {'displaystyle': True,  'scriptlevel': 0},
    'textstyle':         {'displaystyle': False, 'scriptlevel': 0},
    'scriptstyle':       {'displaystyle': False, 'scriptlevel': 1},
    'scriptscriptstyle': {'displaystyle': False, 'scriptlevel': 2},
    }

math_alphabets

dict docutils.utils.math.latex2mathml.math_alphabets

Initial value:

=  {
    # 'cmdname':  'mathvariant value'        # package
    'mathbb':     'double-struck',           # amssymb
    'mathbf':     'bold',
    'mathbfit':   'bold-italic',             # isomath
    'mathcal':    'script',
    'mathfrak':   'fraktur',                 # amssymb
    'mathit':     'italic',
    'mathrm':     'normal',
    'mathscr':    'script',                  # mathrsfs et al
    'mathsf':     'sans-serif',
    'mathbfsfit': 'sans-serif-bold-italic',  # unicode-math
    'mathsfbfit': 'sans-serif-bold-italic',  # isomath
    'mathsfit':   'sans-serif-italic',       # isomath
    'mathtt':     'monospace',
    # unsupported: bold-fraktur
    #              bold-script
    #              bold-sans-serif
}

mathbb

dict docutils.utils.math.latex2mathml.mathbb

Initial value:

=  {'Γ': '\u213E',    # ℾ
          'Π': '\u213F',    # ℿ
          'Σ': '\u2140',    # ⅀
          'γ': '\u213D',    # ℽ
          'π': '\u213C',    # ℼ
          }

matrices

dict docutils.utils.math.latex2mathml.matrices

Initial value:

=  {
    # name:    fences
    'matrix':  ('', ''),
    'smallmatrix':  ('', ''),  # smaller, see begin_environment()!
    'pmatrix': ('(', ')'),
    'bmatrix': ('[', ']'),
    'Bmatrix': ('{', '}'),
    'vmatrix': ('|', '|'),
    'Vmatrix': ('\u2016', '\u2016'),  # ‖
    'aligned': ('', ''),
    'cases':   ('{', ''),
}

modulo_functions

dict docutils.utils.math.latex2mathml.modulo_functions

Initial value:

=  {
    # cmdname: (binary, named, parentheses, padding)
    'bmod': (True,  True,  False, '0.278em'),  # a mod n
    'pmod': (False, True,  True,  '0.444em'),  # a  (mod n)
    'mod':  (False, True,  False, '0.667em'),  # a  mod n
    'pod':  (False, False, True,  '0.444em'),  # a  (n)
    }

movablelimits

tuple docutils.utils.math.latex2mathml.movablelimits

Initial value:

=  ('bigcap', 'bigcup', 'bigodot', 'bigoplus', 'bigotimes',
                 'bigsqcup', 'biguplus', 'bigvee', 'bigwedge',
                 'coprod', 'intop', 'ointop', 'prod', 'sum',
                 'lim', 'max', 'min', 'sup', 'inf')

operators

dict docutils.utils.math.latex2mathml.operators

Initial value:

=  {
    # negated symbols without pre-composed Unicode character
    'nleqq':      '\u2266\u0338',  # ≦̸
    'ngeqq':      '\u2267\u0338',  # ≧̸
    'nleqslant':  '\u2a7d\u0338',  # ⩽̸
    'ngeqslant':  '\u2a7e\u0338',  # ⩾̸
    'ngtrless':   '\u2277\u0338',  # txfonts
    'nlessgtr':   '\u2276\u0338',  # txfonts
    'nsubseteqq': '\u2AC5\u0338',  # ⫅̸
    'nsupseteqq': '\u2AC6\u0338',  # ⫆̸
    # compatibility definitions:
    'centerdot': '\u2B1D',  # BLACK VERY SMALL SQUARE | mathbin
    'varnothing': '\u2300',  # ⌀ DIAMETER SIGN | empty set
    'varpropto': '\u221d',  # ∝ PROPORTIONAL TO | sans serif
    'triangle': '\u25B3',  # WHITE UP-POINTING TRIANGLE | mathord
    'triangledown': '\u25BD',  # WHITE DOWN-POINTING TRIANGLE | mathord
    # alias commands:
    'dotsb': '\u22ef',  # ⋯ with binary operators/relations
    'dotsc': '\u2026',  # … with commas
    'dotsi': '\u22ef',  # ⋯ with integrals
    'dotsm': '\u22ef',  # ⋯ multiplication dots
    'dotso': '\u2026',  # … other dots
    # functions with movable limits (requires <mo>)
    'lim': 'lim',
    'sup': 'sup',
    'inf': 'inf',
    'max': 'max',
    'min': 'min',
}

over

dict docutils.utils.math.latex2mathml.over

Initial value:

=  {
    # TeX:                  (char,     offset-correction/em)
    'overbrace':            ('\u23DE', -0.2),  # DejaVu Math -0.6
    'overleftarrow':        ('\u2190', -0.2),
    'overleftrightarrow':   ('\u2194', -0.2),
    'overline':             ('_',      -0.2),  # \u2012 does not stretch
    'overrightarrow':       ('\u2192', -0.2),
    'widehat':              ('^',      -0.5),
    'widetilde':            ('~',      -0.3),
}

small_operators

dict docutils.utils.math.latex2mathml.small_operators

Initial value:

=  {
    # mathsize='75%'
    'shortmid':       '\u2223',  # ∣
    'shortparallel':  '\u2225',  # ∥
    'nshortmid':      '\u2224',  # ∤
    'nshortparallel': '\u2226',  # ∦
    'smallfrown':     '\u2322',  # ⌢ FROWN
    'smallsmile':     '\u2323',  # ⌣ SMILE
    'smallint':       '\u222b',  # ∫ INTEGRAL
}

spaces

dict docutils.utils.math.latex2mathml.spaces

Initial value:

=  {'qquad':         '2em',        # two \quad
          'quad':          '1em',        # 18 mu
          'thickspace':    '0.2778em',   # 5mu = 5/18em
          ';':             '0.2778em',   # 5mu thickspace
          ' ':             '0.25em',     # inter word space
          '\n':            '0.25em',     # inter word space
          'medspace':      '0.2222em',   # 4mu = 2/9em
          ':':             '0.2222em',   # 4mu medspace
          'thinspace':     '0.1667em',   # 3mu = 1/6em
          ',':             '0.1667em',   # 3mu thinspace
          'negthinspace':  '-0.1667em',  # -3mu = -1/6em
          '!':             '-0.1667em',  # negthinspace
          'negmedspace':   '-0.2222em',  # -4mu = -2/9em
          'negthickspace': '-0.2778em',  # -5mu = -5/18em
          }

stretchables

dict docutils.utils.math.latex2mathml.stretchables

Initial value:

=  {
    # extensible delimiters allowed in left/right cmds
    'backslash':   '\\',
    'uparrow':     '\u2191',  # ↑ UPWARDS ARROW
    'downarrow':   '\u2193',  # ↓ DOWNWARDS ARROW
    'updownarrow': '\u2195',  # ↕ UP DOWN ARROW
    'Uparrow':     '\u21d1',  # ⇑ UPWARDS DOUBLE ARROW
    'Downarrow':   '\u21d3',  # ⇓ DOWNWARDS DOUBLE ARROW
    'Updownarrow': '\u21d5',  # ⇕ UP DOWN DOUBLE ARROW
    'lmoustache':  '\u23b0',  # ⎰ … CURLY BRACKET SECTION
    'rmoustache':  '\u23b1',  # ⎱ … LEFT CURLY BRACKET SECTION
    'arrowvert':   '\u23d0',  # ⏐ VERTICAL LINE EXTENSION
    'bracevert':   '\u23aa',  # ⎪ CURLY BRACKET EXTENSION
    'lvert':      '|',        # left  |
    'lVert':      '\u2016',   # left  ‖
    'rvert':      '|',        # right |
    'rVert':      '\u2016',   # right ‖
    'Arrowvert':  '\u2016',   # ‖
}

thick_operators

dict docutils.utils.math.latex2mathml.thick_operators

Initial value:

=  {
    # style='font-weight: bold;'
    'thicksim':       '\u223C',  # ∼
    'thickapprox':    '\u2248',  # ≈
}

under

dict docutils.utils.math.latex2mathml.under

Initial value:

=  {'underbrace':          ('\u23DF',  0.1),  # DejaVu Math -0.7
         'underleftarrow':      ('\u2190', -0.2),
         'underleftrightarrow': ('\u2194', -0.2),
         'underline':           ('_',      -0.8),
         'underrightarrow':     ('\u2192', -0.2),
         }