suzanne.soy/scribble-mathjax
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Small updates documentations. One or two phrase simplifications and took out some references to 1.1 release

Browse Source
This commit is contained in:
Ivan Savov 2012-02-26 04:00:44 -05:00
parent c1fe357733
commit 8bd6ed195e
5 changed files with 24 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/source/configuration.rst
View File

@ -326,17 +326,12 @@ Using in-line configuration options
=================================== ===================================
The second way to configure MathJax is through `in-line configuration`, The second way to configure MathJax is through `in-line configuration`,
which puts the configuration options within the web page itself. This which puts the configuration options within the web page itself. The use
process was changed in version 1.1 to make it compatible with HTML5. of in-line configuration with MathJax requires two separate ``<script>``
Earlier versions of MathJax had in-line configuration included within the tags: one for specifying the configuration settings and one for loading of
content of the ``<script>`` tag that loads ``MathJax.js``, but HTML5 makes MathJax. Because MathJax starts its configuration process as soon as it is
it illegal to have content for a script with a ``src`` attribute. loaded, the configuration script must come **before** the script tag that
loads ``MathJax.js`` itself. You do this by including a ``<script>`` with
MathJax solves this problem by using separate ``<script>`` tags to
perform the configuration for and loading of MathJax. Because MathJax
starts its configuration process as soon as it is loaded, the
configuration script must come **before** the script tag that loads
``MathJax.js`` itself. You do this by including a ``<script>`` with
``type="text/x-mathjax-config"`` whose content will be run when ``type="text/x-mathjax-config"`` whose content will be run when
MathJax performs its configuration. Generally, this script will MathJax performs its configuration. Generally, this script will
include a :meth:`MathJax.Hub.Config()` call to perform MathJax include a :meth:`MathJax.Hub.Config()` call to perform MathJax

6
docs/source/installation.rst
View File

@ -96,20 +96,20 @@ to get a list of the available branches. There are separate branches
for the main releases, but with ``-latest`` appended. These contain for the main releases, but with ``-latest`` appended. These contain
all the patches for that particular release. You can check out one of all the patches for that particular release. You can check out one of
the branches just as you would a tagged copy. For example, the branch the branches just as you would a tagged copy. For example, the branch
for the ``v1.1`` tagged release is ``v1.1-latest``. To get this for the ``v2.0`` tagged release is ``v2.0-latest``. To get this
release, use release, use
.. code-block:: sh .. code-block:: sh
cd MathJax cd MathJax
git checkout v1.1-latest git checkout v2.0-latest
and to update it when changes occur, use and to update it when changes occur, use
.. code-block:: sh .. code-block:: sh
cd MathJax cd MathJax
git pull origin v1.1-latest git pull origin v2.0-latest
.. _getting-mathjax-svn: .. _getting-mathjax-svn:

9
docs/source/output.rst
View File

@ -43,8 +43,7 @@ more math is processed. MathJax version 2.0 includes a number of
optimizations to improve the display performance in IE, and it is now optimizations to improve the display performance in IE, and it is now
more comparable to other browsers. The HTML-CSS output uses web-based more comparable to other browsers. The HTML-CSS output uses web-based
fonts so that users don't have to have math fonts installed on their fonts so that users don't have to have math fonts installed on their
computers; but this does introduce some printing issues in some computers, which introduces some printing issues in certain browsers.
browsers.
The **SVG output processor** is new in MathJax version 2.0, and it uses The **SVG output processor** is new in MathJax version 2.0, and it uses
`Scalable Vector Graphics` to render the mathematics on the page. SVG `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.
Safari has some support for MathML since version 5.1, but the quality Safari has some support for MathML since version 5.1, but the quality
is not as high as either Firefox's implementation or IE with MathPlayer. is not as high as either Firefox's implementation or IE with MathPlayer.
Chrome, Konqueror, and most other browsers don't support MathML Chrome, Konqueror, and most other browsers don't support MathML
natively, but may in the future, since MathML is part of the HTML5 natively, but this may change in the future, since MathML is part of
specification. the HTML5 specification.
The advantage of the NativeMML output Processor is its speed, since The advantage of the NativeMML output Processor is its speed, since
native MathML support is much faster than using complicated HTML and native MathML support is much faster than using complicated HTML and
CSS to lay out mathematics, as the HTML-CSS output processor does. CSS to typeset mathematics, as the HTML-CSS output processor does.
The disadvantage is that you are dependent on the browser's MathML The disadvantage is that you are dependent on the browser's MathML
implementation for your rendering, and these vary in quality of output implementation for your rendering, and these vary in quality of output
and completeness of implementation. MathJax relies on features that and completeness of implementation. MathJax relies on features that

19
docs/source/start.rst
View File

@ -5,13 +5,14 @@ Getting Started
*************** ***************
MathJax allows you to include mathematics in your web pages, either MathJax allows you to include mathematics in your web pages, either
using TeX and LaTeX notation, MathML, or AsciiMath notation, and you using LaTeX, MathML, or AsciiMath notation, and the mathematics
can even use all three in the same document. will be processed using javascript to produce HTML, SVG or MathML
equations for viewing in any modern browser.
There are two ways to access MathJax: the easiest way is to use the There are two ways to access MathJax: the easiest way is to use the
copy of MathJax available from our distributed network service at copy of MathJax available from our distributed network service at
``cdn.mathjax.org``, but you can also download and install a copy of ``cdn.mathjax.org``, but you can also download and install a copy of
MathJax on your own server, or use it locally on your own hard disk MathJax on your own server, or use it locally on your hard disk
(with no need for network access). All three of these are described (with no need for network access). All three of these are described
below, with links to more detailed explanations. This page gives the below, with links to more detailed explanations. This page gives the
quickest and easiest ways to get MathJax up and running on your web quickest and easiest ways to get MathJax up and running on your web
@ -105,14 +106,12 @@ hard disk.
Obtaining and Installing MathJax Obtaining and Installing MathJax
-------------------------------- --------------------------------
The easiest way to set up MathJax is to obtain the v1.1 archive from The easiest way to set up MathJax is to obtain the v2.0 archive from
the `MathJax download page <http://www.mathjax.org/download/>`_ (you the `MathJax download page <http://www.mathjax.org/download/>`_ (you
should obtain a file named something like should obtain a file named something like ``mathjax-MathJax-v2.0?.zip``).
``mathjax-MathJax-v1.1-X-XXXXXXXX.zip``, where the X's are This archive includes both the MathJax code and the MathJax webfonts,
random-looking letters and numbers). This archive includes both the so it is the only file you need. Note that this is different from v1.0
MathJax code and the MathJax webfonts, so it is the only file you and earlier releases, which had the fonts separate from the rest of the code.
need. Note that this is different from v1.0 and earlier releases,
which had the fonts separate from the rest of the code.
Unpack the archive and place the resulting MathJax folder onto your Unpack the archive and place the resulting MathJax folder onto your
web server at a convenient location where you can include it into your web server at a convenient location where you can include it into your

3
docs/source/tex.rst
View File

@ -281,7 +281,8 @@ Autmatic Equation Numering
========================== ==========================
New in MathJax v2.0 is the ability to have equations be numbered New in MathJax v2.0 is the ability to have equations be numbered
automatically. This is off by default, so that pages don't change automatically. This functionality is turned off by default, so
that pages don't change
when you update from v1.1 to v2.0, but it is easy to configure MathJax when you update from v1.1 to v2.0, but it is easy to configure MathJax
to produce automatic equation numbers by adding: to produce automatic equation numbers by adding: