Skip to content

Commit 4d61d19

Browse files
committed
Incorporate Ivan's edits, fix the zipball name that he changed, and update SVG description to list the browsers that it doesn't support
1 parent db3c5e7 commit 4d61d19

File tree

13 files changed

+112
-102
lines changed

13 files changed

+112
-102
lines changed

docs/html/_sources/configuration.txt

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -326,17 +326,12 @@ Using in-line configuration options
326326
===================================
327327

328328
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
340335
``type="text/x-mathjax-config"`` whose content will be run when
341336
MathJax performs its configuration. Generally, this script will
342337
include a :meth:`MathJax.Hub.Config()` call to perform MathJax

docs/html/_sources/installation.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,20 +96,20 @@ to get a list of the available branches. There are separate branches
9696
for the main releases, but with ``-latest`` appended. These contain
9797
all the patches for that particular release. You can check out one of
9898
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
100100
release, use
101101

102102
.. code-block:: sh
103103

104104
cd MathJax
105-
git checkout v1.1-latest
105+
git checkout v2.0-latest
106106

107107
and to update it when changes occur, use
108108

109109
.. code-block:: sh
110110

111111
cd MathJax
112-
git pull origin v1.1-latest
112+
git pull origin v2.0-latest
113113

114114

115115
.. _getting-mathjax-svn:

docs/html/_sources/output.txt

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -43,25 +43,29 @@ more math is processed. MathJax version 2.0 includes a number of
4343
optimizations to improve the display performance in IE, and it is now
4444
more comparable to other browsers. The HTML-CSS output uses web-based
4545
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
5655
font-related issues that HTML-CSS does, so prints well in all
5756
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
6365
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.
6569

6670
The **NativeMML output processor** uses the browser's internal MathML
6771
support (if any) to render the mathematics. Currently, Firefox has
@@ -73,12 +77,12 @@ don't recommend using the NativeMML output processor with Opera.
7377
Safari has some support for MathML since version 5.1, but the quality
7478
is not as high as either Firefox's implementation or IE with MathPlayer.
7579
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.
7882

7983
The advantage of the NativeMML output Processor is its speed, since
8084
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.
8286
The disadvantage is that you are dependent on the browser's MathML
8387
implementation for your rendering, and these vary in quality of output
8488
and completeness of implementation. MathJax relies on features that

docs/html/_sources/start.txt

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,14 @@ Getting Started
55
***************
66

77
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.
1011

1112
There are two ways to access MathJax: the easiest way is to use the
1213
copy of MathJax available from our distributed network service at
1314
``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
1516
(with no need for network access). All three of these are described
1617
below, with links to more detailed explanations. This page gives the
1718
quickest and easiest ways to get MathJax up and running on your web
@@ -105,14 +106,14 @@ hard disk.
105106
Obtaining and Installing MathJax
106107
--------------------------------
107108

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
109110
the `MathJax download page <http://www.mathjax.org/download/>`_ (you
110111
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.
116117

117118
Unpack the archive and place the resulting MathJax folder onto your
118119
web server at a convenient location where you can include it into your

docs/html/_sources/tex.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,8 @@ Autmatic Equation Numering
281281
==========================
282282

283283
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
285286
when you update from v1.1 to v2.0, but it is easy to configure MathJax
286287
to produce automatic equation numbers by adding:
287288

docs/html/configuration.html

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -326,16 +326,12 @@ <h2>Configuring MathJax<a class="headerlink" href="#configuring-mathjax" title="
326326
<div class="section" id="using-in-line-configuration-options">
327327
<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>
328328
<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
339335
<tt class="docutils literal"><span class="pre">type=&quot;text/x-mathjax-config&quot;</span></tt> whose content will be run when
340336
MathJax performs its configuration. Generally, this script will
341337
include a <tt class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Config()</span></tt> call to perform MathJax

docs/html/installation.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,15 +118,15 @@ <h3>Navigation</h3>
118118
for the main releases, but with <tt class="docutils literal"><span class="pre">-latest</span></tt> appended. These contain
119119
all the patches for that particular release. You can check out one of
120120
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
122122
release, use</p>
123123
<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
125125
</pre></div>
126126
</div>
127127
<p>and to update it when changes occur, use</p>
128128
<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
130130
</pre></div>
131131
</div>
132132
</div>

docs/html/output.html

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -85,24 +85,28 @@ <h3>Navigation</h3>
8585
optimizations to improve the display performance in IE, and it is now
8686
more comparable to other browsers. The HTML-CSS output uses web-based
8787
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
9796
font-related issues that HTML-CSS does, so prints well in all
9897
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
104106
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>
106110
<p>The <strong>NativeMML output processor</strong> uses the browser&#8217;s internal MathML
107111
support (if any) to render the mathematics. Currently, Firefox has
108112
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 @@ <h3>Navigation</h3>
112116
Safari has some support for MathML since version 5.1, but the quality
113117
is not as high as either Firefox&#8217;s implementation or IE with MathPlayer.
114118
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>
117121
<p>The advantage of the NativeMML output Processor is its speed, since
118122
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.
120124
The disadvantage is that you are dependent on the browser&#8217;s MathML
121125
implementation for your rendering, and these vary in quality of output
122126
and completeness of implementation. MathJax relies on features that

docs/html/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/html/start.html

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,13 @@ <h3>Navigation</h3>
5252
<div class="section" id="getting-started">
5353
<span id="id1"></span><h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline"></a></h1>
5454
<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>
5758
<p>There are two ways to access MathJax: the easiest way is to use the
5859
copy of MathJax available from our distributed network service at
5960
<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
6162
(with no need for network access). All three of these are described
6263
below, with links to more detailed explanations. This page gives the
6364
quickest and easiest ways to get MathJax up and running on your web
@@ -129,14 +130,14 @@ <h2>Installing Your Own Copy of MathJax<a class="headerlink" href="#installing-y
129130
</ol>
130131
<div class="section" id="obtaining-and-installing-mathjax">
131132
<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
133134
the <a class="reference external" href="http://www.mathjax.org/download/">MathJax download page</a> (you
134135
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>
140141
<p>Unpack the archive and place the resulting MathJax folder onto your
141142
web server at a convenient location where you can include it into your
142143
web pages. For example, making <tt class="docutils literal"><span class="pre">MathJax</span></tt> a top-level directory on

0 commit comments

Comments
 (0)