summaryrefslogtreecommitdiff
path: root/docutils/docs/user
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2021-05-20 12:24:25 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2021-05-20 12:24:25 +0000
commitaf6316e2d7434859e29be974763fc1576314181a (patch)
tree5e17d0f7aaec9fc6b48f684408eed1824ee8b58f /docutils/docs/user
parent2ce6f950474eaf8cd3b6aa14c3415f4c0571e423 (diff)
downloaddocutils-af6316e2d7434859e29be974763fc1576314181a.tar.gz
MathML fix multi-digit number literals. Support optional arg for \sqrt.
Place consecutive digits and comma/dot in a common <mn> element. Support the optinal argument to specify a degree of a radical. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8754 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/user')
-rw-r--r--docutils/docs/user/mathematics.txt49
1 files changed, 21 insertions, 28 deletions
diff --git a/docutils/docs/user/mathematics.txt b/docutils/docs/user/mathematics.txt
index 4292f28bb..12a4baabe 100644
--- a/docutils/docs/user/mathematics.txt
+++ b/docutils/docs/user/mathematics.txt
@@ -180,18 +180,15 @@ Extensible delimiters
---------------------
Unless you indicate otherwise, delimiters in math formulas remain at the
standard size regardless of the height of the enclosed material. To get
-adaptable sizes, use ``\left`` and ``\right`` prefixes.
+adaptable sizes, use ``\left`` and ``\right`` prefixes, for example
+`g(A,B,Y) = f \left(A,B,X=h^{[X]}(Y)\right)` or
-.. math::
-
- g(A,B,Y) = f \left(A,B,X=h^{[X]}(Y)\right)
+.. math:: a_n = \left(\frac{1}{2}\right)^n
Use ``.`` for "empty" delimiters:
-.. math::
+.. math:: A = \left . \frac{1}{1-n}\, \right |_{n=0}^\infty
- A = \left . \frac{1}{1-n}\, \right |_{n=0}^\infty
-
The following symbols extend when used with ``\left`` and ``\right``:
Pairing delimiters
@@ -225,10 +222,9 @@ Nonpairing delimiters
The use of ``|`` and ``\|`` for pairs of vertical bars may produce
incorrect spacing, e.g., ``|k|=|-k|`` produces `|k| = |−k|` and
-``|\sin(x)|`` produces `|\sin(x)|`. The pairing delimiters, e.g.
-`\lvert -k\rvert`
-and `\lvert\sin(x)\rvert`, prevent this problem (in LaTeX and
-MathJax).
+``|\sin(x)|`` produces `|\sin(x)|`. The pairing delimiters, e.g.
+`\lvert -k\rvert` and `\lvert\sin(x)\rvert`, prevent this problem
+(in LaTeX and MathJax).
Vertical Arrows
~~~~~~~~~~~~~~~
@@ -437,12 +433,12 @@ Arrows
`\nleftarrow` ``\nleftarrow`` `\nrightarrow` ``\nrightarrow``
`\nLeftarrow` ``\nLeftarrow`` `\nRightarrow` ``\nRightarrow``
`\nleftrightarrow` ``\nleftrightarrow`` `\nLeftrightarrow` ``\nLeftrightarrow``
- `\nwarrow` ``\nwarrow`` `\nearrow` ``\nearrow``
- `\swarrow` ``\swarrow`` `\searrow` ``\searrow``
+ `\nwarrow` ``\nwarrow`` `\nearrow` ``\nearrow``
+ `\swarrow` ``\swarrow`` `\searrow` ``\searrow``
`\twoheadleftarrow` ``\twoheadleftarrow`` `\twoheadrightarrow` ``\twoheadrightarrow``
`\upharpoonleft` ``\upharpoonleft`` `\upharpoonright` ``\upharpoonright``
`\downharpoonleft` ``\downharpoonleft`` `\downharpoonright` ``\downharpoonright``
- `\upuparrows` ``\upuparrows`` `\downdownarrows` ``\downdownarrows``
+ `\upuparrows` ``\upuparrows`` `\downdownarrows` ``\downdownarrows``
====================== ======================== ===================== =======================
@@ -561,7 +557,7 @@ take one optional argument (the subscript) and one mandatory argument
A \xleftarrow{n+\mu-1} B \xrightarrow[T]{n\pm i-1} C
-results in
+results in
.. math:: A \xleftarrow{n+\mu-1} B \xrightarrow[T]{n\pm i-1} C
@@ -624,13 +620,13 @@ Roots and Fractions
.. class:: colwidths-auto
- ===================== ============================== ============================
- command example result
- ===================== ============================== ============================
- ``\sqrt`` ``\sqrt{x^2-1}`` `\sqrt{x^2-1}`
- ``\frac`` ``\frac{1}{2}`` `\frac{1}{2}`
- ``\left``, ``\right`` ``\left(\frac{1}{2}\right)^n`` `\left(\frac{1}{2}\right)^n`
- ===================== ============================== ============================
+ ========= ==================== ==================
+ command example result
+ ========= ==================== ==================
+ ``\sqrt`` ``\sqrt{x^2-1}`` `\sqrt{x^2-1}`
+ .. ``\sqrt[3n]{x^2-1}`` `\sqrt[3n]{x^2-1}`
+ ``\frac`` ``\frac{1}{1-x}`` `\frac{1}{1-x}`
+ ========= ==================== ==================
Text
====
@@ -648,8 +644,6 @@ Whitespace is kept inside the argument:
Currently, math in text is not supported by LaTeX2MathML.
-
-
ToDo
====
@@ -657,10 +651,9 @@ internal LaTeX2MathML
* Math inside text: ``n - 1 \text{if $n$ is odd}``.
* Remove circular refs.
-* Decimal numbers.
-* Implement ``\circledS``? (in short-math-guide.pdf but not in
- the Unicode `Mathematical Character Repertoire`__)
-* ``\DeclareMathOperator``
+* Implement ``\circledS``? Ⓢ (and other characters
+ in the short-math-guide.pdf but not in the
+ Unicode `Mathematical Character Repertoire`__)
__ http://www.unicode.org/reports/tr25/