Math library for MediaWiki (patched)
Go to file
Frédéric Wang a586c80083 Revome useless MathJax files added in Ib7f2e4b8eb7250ea4fc24aac3cedf196211f38c2
These files were added in but the change was totally unrelated to the
AsciiMath issue mentioned there and moreover this commit bypassed review.
These entity references are useless for LaTeXML
(which does not generate entity names), for the client-side MathJax
(which does not use MathML input) and for mathoid (which uses
phantomjs=webkit and thus already parses the HTML5 entity names correctly).
Finally, these files are likely to disappear in future MathJax versions.
So let's remove these files until it is clear what the intention was.

Change-Id: Iee875632411b98d1e86d3bb10f69ae3797105de7
2014-05-08 08:47:04 +02:00
db Remove db2 support, core MW did this a while ago 2014-01-02 15:13:45 +00:00
i18n i18n: Fix MediaWiki.org URL 2014-05-05 14:30:43 +09:00
images Convert VisualEditor Beta Feature to a normal (non-optional) plugin 2014-04-29 13:34:40 -07:00
maintenance Fix: Allow <div /> as valid Math output 2014-04-08 16:13:28 +00:00
math Remove $wgUseTeX 2014-01-26 00:07:16 +00:00
mathoid Separate Mathoid from the Math extension 2014-02-10 18:28:08 +00:00
modules Revome useless MathJax files added in Ib7f2e4b8eb7250ea4fc24aac3cedf196211f38c2 2014-05-08 08:47:04 +02:00
tests Fix: Allow <div /> as valid Math output 2014-04-08 16:13:28 +00:00
texvccheck Breakdown of texvc 2013-12-14 18:34:15 +00:00
.gitattributes Update to MathJax 2.3 2014-01-27 21:36:02 +00:00
.gitignore Revome useless MathJax files added in Ib7f2e4b8eb7250ea4fc24aac3cedf196211f38c2 2014-05-08 08:47:04 +02:00
.gitreview Adding .gitreview 2012-03-23 10:30:45 -07:00
.jshintignore Adding mathoid as tex to MathML and SVG renderer 2013-10-04 17:03:34 -07:00
COPYING Add COPYING 2014-03-01 16:15:39 +00:00
Makefile Makefile in root directory 2014-01-28 20:55:48 +01:00
Math.hooks.php Catch misconfiguration of math default option 2014-05-06 11:59:02 +00:00
Math.i18n.php Update i18n shim 2014-04-22 13:30:23 +00:00
Math.php Convert VisualEditor Beta Feature to a normal (non-optional) plugin 2014-04-29 13:34:40 -07:00
MathInputCheck.php Validate TeX input for all renderers, not just texvc 2014-01-22 10:07:27 +00:00
MathInputCheckTexvc.php Coverage tests for the Math extension 2014-03-11 15:35:07 +00:00
MathLaTeXML.php Fix: Allow <div /> as valid Math output 2014-04-08 16:13:28 +00:00
MathRenderer.php $wgMathValidModes and orthogonal MathJax enabler 2014-04-08 15:29:42 +00:00
MathSource.php Fix MathJax centers equations 2014-04-06 21:58:30 +00:00
MathTexvc.php Fix MathJax centers equations 2014-04-06 21:58:30 +00:00
README Fix MathJax centers equations 2014-04-06 21:58:30 +00:00
RELEASE-NOTES-2.0 $wgMathValidModes and orthogonal MathJax enabler 2014-04-08 15:29:42 +00:00
mathParserTests.txt Coverage tests for the Math extension 2014-03-11 15:35:07 +00:00

README

This version (for MediaWiki 1.19) has some changes since previous versions:

* rendering options have been reduced to just 'Always PNG' and 'Leave it as TeX'
** all other rendering options will merge to PNG.
* initial experimental support for integrating MathJax client-side rendering

See the README in the math subdirectory for more info on setting up the
low-level conversion tools.
See the README in the texvccheck subdirectory for more info on setting up the
security checking tools for MathJax and LaTeXML.

MathML support:
If you prefer MathML rather than images you can use LaTeXML to convert the
math tags to MathML. To use that feature you have to enable LaTeXML by setting
$wgMathUseLaTeXML = true;
It is possible to choose LaTeXML as default option (for anonymous user) by setting
$wgDefaultUserOptions['math'] = MW_MATH_LATEXML;
in the LocalSettings.php file.
The LaTeXML option requires php5-curl to be installed. Without php5-curl no proper
error handling can be guaranteed.
Furthermore, a core version of wmf/1.22wmf7 or newer is recommended.
Otherwise, errors in LaTeXML can lead to mal-formatted XML output and disturb the
page layout.

MathJax configuration:
Client-side configuration of MathJax can be done by specifying a mathJax.config
table, which takes a table as described in:
http://docs.mathjax.org/en/v1.1-latest/options/index.html#configuration

Example:
if ( typeof mathJax === 'undefined' ) {
  mathJax = {};
  mathJax.config = {
    showProcessingMessages: true
  };
}

Attributes of the <math /> element:
attribute "display":
possible values: "inline", "block" or "inline-displaystyle" (default)

"display" reproduces the old texvc behavior:
The equation is rendered with large height operands (texvc used $$ $tex $$ to render)
but the equation printed to the current line of the output and not centered in a new line.
In Wikipedia users use :<math>$tex</math> to move the math element closer to the center.

"inline" renders the equation in with small height operands by adding {\textstyle $tex } to the
users input ($tex). The equation is displayed in the current text line.

"inline-displaystyle" renders the equation in with large height operands centered in a new line by adding
{\displaystyle $tex } to the user input ($tex).


For testing your installation run
php tests/phpunit/phpunit.php extensions/Math/tests/
from your MediWiki home path.