## File: asciimath.rst

package info (click to toggle)
mathjax-docs 2.7+20161014-1
 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125 .. _AsciiMath-support: ************************* MathJax AsciiMath Support ************************* The support for :term:AsciiMath in MathJax consists of two parts: the asciimath2jax preprocessor, and the AsciiMath input processor. The first of these looks for mathematics within your web page (indicated by delimiters like ...) and marks the mathematics for later processing by MathJax. The AsciiMath input processor is what converts the AsciiMath notation into MathJax's internal format, where one of MathJax's output processors then displays it in the web page. The AsciiMath input jax actually includes a copy of ASCIIMathML.js itself (see the AsciiMath home page _ for details). This means that the results of MathJax's AsciiMath processing should be the same as using the actual ASCIIMathML.js package (at least as far as the MathML that it generates is concerned). Thanks go to David Lippman for writing the initial version of the AsciiMath preprocessor and input jax and for the ongoing improvements from the AsciiMath community. The asciimath2jax preprocessor can be configured to look for whatever markers you want to use for your math delimiters. See the :ref:asciimath2jax configuration options  section for details on how to customize the action of asciimath2jax. The AsciiMath input processor handles conversion of your mathematical notation into MathJax's internal format (which is essentially MathML). The AsciiMath input processor has few configuration options (see the :ref:AsciiMath options  section for details). The AsciiMath input jax handles only the original ASCIIMathML notation (from ASCIIMathML v1.4.7), not the extened LaTeXMathML notation added in version 2.0 of ASCIIMathML, though the AsciiMath input jax does expose the tables that define the symbols that AsciiMath processes, and so it would be possible to extend them to include additional symbols. In general, it is probably better to use MathJax's :ref:TeX input jax  to handle LaTeX notation instead. AsciiMath delimiters ==================== By default, the asciimath2jax preprocessor defines the back-tick () as the delimiters for mathematics in AsciiMath format. It does **not** define $...$ as math delimiters. That is because dollar signs appear too often in non-mathematical settings, which could cause some text to be treated as mathematics unexpectedly. For example, with single-dollar delimiters, "... the cost is $2.50 for the first one, and$2.00 for each additional one ..." would cause the phrase "2.50 for the first one, and" to be treated as mathematics since it falls between dollar signs. For this reason, if you want to use single-dollars for AsciiMath notation, you must enable that explicitly in your configuration: .. code-block:: javascript MathJax.Hub.Config({ asciimath2jax: { delimiters: [['$','$'], ['','']] } }); Note that the dollar signs are frequently used as a delimiter for mathematics in the :term:TeX format, and you can not enable the dollar-sign delimiter for both. It is probably best to leave dollar signs for TeX notation. See the config/default.js file, or the :ref:asiimath2jax configuration options  page, for additional configuration parameters that you can specify for the asciimath2jax preprocessor, which is the component of MathJax that identifies AsciiMath notation within the page. AsciiMath in HTML documents =============================== The AsciiMath syntax is descibed in the ASCIIMathML syntax page _. Keep in mind that your mathematics is part of an HTML document, so you need to be aware of the special characters used by HTML as part of its markup. There cannot be HTML tags within the math delimiters (other than 
) as AsciiMath-formatted math does not include HTML tags. Also, since the mathematics is initially given as text on the page, you need to be careful that your mathematics doesn't look like HTML tags to the browser (which parses the page before MathJax gets to see it). In particular, that means that you have to be careful about things like less-than and greater-than signs (< and >), and ampersands (&), which have special meaning to the browsers. For example, .. code-block:: html ... when x in the document (typically the end of the next actual tag in the HTML file), and you may notice that you are missing part of the text of the document. In the example above, the "we have ..." will not be displayed because the browser thinks it is part of the tag starting at