diff options
| author | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2012-02-27 11:15:38 +0000 |
|---|---|---|
| committer | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2012-02-27 11:15:38 +0000 |
| commit | 8a9a719f67d9ce38f3c3a6cf91b0716188260398 (patch) | |
| tree | 91de9b28983ae30f9a7ad6d2a1c441ef77fa169a /docutils/docs/dev/todo.txt | |
| parent | 6b6e8c5eff40d64a7595cf84cb48f4114b95c4de (diff) | |
| download | docutils-8a9a719f67d9ce38f3c3a6cf91b0716188260398.tar.gz | |
Update TODO list
math input formats (todo),
move inline markup recognition alternatives to "alternatives".
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@7372 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/dev/todo.txt')
| -rw-r--r-- | docutils/docs/dev/todo.txt | 103 |
1 files changed, 59 insertions, 44 deletions
diff --git a/docutils/docs/dev/todo.txt b/docutils/docs/dev/todo.txt index 9a918e52d..6292a4627 100644 --- a/docutils/docs/dev/todo.txt +++ b/docutils/docs/dev/todo.txt @@ -1123,70 +1123,85 @@ Misc * Generalize docinfo contents (bibliographic fields): remove specific fields, and have only a single generic "field"? -Inline markup recognition rules -------------------------------- +Math Markup +----------- -The `inline markup`_ recognition rules were devised intentionally to allow -90% of non-markup uses of "*", "`", "_", and "|" *without* resorting to -backslashes. For 9% of the remaining 10%, use inline literals or literal -blocks. Only those who understand the escaping and inline markup rules -should attempt the remaining 1%. ;-) +Since Docutils 0.8, a "math" role and directive using LaTeX math +syntax as input format is part of reStructuredText. -.. _inline markup: ../ref/rst/restructuredtext.html#inline-markup +Open issues: -Changes need to be done in `parsers.rst.states.Inliner`. +* Use a "Transform" for math format conversions as extensively discussed in + the "math directive issues" thread in May 2008 + (http://osdir.com/ml/text.docutils.devel/2008-05/threads.html)? -Alternatives +* Generic "math-output" option (currently specific to HTML). + (List of math-output preferences?) -a) Use `Unicode categories`_ for all chars (ASCII or not) +* Try to be compatible with `Math support in Sphinx`_? - +1 comprehensible, standards based, - -1 many "false positives" need escaping, - -1 not backwards compatible. + * The ``:label:`` option selects a label for the equation, by which it + can be cross-referenced, and causes an equation number to be issued. + In Docutils, the option ``:name:`` sets the label. + Equation numbering is not implemented yet. -b) full backwards compatibility + * Option ``:nowrap:`` prevents wrapping of the given math in a + math environment (you have to specify the math environment in the + content). - :Pi: only before start-string - :Pf: only behind end-string - :Po: "conservative" sorting of other punctuation: +.. _Math support in Sphinx: http://sphinx.pocoo.org/ext/math.html - :``.,;!?\\``: Close - :``¡¿``: Open +* Equation numbering and references. (Should be handled in a unified way + with other numbered entities like formal tables and images.) - +1 backwards compatible, - +1 logical extension of the existing rules, - -1 exception list for "other" punctuation needed, - -1 rules even more complicated, - -1 not clear how to sort "other" punctuation that is currently not - recognized, - -2 international quoting convention like - »German ›angular‹ quotes« not recognized. +alternative input formats +````````````````````````` -.. _Unicode categories: - http://www.unicode.org/Public/5.1.0/ucd/UCD.html#General_Category_Values +Use a directive option to specify an alternative input format, e.g. (but not +limited to): +MathML_ + Not for hand-written code but maybe usefull when pasted in (or included + from a file) -Math Markup ------------ + For an overview of MathML implementations and tests, see, e.g., + the `mathweb wiki`_ or the `ConTeXT MathML page`_. -Since Docutils 0.8, a "math" role and directive using LaTeX math -syntax as input format is part of reStructuredText. + .. _MathML: http://www.w3.org/TR/MathML2/ + .. _mathweb wiki: http://www.mathweb.org/wiki/MathML + .. _ConTeXT MathML page: http://wiki.contextgarden.net/MathML -Provide for `alternative input formats`__? -__ ./rst/alternatives.html#math-markup +ASCIIMath_ + Simple, ASCII based math input language (see also `ASCIIMath tutorial`_). -Try to be compatible with `Math support in Sphinx`_? + * The Python module ASCIIMathML_ translates a string with ASCIIMath into a + MathML tree. Used, e.g., by MultiMarkdown__. -* The ``:label:`` option selects a label for the equation, by which it - can be cross-referenced, and causes an equation number to be issued. - In Docutils, this would be called ``:name:``. + * For conversion to LaTeX, there is a JavaScript script at + http://dlippman.imathas.com/asciimathtex/ASCIIMath2TeX.js -* Option ``:nowrap:`` prevents wrapping of the given math in a - math environment (you have to specify the math environment in the - content). + .. _ASCIIMath: http://www1.chapman.edu/~jipsen/mathml/asciimath.html + .. _ASCIIMath tutorial: + http://www.wjagray.co.uk/maths/ASCIIMathTutorial.html + .. _ASCIIMathML: http://pypi.python.org/pypi/asciimathml/ + __ http://fletcherpenney.net/multimarkdown/ + +`Unicode Nearly Plain Text Encoding of Mathematics`_ + format for lightly marked-up representation of mathematical + expressions in Unicode. + + (Unicode Technical Note. Sole responsibility for its contents rests + with the author(s). Publication does not imply any endorsement by + the Unicode Consortium.) + + .. _Unicode Nearly Plain Text Encoding of Mathematics: + http://www.unicode.org/notes/tn28/ + +itex + See `the culmination of a relevant discussion in 2003 + <http://article.gmane.org/gmane.text.docutils.user/118>`__. -.. _Math support in Sphinx: http://sphinx.pocoo.org/ext/math.html LaTeX output |
