Release status: stable
|Description||Allows to render mathematical formulas|
|Author(s)||Tomasz Wegrzanowski, Brion Vibber and others|
|Latest version||continuous updates|
|License||GNU General Public License 2.0|
Translate the Math extension if it is available at translatewiki.net
|Check usage and version matrix;|
|Open tasks · Report a bug|
The Math extension provides support for rendering mathematical formulæ. An overview of what can currently be done with this extension is found at the English Wikipedia's documentation.
This article documents how to install, configure and test recent versions of this extension. For advanced usages and documentation of old versions refer to Extension:Math/advancedSettings.
The Math extension tries to deliver MathML output, with fallback to SVG or PNG images respectively. Depending on the capabilities of the device you are using, the sort of output is chosen. Basic math support works for all browsers. However, for optimal rendering specific tuning may be needed:
- For Firefox or other Gecko browsers, it is required to install the Native MathML extension and math fonts. Accessibility support is provided by NVDA, VoiceOver or Orca. Additionally, NVDA requires the MathPlayer plugin to read mathematics.
- For Safari or other WebKit browsers, you may also install math fonts and enable native MathML rendering by inserting some CSS rules into the custom style sheet of your browser preference. Accessibility support is provided by the VoiceOver screen reader but not by Orca yet.
- For Chrome you must insert some CSS rules into the custom style sheet of your browser preference in order to get accessibility support via ChromeVox or visual rendering via the MathJax plugin.
- In some versions of Internet Explorer, it is possible to use MathPlayer as an assistive technology.
Tips and tricks
- You can use the MathML copy addon to copy formulae to other applications such as Mircosoft Word (video), or Google docs with the g(Math) plugin (video).
- If using Vagrant, install with
vagrant enable-role math && vagrant provision
- Manual installation
- Download and place the file(s) in a directory called
- Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/Math/Math.php"; // See below for installation requirements and configuration settings:
- Run the update script which will automatically create the necessary database tables that this extension needs.
- To see math beyond a plain text output, follow instructions below for enabling various math output modes.
- Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Beginning from MW 1.23+ you can use a Mathoid server that uses MathJax to convert texvc input on the server side to MathML+SVG rendering. Mathoid is the rendering mode that is going to be used on future Wikipedia. For that the following settings are recommended:
// Set MathML as default rendering option $wgDefaultUserOptions['math'] = 'mathml'; $wgMathFullRestbaseURL= 'https://api.formulasearchengine.com/';
Check out Mathoid to find instructions how to run your own Mathoid server.
Test your installation
Navigate to https://en.wikipedia.org/wiki/Special:MathStatus where you should replace en.wikipedia.org with the hostname of your wiki. If that does not work create a task on https://phabricator.wikimedia.org
List of significant configuration settings
|Setting name||Default value||Description|
||Defines the mode allowed on the server.|
||Option to disable the tex filter. If set to true any LaTeX espression is parsed this can be a potential security risk. If set to false only a subset of the TeX commands is allowed. See the wikipedia page Help:Math for details. Use "always" to disable this feature.|
|$wgMathFullRestbaseURL||false||The math extension gets the default config from the Visual Editor, if available. Details|
Purging pages that contain equations
Specifying the URL-parameter action=purge does not force the math equation to re-render the math tags. If a complete re-rendering of the math tags is desired the URL-parameter action=purge&mathpurge=true has to be passed. Be aware that this might cause side effects with other pages since the math extension uses the hash of the input TeX-input-string as the caching key. e.g. if you would force the re-rending with mathpurge option for a page containing the equation
$E=mc^2$, the new rendering result would be used on all other pages containing
$E=mc^2$ after the individual page caches are invalidated.
If something is wrong with the math extension you can report that at Phabricator. In addition you should check how your problem relates to the automated unit tests that are generated from the page CoverageTest.
The Math extension can do much more, beside the basics described here. Check out Extension:Math/advancedSettings for old versions and further information.
|This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page.|