Math library for MediaWiki (patched)
Go to file
Frédéric Wang bfa7f5112f Remove the "best for most browsers" comment for the MathJax mode.
This is a subjective comment that was not true for everybody (trade-off
between speed & quality). Moreover, this is now an orthogonal option to enable
MathJax client-side rather than a separate rendering mode per se, so it is
confusing to compare it against the other modes. The "recommended" mode in the
future is likely to become MathML + SVG fallback (which instead uses MathJax
server-side) ; but it's probably best to keep neutral regarding the user's
preferences.

Change-Id: I5c6ff7c95cded4f06f6bfdef43dbe190e42a2968
2014-08-24 14:29:03 +02:00
db Add separate database tables for Mathoid 2014-05-27 06:53:50 +00:00
i18n Remove the "best for most browsers" comment for the MathJax mode. 2014-08-24 14:29:03 +02:00
images Convert VisualEditor Beta Feature to a normal (non-optional) plugin 2014-04-29 13:34:40 -07:00
maintenance Sanitize filesystem paths before emitting ParserTests.data. 2014-07-24 17:55:02 -04: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 Add default display options 2014-07-25 17:19:30 +00:00
tests Use public instead of var in classes 2014-08-17 22:09:06 +01:00
texvccheck Bug fix for `\varcoppa` in texvccheck 2014-07-23 16:06:48 +00:00
.gitattributes Update to MathJax 2.3 2014-01-27 21:36:02 +00:00
.gitignore Ignore local browsertest files 2014-08-14 14:50:46 +00: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.alias.php SpecialPage for MathImages 2014-06-06 17:18:30 +02:00
Math.hooks.php Add new MathHook 2014-07-23 16:09:21 +00:00
Math.i18n.php Update i18n shim 2014-04-22 13:30:23 +00:00
Math.php Update version number to 2.0 2014-07-20 15:28:54 +02: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 Add SVG generation for LaTeXML 2014-08-01 03:33:08 +02:00
MathMathML.php Improve PNG fallback 2014-07-30 19:00:57 +00:00
MathRenderer.php Fix: id-attribute 2014-07-25 17:18:45 +00:00
MathSource.php Separate render and getHtml 2014-06-09 23:21:44 +02:00
MathTexvc.php Separate render and getHtml 2014-06-09 23:21:44 +02: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
SpecialMathShowImage.php Improve PNG fallback 2014-07-30 19:00:57 +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.