Skip to content

Commit

Permalink
Merge pull request #113 from mathjax/master
Browse files Browse the repository at this point in the history
v2.6 release prep: update 2.5-latest branch with changes from master
  • Loading branch information
pkra committed Sep 8, 2015
2 parents 234106e + 653f34f commit 7979207
Show file tree
Hide file tree
Showing 16 changed files with 64 additions and 33 deletions.
13 changes: 13 additions & 0 deletions api/hub.rst
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,19 @@ Methods
`New Math` messages are sent). When the message equals the
`type`, the `callback` will be called with the message as its
parameter.

The following is an example for using the MessageHook to list
internal errors within MathJax which would otherwise be silent:

.. code-block:: javascript
MathJax.Hub.Register.MessageHook("TeX Jax - parse error",function (message) {
// do something with the error. message[1] will contain the data about the error.
});

MathJax.Hub.Register.MessageHook("Math Processing Error",function (message) {
// do something with the error. message[2] is the Error object that records the problem.
});

:Parameters:
- **type** --- a string indicating the message to look for
Expand Down
2 changes: 1 addition & 1 deletion asciimath.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ example,

... when `x<y` we have ...

will cause a problem, because the brower will think ``<y`` is the
will cause a problem, because the browser will think ``<y`` is the
beginning of a tag named ``y`` (even though there is no such tag in
HTML). When this happens, the browser will think the tag continues up
to the next ``>`` in the document (typically the end of the next
Expand Down
11 changes: 7 additions & 4 deletions community.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ with MathJax in your environment.
.. _community-forums:


Forums
======
Mailing Lists
=============

If you need help using MathJax or you have solutions you want to share, please
use the `MathJax Users Google Group
post to the `MathJax Users Google Group
<https://groups.google.com/forum/#!forum/mathjax-users>`_. We try hard to answer
questions quickly, and users are welcome to help with that as well. Also, users
can post code snippets showing how they have used MathJax, so it may be a good
Expand All @@ -34,6 +34,9 @@ The community is only as good as the users who participate, so if
you have something to offer, please take time to make a post on one of
our groups.

If you want to follow just our press releases, please subscribe to
`our press list <http://eepurl.com/hqn6-/>`_.


.. _community-tracker:

Expand Down Expand Up @@ -68,5 +71,5 @@ contribut to the public `documentation wiki <https://github.com/mathjax/mathjax-
====================

If you are using MathJax and want to show your support, please consider using
our `"Powered by MathJax" badge
our :ref:`"Powered by MathJax" badge
<mathjax-badges>`.
18 changes: 13 additions & 5 deletions configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,10 @@ get. The CDN has the following directory structure:
2.1-latest/ # the 2.1 release with any critical patches
2.2-latest/ # the 2.2 release with any critical patches
2.3-latest/ # the 2.3 release with any critical patches
2.4-latest/ # the 2.4 release with any critical patches
2.5-latest/ # the 2.5 release with any critical patches
...
latest/ # the most current version (2.3-latest in this case)
latest/ # the most current version (2.5-latest in this case)
Each directory corresponds to an official MathJax release; however,
hotfixes (urgent bug fixes) will be applied in each release branch as
Expand Down Expand Up @@ -392,8 +394,14 @@ in this example:
<script type="text/javascript" src="path-to-MathJax/MathJax.js?config=TeX-AMS_HTML">
</script>


.. _plainjs-config:

Using plain JavaScript
======================

Starting with MathJax version 2.3, it is possible to set ``window.MathJax`` to
a configuration object in any Javascript code before MathJax's startup.
a configuration object in any JavaScript code before MathJax's startup.
MathJax will then use that object for its initial configuration. For instance
the previous example becomes:

Expand All @@ -410,9 +418,9 @@ the previous example becomes:
<script type="text/javascript" src="path-to-MathJax/MathJax.js?config=TeX-AMS_HTML">
</script>

Similarly to ``text/x-mathjax-config``, you can enter arbitrary code to execute
during the configuration phase. You just need to put that code in an
``AuthorInit`` function:
Similarly to scripts with the custom type ``text/x-mathjax-config``, you can
enter arbitrary code to execute during the configuration phase. You just
need to put that code in an ``AuthorInit`` function:

.. code-block:: html

Expand Down
5 changes: 3 additions & 2 deletions installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,13 @@ Release versions of MathJax are available in archive files from the
"zip" button, or the "downloads" tab), where you can download the archive
that you need.

**Current Version**: `MathJax-2.4 <https://github.com/mathjax/MathJax/archive/v2.4-latest.zip>`_ (32.6MB)
**Current Version**: `MathJax-2.5 <https://github.com/mathjax/MathJax/archive/v2.5-latest.zip>`_ (33.0MB)

Consult the :ref:`change log <whats-new-2.4>` for what’s new in version 2.4.
Consult the :ref:`change log <whats-new-2.5>` for what’s new in version 2.5.

For previous versions, see

- `MathJax-2.4 <https://github.com/mathjax/MathJax/archive/v2.4-latest.zip>`_ (32.6MB)
- `MathJax-2.3 <https://github.com/mathjax/MathJax/archive/v2.3-latest.zip>`_ (32.9MB)
- `MathJax-2.2 <https://github.com/mathjax/MathJax/archive/v2.2-latest.zip>`_ (17.0MB)
- `MathJax-2.1 <https://github.com/mathjax/MathJax/archive/v2.1-latest.zip>`_ (17.1MB)
Expand Down
4 changes: 2 additions & 2 deletions mathml.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,9 @@ The deficiencies include:
and ``rowspan`` are not implemented yet.

- Experimental support for the elementary math tags: ``mstack``, ``mlongdiv``,
``msgroup``, ``msrow``, ``mscarries``, and ``mscarry``.
``msgroup``, ``msrow``, ``mscarries``, and ``mscarry``. (Via the ``mml3`` extension, see below.)

- Experimental support for bidirectional mathematics.
- Experimental support for bidirectional mathematics. (Via the ``mml3`` extension, see below.)

See the `results of the MathML3.0 test suite
<http://www.w3.org/Math/testsuite/results/tests.html>`_ for details.
Expand Down
4 changes: 2 additions & 2 deletions misc/browser-compatibility.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ tested with MathJax. Please comment in the `MathJax User Group
on GitHub <https://github.com/mathjax/MathJax/issues>`__ if you
notice inaccuracies or problems.

For screenshots, we suggest to visit `mathjax.org/demos/tex-samples/
<http://www.mathjax.org/demos/tex-samples/>`_ using services such as
For screenshots, we suggest to visit `mathjax.org
<http://www.mathjax.org/#modal-samples>`_ using services such as
`browsershots.org <http://browsershots.org>`_,
`saucelabs.com <http://saucelabs.com>`_, or `browserstack.com
<http://browserstack.com>`_.
Expand Down
2 changes: 1 addition & 1 deletion misc/epub.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ their MathML support. Please help us keep this table up-to-date!
+-------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------+
| Name | MathML support | Platform |
+=====================================================================================+===================================================================================+====================================================+
| `Adobe Digital Editions <http://www.adobe.com/products/digital-editions.html>`_ | no | Windows, Mac |
| `Adobe Digital Editions <http://www.adobe.com/products/digital-editions.html>`_ | on Mac via Safari, on Windows via MathJax | Windows, Mac |
+-------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------+
| `Aldiko <http://www.aldiko.com/>`_ | no | Android |
+-------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------+
Expand Down
6 changes: 3 additions & 3 deletions misc/mathjax-in-use.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
MathJax In Use
**********************************

This is a selection of (web) applications using MathJax —
This is a historic selection of (web) applications using MathJax —
showcasing some interesting examples that may serve as inspiration.

Please add your application!

We keep this for historic purposes. We still highlight new examples
in our commnunity news blog posts at mathjax.org.

Authoring
~~~~~~~~~~~~
Expand Down
4 changes: 1 addition & 3 deletions misc/platforms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ and other content-management systems.

- `MathJax-LaTeX`_, `Simple-MathJax`_ plug-ins for `WordPress`_.
- `MathJax plugin for Drupal`_.
- `MathJax integration for Plone`_.
- `Concrete5 MathJax plugin`_.
- `MathJax plugins`_ for `Joomla`_.
- `Sphinx extension: MathJax`_
Expand All @@ -28,7 +27,6 @@ and other content-management systems.
.. _MathJax-LaTeX: http://wordpress.org/extend/plugins/mathjax-latex/
.. _Simple-MathJax: http://wordpress.org/extend/plugins/simple-mathjax/
.. _MathJax plugin for Drupal: http://drupal.org/project/mathjax
.. _MathJax integration for Plone: http://drupal.org/project/mathjax
.. _MathJax plugin for DokuWiki: https://www.dokuwiki.org/plugin:mathjax
.. _Concrete5 MathJax plugin: http://www.concrete5.org/marketplace/addons/load-mathjax/
.. _PluginMathJax: http://myweb.dal.ca/haines/#PluginMathJax
Expand Down Expand Up @@ -102,7 +100,7 @@ consists of multiple files.
To enable MathJax in your web platform, add the line::

<script type="text/javascript"
src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
src="httpsp://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>

either just before the ``</head>`` tag in your theme file, or at the end of
the file if it contains no ``</head>``.
Expand Down
2 changes: 1 addition & 1 deletion model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ MathML tags into the page to represent the mathematics, while the
HTML-CSS output jax uses HTML with CSS styling to lay out the
mathematics so that it can be displayed even in browsers that don't
understand MathML. MathJax also has an :term:`SVG` output jax that
will render the mathematics using scalable vector grtaphics. Output
will render the mathematics using scalable vector graphics. Output
jax could be produced that render the mathematics using HTML5 canvas
elements, for example, or that speak an equation for blind users. The
MathJax contextual menu can be used to switch between the output jax
Expand Down
8 changes: 8 additions & 0 deletions options/HTML-CSS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -203,3 +203,11 @@ would set the ``preferredFont`` option to the :term:`STIX` fonts.

These are the offset from the mouse position (in pixels)
where the tooltip will be placed.

.. describe:: noReflows: true

This value determines if the HTML-CSS output makes additional
measurements during layout for better layout quality, in
particular with respect to unknown Unicode characters. As
these measurements require reflow setting this to ``false``
will reduce performance but can help resolve layout issues.
4 changes: 2 additions & 2 deletions output.rst
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ to your page just before the ``<script>`` tag that loads
``MathJax.js`` itself.

Note that line breaking only applies to displayed equations, not
in-line equations (unless the in-line euqation is itself longer than a
in-line equations (unless the in-line equation is itself longer than a
line), and that the line-breaks are only computed once when the
equation is initially typeset, and do not change if the user changes
the window size, or if the container changes size for some other
Expand All @@ -192,7 +192,7 @@ can make it a fixed width, or make it a percentage of the container.
See the :ref:`HTML-CSS configuration <configure-HTML-CSS>` or
:ref:`SVG configuration <configure-SVG>` pages for more details.

The linbe-breaking algorithm uses the nesting depth, the type of
The line-breaking algorithm uses the nesting depth, the type of
operator, the size of spaces, and other factors to decide on the
breakpoints, but it does not know the meaning of the mathematics, and
may not choose the optimal breakpoints. We will continue to work on
Expand Down
6 changes: 3 additions & 3 deletions start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ dollar-sign delimiters.

Here is a complete sample page containing TeX mathematics (also
available in the `test/sample-tex.html
<http://cdn.mathjax.org/mathjax/2.1-latest/test/sample-tex.html>`_
<http://cdn.mathjax.org/mathjax/latest/test/sample-tex.html>`_
file):

.. code-block:: html
Expand Down Expand Up @@ -371,7 +371,7 @@ situations.

Here is a complete sample page containing MathML mathematics (also
available in the `test/sample-mml.html
<http://cdn.mathjax.org/mathjax/2.1-latest/test/sample-mml.html>`_
<http://cdn.mathjax.org/mathjax/latest/test/sample-mml.html>`_
file):

.. code-block:: html
Expand Down Expand Up @@ -459,7 +459,7 @@ expressions by surrounding them in "back-ticks", i.e., ```...```.

Here is a complete sample page containing AsciiMath notation (also
available in the `test/sample-asciimath.html
<http://cdn.mathjax.org/mathjax/2.1-latest/test/sample-asciimath.html>`_
<http://cdn.mathjax.org/mathjax/latest/test/sample-asciimath.html>`_
file):

.. code-block:: html
Expand Down
4 changes: 2 additions & 2 deletions tex.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ example,

... when $x<y$ we have ...

will cause a problem, because the brower will think ``<y`` is the
will cause a problem, because the browser will think ``<y`` is the
beginning of a tag named ``y`` (even though there is no such tag in
HTML). When this happens, the browser will think the tag continues up
to the next ``>`` in the document (typically the end of the next
Expand Down Expand Up @@ -149,7 +149,7 @@ this for you, and you can find a MathJax plugin for your system on the
<http://www.mathjax.org/community/mathjax-in-use/>`_ page.

If there is no plugin for your system, or if it doesn't handle the
subtleties of issolating the mathematics from the other markup that it
subtleties of isolating the mathematics from the other markup that it
supports, then you may have to "trick" it into leaving your
mathematics untouched. Most content-management systems provide some
means of indicating text that should not be modified ("verbatim"
Expand Down
4 changes: 2 additions & 2 deletions whats-new-2.5.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Features
* *Improved elementary math support* The experimental support for elementary math elements has been significantly improved special thanks to David Carlisle.
* *NodeJS compatibility*. Enable the implementation of a NodeJS API (released as `MathJax-node <https://github.com/mathjax/MathJax-node>`__).

Numerous display bugs, line-breaking problems, and interface issues have been resolved; for a detailed listing please check the `release milestone <https://github.com/mathjax/MathJax/issues?milestone=2&state=closed>`__.
Numerous display bugs, line-breaking problems, and interface issues have been resolved; for a detailed listing please check the `release milestone <https://github.com/mathjax/MathJax/issues?milestone=4&state=closed>`__.

Interface
---------
Expand Down Expand Up @@ -122,4 +122,4 @@ Misc.

* `#870 <https://github.com/mathjax/MathJax/issues/870>`__ Add Composer package information.
* `#872 <https://github.com/mathjax/MathJax/issues/872>`__ Add small delay between input and output phase to prevent performance degredation.
* `#1016 <https://github.com/mathjax/MathJax/issues/1016>`__ Fix bug related to ``<script>`` elements with namespace prefix, e.g., in xHTML.
* `#1016 <https://github.com/mathjax/MathJax/issues/1016>`__ Fix bug related to ``<script>`` elements with namespace prefix, e.g., in xHTML.

0 comments on commit 7979207

Please sign in to comment.