Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Incorporate Ivan's edits, fix the zipball name that he changed, and u…

…pdate SVG description to list the browsers that it doesn't support
  • Loading branch information...
commit 4d61d199cae64843dedf1f2153c372c4b191d185 1 parent db3c5e7
Davide P. Cervone authored
17 docs/html/_sources/configuration.txt
@@ -326,17 +326,12 @@ Using in-line configuration options
326 326 ===================================
327 327
328 328 The second way to configure MathJax is through `in-line configuration`,
329   -which puts the configuration options within the web page itself. This
330   -process was changed in version 1.1 to make it compatible with HTML5.
331   -Earlier versions of MathJax had in-line configuration included within the
332   -content of the ``<script>`` tag that loads ``MathJax.js``, but HTML5 makes
333   -it illegal to have content for a script with a ``src`` attribute.
334   -
335   -MathJax solves this problem by using separate ``<script>`` tags to
336   -perform the configuration for and loading of MathJax. Because MathJax
337   -starts its configuration process as soon as it is loaded, the
338   -configuration script must come **before** the script tag that loads
339   -``MathJax.js`` itself. You do this by including a ``<script>`` with
  329 +which puts the configuration options within the web page itself. The use
  330 +of in-line configuration with MathJax requires two separate ``<script>``
  331 +tags: one for specifying the configuration settings and one for loading of
  332 +MathJax. Because MathJax starts its configuration process as soon as it is
  333 +loaded, the configuration script must come **before** the script tag that
  334 +loads ``MathJax.js`` itself. You do this by including a ``<script>`` with
340 335 ``type="text/x-mathjax-config"`` whose content will be run when
341 336 MathJax performs its configuration. Generally, this script will
342 337 include a :meth:`MathJax.Hub.Config()` call to perform MathJax
6 docs/html/_sources/installation.txt
@@ -96,20 +96,20 @@ to get a list of the available branches. There are separate branches
96 96 for the main releases, but with ``-latest`` appended. These contain
97 97 all the patches for that particular release. You can check out one of
98 98 the branches just as you would a tagged copy. For example, the branch
99   -for the ``v1.1`` tagged release is ``v1.1-latest``. To get this
  99 +for the ``v2.0`` tagged release is ``v2.0-latest``. To get this
100 100 release, use
101 101
102 102 .. code-block:: sh
103 103
104 104 cd MathJax
105   - git checkout v1.1-latest
  105 + git checkout v2.0-latest
106 106
107 107 and to update it when changes occur, use
108 108
109 109 .. code-block:: sh
110 110
111 111 cd MathJax
112   - git pull origin v1.1-latest
  112 + git pull origin v2.0-latest
113 113
114 114
115 115 .. _getting-mathjax-svn:
42 docs/html/_sources/output.txt
@@ -43,25 +43,29 @@ more math is processed. MathJax version 2.0 includes a number of
43 43 optimizations to improve the display performance in IE, and it is now
44 44 more comparable to other browsers. The HTML-CSS output uses web-based
45 45 fonts so that users don't have to have math fonts installed on their
46   -computers; but this does introduce some printing issues in some
47   -browsers.
48   -
49   -The **SVG output processor** is new in MathJax version 2.0, and it uses
50   -`Scalable Vector Graphics` to render the mathematics on the page. SVG
51   -is supported in all the major browsers and most mobile devices; note,
52   -however, that Internet Explorer prior to IE9 does not support SVG, and
53   -IE9 only does in "IE9 standards mode", not its emulation modes for
54   -earlier versions. The SVG output mode is high quality and slightly
55   -faster than HTML-CSS, and it does not suffer from some of the
  46 +computers, which introduces some printing issues in certain browsers.
  47 +
  48 +The **SVG output processor** is new in MathJax version 2.0, and it
  49 +uses `Scalable Vector Graphics` to render the mathematics on the page.
  50 +SVG is supported in all the major browsers and most mobile devices;
  51 +note, however, that Internet Explorer prior to IE9 does not support
  52 +SVG, and IE9 only does in "IE9 standards mode", not its emulation
  53 +modes for earlier versions. The SVG output mode is high quality and
  54 +slightly faster than HTML-CSS, and it does not suffer from some of the
56 55 font-related issues that HTML-CSS does, so prints well in all
57 56 browsers. This format also works well in some ebook readers (e.g.,
58   -iBooks). The disadvantage of this mode is that it does not take
59   -advantage of STIX fonts, and so only has access to the characters in
60   -the web-based fonts, and it variable-width tables become fixed size
61   -once they are typeset, and don't rescale if the window size changes
62   -(for example). Since equation numbers are handled through
  57 +iBooks). The disadvantages of this mode are the following: first,
  58 +Internet Explorer only supports SVG in IE9 and later versions (and
  59 +then only in IE9 standards mode or above), and some versions of the
  60 +Android Internet browser don't have SVG enabled. Second, it does not
  61 +take advantage of STIX fonts, and so only has access to the characters
  62 +in the web-based fonts, and third, its variable-width tables become
  63 +fixed size once they are typeset, and don't rescale if the window size
  64 +changes (for example). Since equation numbers are handled through
63 65 variable-width tables, that means equation numbers may not stay at the
64   -edge of the window if it is resized.
  66 +edge of the window if it is resized. For these reasons it is probably
  67 +best not to force the use of SVG output unless you have some control
  68 +over the browsers that are used to view your documents.
65 69
66 70 The **NativeMML output processor** uses the browser's internal MathML
67 71 support (if any) to render the mathematics. Currently, Firefox has
@@ -73,12 +77,12 @@ don't recommend using the NativeMML output processor with Opera.
73 77 Safari has some support for MathML since version 5.1, but the quality
74 78 is not as high as either Firefox's implementation or IE with MathPlayer.
75 79 Chrome, Konqueror, and most other browsers don't support MathML
76   -natively, but may in the future, since MathML is part of the HTML5
77   -specification.
  80 +natively, but this may change in the future, since MathML is part of
  81 +the HTML5 specification.
78 82
79 83 The advantage of the NativeMML output Processor is its speed, since
80 84 native MathML support is much faster than using complicated HTML and
81   -CSS to lay out mathematics, as the HTML-CSS output processor does.
  85 +CSS to typeset mathematics, as the HTML-CSS output processor does.
82 86 The disadvantage is that you are dependent on the browser's MathML
83 87 implementation for your rendering, and these vary in quality of output
84 88 and completeness of implementation. MathJax relies on features that
19 docs/html/_sources/start.txt
@@ -5,13 +5,14 @@ Getting Started
5 5 ***************
6 6
7 7 MathJax allows you to include mathematics in your web pages, either
8   -using TeX and LaTeX notation, MathML, or AsciiMath notation, and you
9   -can even use all three in the same document.
  8 +using LaTeX, MathML, or AsciiMath notation, and the mathematics
  9 +will be processed using javascript to produce HTML, SVG or MathML
  10 +equations for viewing in any modern browser.
10 11
11 12 There are two ways to access MathJax: the easiest way is to use the
12 13 copy of MathJax available from our distributed network service at
13 14 ``cdn.mathjax.org``, but you can also download and install a copy of
14   -MathJax on your own server, or use it locally on your own hard disk
  15 +MathJax on your own server, or use it locally on your hard disk
15 16 (with no need for network access). All three of these are described
16 17 below, with links to more detailed explanations. This page gives the
17 18 quickest and easiest ways to get MathJax up and running on your web
@@ -105,14 +106,14 @@ hard disk.
105 106 Obtaining and Installing MathJax
106 107 --------------------------------
107 108
108   -The easiest way to set up MathJax is to obtain the v1.1 archive from
  109 +The easiest way to set up MathJax is to obtain the v2.0 archive from
109 110 the `MathJax download page <http://www.mathjax.org/download/>`_ (you
110 111 should obtain a file named something like
111   -``mathjax-MathJax-v1.1-X-XXXXXXXX.zip``, where the X's are
112   -random-looking letters and numbers). This archive includes both the
113   -MathJax code and the MathJax webfonts, so it is the only file you
114   -need. Note that this is different from v1.0 and earlier releases,
115   -which had the fonts separate from the rest of the code.
  112 +``mathjax-MathJax-v2.0-X-XXXXXXXX.zip`` where the X's are random
  113 +looking numbers and letters). This archive includes both the MathJax
  114 +code and the MathJax webfonts, so it is the only file you need. Note
  115 +that this is different from v1.0 and earlier releases, which had the
  116 +fonts separate from the rest of the code.
116 117
117 118 Unpack the archive and place the resulting MathJax folder onto your
118 119 web server at a convenient location where you can include it into your
3  docs/html/_sources/tex.txt
@@ -281,7 +281,8 @@ Autmatic Equation Numering
281 281 ==========================
282 282
283 283 New in MathJax v2.0 is the ability to have equations be numbered
284   -automatically. This is off by default, so that pages don't change
  284 +automatically. This functionality is turned off by default, so
  285 +that pages don't change
285 286 when you update from v1.1 to v2.0, but it is easy to configure MathJax
286 287 to produce automatic equation numbers by adding:
287 288
16 docs/html/configuration.html
@@ -326,16 +326,12 @@
326 326 <div class="section" id="using-in-line-configuration-options">
327 327 <span id="inline-config"></span><h2>Using in-line configuration options<a class="headerlink" href="#using-in-line-configuration-options" title="Permalink to this headline">¶</a></h2>
328 328 <p>The second way to configure MathJax is through <cite>in-line configuration</cite>,
329   -which puts the configuration options within the web page itself. This
330   -process was changed in version 1.1 to make it compatible with HTML5.
331   -Earlier versions of MathJax had in-line configuration included within the
332   -content of the <tt class="docutils literal"><span class="pre">&lt;script&gt;</span></tt> tag that loads <tt class="docutils literal"><span class="pre">MathJax.js</span></tt>, but HTML5 makes
333   -it illegal to have content for a script with a <tt class="docutils literal"><span class="pre">src</span></tt> attribute.</p>
334   -<p>MathJax solves this problem by using separate <tt class="docutils literal"><span class="pre">&lt;script&gt;</span></tt> tags to
335   -perform the configuration for and loading of MathJax. Because MathJax
336   -starts its configuration process as soon as it is loaded, the
337   -configuration script must come <strong>before</strong> the script tag that loads
338   -<tt class="docutils literal"><span class="pre">MathJax.js</span></tt> itself. You do this by including a <tt class="docutils literal"><span class="pre">&lt;script&gt;</span></tt> with
  329 +which puts the configuration options within the web page itself. The use
  330 +of in-line configuration with MathJax requires two separate <tt class="docutils literal"><span class="pre">&lt;script&gt;</span></tt>
  331 +tags: one for specifying the configuration settings and one for loading of
  332 +MathJax. Because MathJax starts its configuration process as soon as it is
  333 +loaded, the configuration script must come <strong>before</strong> the script tag that
  334 +loads <tt class="docutils literal"><span class="pre">MathJax.js</span></tt> itself. You do this by including a <tt class="docutils literal"><span class="pre">&lt;script&gt;</span></tt> with
339 335 <tt class="docutils literal"><span class="pre">type=&quot;text/x-mathjax-config&quot;</span></tt> whose content will be run when
340 336 MathJax performs its configuration. Generally, this script will
341 337 include a <tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></tt> call to perform MathJax
6 docs/html/installation.html
@@ -118,15 +118,15 @@
118 118 for the main releases, but with <tt class="docutils literal"><span class="pre">-latest</span></tt> appended. These contain
119 119 all the patches for that particular release. You can check out one of
120 120 the branches just as you would a tagged copy. For example, the branch
121   -for the <tt class="docutils literal"><span class="pre">v1.1</span></tt> tagged release is <tt class="docutils literal"><span class="pre">v1.1-latest</span></tt>. To get this
  121 +for the <tt class="docutils literal"><span class="pre">v2.0</span></tt> tagged release is <tt class="docutils literal"><span class="pre">v2.0-latest</span></tt>. To get this
122 122 release, use</p>
123 123 <div class="highlight-sh"><div class="highlight"><pre><span class="nb">cd </span>MathJax
124   -git checkout v1.1-latest
  124 +git checkout v2.0-latest
125 125 </pre></div>
126 126 </div>
127 127 <p>and to update it when changes occur, use</p>
128 128 <div class="highlight-sh"><div class="highlight"><pre><span class="nb">cd </span>MathJax
129   -git pull origin v1.1-latest
  129 +git pull origin v2.0-latest
130 130 </pre></div>
131 131 </div>
132 132 </div>
40 docs/html/output.html
@@ -85,24 +85,28 @@
85 85 optimizations to improve the display performance in IE, and it is now
86 86 more comparable to other browsers. The HTML-CSS output uses web-based
87 87 fonts so that users don&#8217;t have to have math fonts installed on their
88   -computers; but this does introduce some printing issues in some
89   -browsers.</p>
90   -<p>The <strong>SVG output processor</strong> is new in MathJax version 2.0, and it uses
91   -<cite>Scalable Vector Graphics</cite> to render the mathematics on the page. SVG
92   -is supported in all the major browsers and most mobile devices; note,
93   -however, that Internet Explorer prior to IE9 does not support SVG, and
94   -IE9 only does in &#8220;IE9 standards mode&#8221;, not its emulation modes for
95   -earlier versions. The SVG output mode is high quality and slightly
96   -faster than HTML-CSS, and it does not suffer from some of the
  88 +computers, which introduces some printing issues in certain browsers.</p>
  89 +<p>The <strong>SVG output processor</strong> is new in MathJax version 2.0, and it
  90 +uses <cite>Scalable Vector Graphics</cite> to render the mathematics on the page.
  91 +SVG is supported in all the major browsers and most mobile devices;
  92 +note, however, that Internet Explorer prior to IE9 does not support
  93 +SVG, and IE9 only does in &#8220;IE9 standards mode&#8221;, not its emulation
  94 +modes for earlier versions. The SVG output mode is high quality and
  95 +slightly faster than HTML-CSS, and it does not suffer from some of the
97 96 font-related issues that HTML-CSS does, so prints well in all
98 97 browsers. This format also works well in some ebook readers (e.g.,
99   -iBooks). The disadvantage of this mode is that it does not take
100   -advantage of STIX fonts, and so only has access to the characters in
101   -the web-based fonts, and it variable-width tables become fixed size
102   -once they are typeset, and don&#8217;t rescale if the window size changes
103   -(for example). Since equation numbers are handled through
  98 +iBooks). The disadvantages of this mode are the following: first,
  99 +Internet Explorer only supports SVG in IE9 and later versions (and
  100 +then only in IE9 standards mode or above), and some versions of the
  101 +Android Internet browser don&#8217;t have SVG enabled. Second, it does not
  102 +take advantage of STIX fonts, and so only has access to the characters
  103 +in the web-based fonts, and third, its variable-width tables become
  104 +fixed size once they are typeset, and don&#8217;t rescale if the window size
  105 +changes (for example). Since equation numbers are handled through
104 106 variable-width tables, that means equation numbers may not stay at the
105   -edge of the window if it is resized.</p>
  107 +edge of the window if it is resized. For these reasons it is probably
  108 +best not to force the use of SVG output unless you have some control
  109 +over the browsers that are used to view your documents.</p>
106 110 <p>The <strong>NativeMML output processor</strong> uses the browser&#8217;s internal MathML
107 111 support (if any) to render the mathematics. Currently, Firefox has
108 112 native support for MathML, and IE has the <a class="reference external" href="http://www.dessci.com/en/products/mathplayer/">MathPlayer plugin</a> for rendering
@@ -112,11 +116,11 @@
112 116 Safari has some support for MathML since version 5.1, but the quality
113 117 is not as high as either Firefox&#8217;s implementation or IE with MathPlayer.
114 118 Chrome, Konqueror, and most other browsers don&#8217;t support MathML
115   -natively, but may in the future, since MathML is part of the HTML5
116   -specification.</p>
  119 +natively, but this may change in the future, since MathML is part of
  120 +the HTML5 specification.</p>
117 121 <p>The advantage of the NativeMML output Processor is its speed, since
118 122 native MathML support is much faster than using complicated HTML and
119   -CSS to lay out mathematics, as the HTML-CSS output processor does.
  123 +CSS to typeset mathematics, as the HTML-CSS output processor does.
120 124 The disadvantage is that you are dependent on the browser&#8217;s MathML
121 125 implementation for your rendering, and these vary in quality of output
122 126 and completeness of implementation. MathJax relies on features that
2  docs/html/searchindex.js
1 addition, 1 deletion not shown
19 docs/html/start.html
@@ -52,12 +52,13 @@
52 52 <div class="section" id="getting-started">
53 53 <span id="id1"></span><h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h1>
54 54 <p>MathJax allows you to include mathematics in your web pages, either
55   -using TeX and LaTeX notation, MathML, or AsciiMath notation, and you
56   -can even use all three in the same document.</p>
  55 +using LaTeX, MathML, or AsciiMath notation, and the mathematics
  56 +will be processed using javascript to produce HTML, SVG or MathML
  57 +equations for viewing in any modern browser.</p>
57 58 <p>There are two ways to access MathJax: the easiest way is to use the
58 59 copy of MathJax available from our distributed network service at
59 60 <tt class="docutils literal"><span class="pre">cdn.mathjax.org</span></tt>, but you can also download and install a copy of
60   -MathJax on your own server, or use it locally on your own hard disk
  61 +MathJax on your own server, or use it locally on your hard disk
61 62 (with no need for network access). All three of these are described
62 63 below, with links to more detailed explanations. This page gives the
63 64 quickest and easiest ways to get MathJax up and running on your web
@@ -129,14 +130,14 @@
129 130 </ol>
130 131 <div class="section" id="obtaining-and-installing-mathjax">
131 132 <h3>Obtaining and Installing MathJax<a class="headerlink" href="#obtaining-and-installing-mathjax" title="Permalink to this headline">¶</a></h3>
132   -<p>The easiest way to set up MathJax is to obtain the v1.1 archive from
  133 +<p>The easiest way to set up MathJax is to obtain the v2.0 archive from
133 134 the <a class="reference external" href="http://www.mathjax.org/download/">MathJax download page</a> (you
134 135 should obtain a file named something like
135   -<tt class="docutils literal"><span class="pre">mathjax-MathJax-v1.1-X-XXXXXXXX.zip</span></tt>, where the X&#8217;s are
136   -random-looking letters and numbers). This archive includes both the
137   -MathJax code and the MathJax webfonts, so it is the only file you
138   -need. Note that this is different from v1.0 and earlier releases,
139   -which had the fonts separate from the rest of the code.</p>
  136 +<tt class="docutils literal"><span class="pre">mathjax-MathJax-v2.0-X-XXXXXXXX.zip</span></tt> where the X&#8217;s are random
  137 +looking numbers and letters). This archive includes both the MathJax
  138 +code and the MathJax webfonts, so it is the only file you need. Note
  139 +that this is different from v1.0 and earlier releases, which had the
  140 +fonts separate from the rest of the code.</p>
140 141 <p>Unpack the archive and place the resulting MathJax folder onto your
141 142 web server at a convenient location where you can include it into your
142 143 web pages. For example, making <tt class="docutils literal"><span class="pre">MathJax</span></tt> a top-level directory on
3  docs/html/tex.html
@@ -277,7 +277,8 @@
277 277 <div class="section" id="autmatic-equation-numering">
278 278 <span id="tex-eq-numbers"></span><h2>Autmatic Equation Numering<a class="headerlink" href="#autmatic-equation-numering" title="Permalink to this headline">¶</a></h2>
279 279 <p>New in MathJax v2.0 is the ability to have equations be numbered
280   -automatically. This is off by default, so that pages don&#8217;t change
  280 +automatically. This functionality is turned off by default, so
  281 +that pages don&#8217;t change
281 282 when you update from v1.1 to v2.0, but it is easy to configure MathJax
282 283 to produce automatic equation numbers by adding:</p>
283 284 <div class="highlight-html"><div class="highlight"><pre><span class="nt">&lt;script </span><span class="na">type=</span><span class="s">&quot;text/x-mathjax-config&quot;</span><span class="nt">&gt;</span>
31 docs/source/output.rst
Source Rendered
@@ -45,22 +45,27 @@ more comparable to other browsers. The HTML-CSS output uses web-based
45 45 fonts so that users don't have to have math fonts installed on their
46 46 computers, which introduces some printing issues in certain browsers.
47 47
48   -The **SVG output processor** is new in MathJax version 2.0, and it uses
49   -`Scalable Vector Graphics` to render the mathematics on the page. SVG
50   -is supported in all the major browsers and most mobile devices; note,
51   -however, that Internet Explorer prior to IE9 does not support SVG, and
52   -IE9 only does in "IE9 standards mode", not its emulation modes for
53   -earlier versions. The SVG output mode is high quality and slightly
54   -faster than HTML-CSS, and it does not suffer from some of the
  48 +The **SVG output processor** is new in MathJax version 2.0, and it
  49 +uses `Scalable Vector Graphics` to render the mathematics on the page.
  50 +SVG is supported in all the major browsers and most mobile devices;
  51 +note, however, that Internet Explorer prior to IE9 does not support
  52 +SVG, and IE9 only does in "IE9 standards mode", not its emulation
  53 +modes for earlier versions. The SVG output mode is high quality and
  54 +slightly faster than HTML-CSS, and it does not suffer from some of the
55 55 font-related issues that HTML-CSS does, so prints well in all
56 56 browsers. This format also works well in some ebook readers (e.g.,
57   -iBooks). The disadvantage of this mode is that it does not take
58   -advantage of STIX fonts, and so only has access to the characters in
59   -the web-based fonts, and it variable-width tables become fixed size
60   -once they are typeset, and don't rescale if the window size changes
61   -(for example). Since equation numbers are handled through
  57 +iBooks). The disadvantages of this mode are the following: first,
  58 +Internet Explorer only supports SVG in IE9 and later versions (and
  59 +then only in IE9 standards mode or above), and some versions of the
  60 +Android Internet browser don't have SVG enabled. Second, it does not
  61 +take advantage of STIX fonts, and so only has access to the characters
  62 +in the web-based fonts, and third, its variable-width tables become
  63 +fixed size once they are typeset, and don't rescale if the window size
  64 +changes (for example). Since equation numbers are handled through
62 65 variable-width tables, that means equation numbers may not stay at the
63   -edge of the window if it is resized.
  66 +edge of the window if it is resized. For these reasons it is probably
  67 +best not to force the use of SVG output unless you have some control
  68 +over the browsers that are used to view your documents.
64 69
65 70 The **NativeMML output processor** uses the browser's internal MathML
66 71 support (if any) to render the mathematics. Currently, Firefox has
10 docs/source/start.rst
Source Rendered
@@ -108,10 +108,12 @@ Obtaining and Installing MathJax
108 108
109 109 The easiest way to set up MathJax is to obtain the v2.0 archive from
110 110 the `MathJax download page <http://www.mathjax.org/download/>`_ (you
111   -should obtain a file named something like ``mathjax-MathJax-v2.0?.zip``).
112   -This archive includes both the MathJax code and the MathJax webfonts,
113   -so it is the only file you need. Note that this is different from v1.0
114   -and earlier releases, which had the fonts separate from the rest of the code.
  111 +should obtain a file named something like
  112 +``mathjax-MathJax-v2.0-X-XXXXXXXX.zip`` where the X's are random
  113 +looking numbers and letters). This archive includes both the MathJax
  114 +code and the MathJax webfonts, so it is the only file you need. Note
  115 +that this is different from v1.0 and earlier releases, which had the
  116 +fonts separate from the rest of the code.
115 117
116 118 Unpack the archive and place the resulting MathJax folder onto your
117 119 web server at a convenient location where you can include it into your

0 comments on commit 4d61d19

Please sign in to comment.
Something went wrong with that request. Please try again.