Skip to content

Commit db3c5e7

Browse files
committed
Merge pull request #1 from ivanistheone/v2.0-candidate
Small fixes for v2.0 docs
2 parents c1fe357 + 8bd6ed1 commit db3c5e7

File tree

5 files changed

+24
-30
lines changed

5 files changed

+24
-30
lines changed

docs/source/configuration.rst

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/source/installation.rst

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/source/output.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@ 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.
46+
computers, which introduces some printing issues in certain browsers.
4847

4948
The **SVG output processor** is new in MathJax version 2.0, and it uses
5049
`Scalable Vector Graphics` to render the mathematics on the page. SVG
@@ -73,12 +72,12 @@ don't recommend using the NativeMML output processor with Opera.
7372
Safari has some support for MathML since version 5.1, but the quality
7473
is not as high as either Firefox's implementation or IE with MathPlayer.
7574
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.
75+
natively, but this may change in the future, since MathML is part of
76+
the HTML5 specification.
7877

7978
The advantage of the NativeMML output Processor is its speed, since
8079
native MathML support is much faster than using complicated HTML and
81-
CSS to lay out mathematics, as the HTML-CSS output processor does.
80+
CSS to typeset mathematics, as the HTML-CSS output processor does.
8281
The disadvantage is that you are dependent on the browser's MathML
8382
implementation for your rendering, and these vary in quality of output
8483
and completeness of implementation. MathJax relies on features that

docs/source/start.rst

Lines changed: 9 additions & 10 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,12 @@ 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
110-
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.
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.
116115

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

docs/source/tex.rst

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

0 commit comments

Comments
 (0)