summaryrefslogtreecommitdiff
path: root/docutils/docs/dev/todo.txt
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2010-10-29 22:18:44 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2010-10-29 22:18:44 +0000
commit0b99c776ef69cacc51424b71e3f8a4b183ab8907 (patch)
treefa8e87131ac724b97af063970fc2250c5b0241de /docutils/docs/dev/todo.txt
parentd402706920752e0a9b55a0d322374a823d3f2d14 (diff)
downloaddocutils-0b99c776ef69cacc51424b71e3f8a4b183ab8907.tar.gz
Rename the ``.. math-block::`` directive to ``.. math::``.
Simplify the rst-syntax using just one name for math directive and role. This is also how it is done by Sphinx. The doctree node is still called math-block (analogous to literal-block, line-block, ...). git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@6460 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/dev/todo.txt')
-rw-r--r--docutils/docs/dev/todo.txt48
1 files changed, 33 insertions, 15 deletions
diff --git a/docutils/docs/dev/todo.txt b/docutils/docs/dev/todo.txt
index 1ae9eca3c..d470124a9 100644
--- a/docutils/docs/dev/todo.txt
+++ b/docutils/docs/dev/todo.txt
@@ -1172,7 +1172,7 @@ LaTeX math syntax
* intended for input by a human, widely used, and well documented
(see, e.g., the `Short Math Guide`__)
- __ ftp://ftp.ams.org/pub/tex/doc/amsmath/short-math-guide.pdf)
+ __ http://tex.loria.fr/general/downes-short-math-guide.pdf
* convertible to all supported output formats (building on
existing extensions like `latex_math`_ (LaTeX2MathML) or the `math
@@ -1184,6 +1184,25 @@ LaTeX math syntax
* Used for input and storage by the `Math support in Sphinx`_.
+Which equation environments should be supported?
+
+Inline
+ the usual dollar signs ``$ $``.
+
+Display
+ * one line:
+
+ + numbered: "equation"
+ + unnumbered: "equation*" or ``\[ \]``?
+
+ * multiline (test for ``\\``)
+
+ + numbered: "align" (number every line) or "split" in "equation"
+ (number one line)?
+ + unnumbered: "align*"
+
+See http://www.math.uiuc.edu/~hildebr/tex/displays.html.
+
ASCIIMathML_
Used, e.g., by MultiMarkdown__
@@ -1203,26 +1222,25 @@ See `the culmination of a relevant discussion
Try to keep it compatible with `Math support in Sphinx`_:
-* Just one name for role and directive: ("math-block" -> "math").
- How about an alias in ``docutils/parsers/rst/languages/en.py``?
-
* When the math is only one line of text, it can also be given as a
directive argument.
-
- .. caution::
-
+
+ .. caution::
+
Clashs with possible use of the directive argument for type of
- equation (``align``, ``equation``, ``equation*``, ...)
+ equation (``align``, ``equation``, ``equation*``, ...) or input
+ format (``LaTeX``, ``MathML``, ``linear math``, ...).
-* support multiple equations, which should be separated by a blank
+* Supports multiple equations, which should be separated by a blank
line.
* The ``:label:`` option selects a label for the equation, by which it
can be cross-referenced, and causes an equation number to be issued.
-* Option ``:nowrap:`` prevents any wrapping of the given math in a
- math environment
+* Option ``:nowrap:`` prevents wrapping of the given math in a
+ math environment (you have to specify the math environment in the
+ content).
Options for HTML output
```````````````````````
@@ -1273,16 +1291,16 @@ images
OpenOffice output
`````````````````
-* MathML_ can be imported by the Math module.
+* MathML_ can be imported by the Math module.
However, putting MathML into an ODP file seems tricky:
http://idippedut.dk/post/2008/01/25/Do-your-math-ODF-and-MathML.aspx
http://idippedut.dk/post/2008/03/03/Now-I-get-it-ODF-and-MathML.aspx
-
-
+
+
* OOoLaTeX__: "a set of macros designed to bring the power of LaTeX
- into OpenOffice."
+ into OpenOffice."
__ http://ooolatex.sourceforge.net/