diff options
Diffstat (limited to 'docutils/docs')
| -rw-r--r-- | docutils/docs/ref/doctree.txt | 19 | ||||
| -rw-r--r-- | docutils/docs/ref/docutils.dtd | 16 | ||||
| -rw-r--r-- | docutils/docs/ref/rst/directives.txt | 8 |
3 files changed, 29 insertions, 14 deletions
diff --git a/docutils/docs/ref/doctree.txt b/docutils/docs/ref/doctree.txt index 1e4d3fdad..eabbbe6c2 100644 --- a/docutils/docs/ref/doctree.txt +++ b/docutils/docs/ref/doctree.txt @@ -2907,8 +2907,8 @@ Pseudo-XML_ fragment from simple parsing:: ``math`` ======== -The ``math`` element contains text in `LaTeX math format` that is typeset -as mathematical notation (inline formula). +The ``math`` element contains text in `LaTeX math format` [#latex-math]_ +that is typeset as mathematical notation (inline formula). If the output format does not support math typesetting, the content is inserted verbatim. @@ -2920,7 +2920,7 @@ Details `Inline Elements`_ :Parents: - All elements employing the `%inline.elements;`_ parameter entities in + All elements employing the `%inline.elements;`_ parameter entities in their content models may contain ``math``. :Children: @@ -2944,14 +2944,19 @@ Content Model The ``math`` element contains the `common attributes`_ (ids_, names_, dupnames_, source_, and classes_). +.. [#latex-math] For details of the supported mathematical language, see + the `"math" directive`_ + +.. _"math" directive: rst/directives.html#math + ``math_block`` ============== The ``math_block`` element contains a block of text in `LaTeX math -format` that is typeset as mathematical notation (display formula). -The ``math_block`` element is generated during the initial parse from a -"math" directive. +format` [#latex-math]_ that is typeset as mathematical notation +(display formula). The ``math_block`` element is generated during +the initial parse from a "math" directive. If the output format does not support math typesetting, the content is inserted verbatim. @@ -2983,7 +2988,7 @@ Content Model .. parsed-literal:: - `%text.model;`_ + (#PCDATA) :Attributes: The ``math`` element contains the `common attributes`_ diff --git a/docutils/docs/ref/docutils.dtd b/docutils/docs/ref/docutils.dtd index 6ad0f24bb..1d57f1938 100644 --- a/docutils/docs/ref/docutils.dtd +++ b/docutils/docs/ref/docutils.dtd @@ -125,7 +125,7 @@ resolve to either an internal or external reference. <!ENTITY % additional.body.elements ""> <!ENTITY % body.elements " paragraph | compound | container | literal_block | doctest_block - | line_block | block_quote + | math_block | line_block | block_quote | table | figure | image | footnote | citation | rubric | bullet_list | enumerated_list | definition_list | field_list | option_list @@ -137,7 +137,7 @@ resolve to either an internal or external reference. <!ENTITY % additional.inline.elements ""> <!ENTITY % inline.elements - " emphasis | strong | literal + " emphasis | strong | literal | math | reference | footnote_reference | citation_reference | substitution_reference | title_reference | abbreviation | acronym | subscript | superscript @@ -394,6 +394,13 @@ or " ") or the text between option arguments (typically either "," or %basic.atts; %fixedspace.att;> +<!-- +`math_block` contains a block of text in "LaTeX math format" +that is typeset as mathematical notation (display formula). +--> +<!ELEMENT math_block (#PCDATA)> +<!ATTLIST math_block %basic.atts;> + <!ELEMENT line_block (line | line_block)+> <!ATTLIST line_block %basic.atts;> @@ -537,7 +544,7 @@ following caveats: - Nested inline elements may or may not be supported by individual applications using this DTD. - The inline elements <footnote_reference>, <citation_reference>, - <literal>, and <image> do not support nesting. + <literal>, <math>, and <image> do not support nesting. --> <!ELEMENT emphasis %text.model;> @@ -549,6 +556,9 @@ following caveats: <!ELEMENT literal (#PCDATA)> <!ATTLIST literal %basic.atts;> +<!ELEMENT math (#PCDATA)> +<!ATTLIST math %basic.atts;> + <!-- Can also be a body element, when it contains an "image" element. --> <!ELEMENT reference %text.model;> <!ATTLIST reference diff --git a/docutils/docs/ref/rst/directives.txt b/docutils/docs/ref/rst/directives.txt index 2b07aae44..1709a048f 100644 --- a/docutils/docs/ref/rst/directives.txt +++ b/docutils/docs/ref/rst/directives.txt @@ -531,9 +531,9 @@ Math :Doctree Element: math_block_ :Directive Arguments: One, optional: prepended to content. :Directive Options: `:class:`_, `:name:`_ -:Directive Content: Interpreted as math block(s). - Content blocks separated by a blank line are put in - separate math-block doctree elements. +:Directive Content: Becomes the body of the math block. + (Content blocks separated by a blank line are put in + adjacent math blocks.) :Configuration Setting: math_output_ (New in Docutils 0.8) @@ -558,7 +558,7 @@ support math typesetting at all, the content is inserted verbatim. (see, e.g., the `Short Math Guide`_). -For inline math, use the `"math" role`_. +For inline formulas, use the `"math" role`_. .. _Short Math Guide: ftp://ftp.ams.org/ams/doc/amsmath/short-math-guide.pdf .. _"math" role: roles.html#math |