Release status: stable
|Description||Allows to render mathematical formulas|
|Latest version||continuous updates|
|Compatibility policy||Snapshots releases along with MediaWiki. Master is not backward compatible.|
|License||GNU General Public License 2.0 or later|
|Translate the Math extension if it is available at translatewiki.net|
|Issues||Open tasks · Report a bug|
The Math extension provides support for rendering mathematical formulae. An overview of what can currently be done with this extension is available at m:Help:Displaying a formula.
More information about installing and configuring this extension, including for older versions, can be found at Extension:Math/advancedSettings.
The Math extension tries to deliver MathML output, with fallback to images in SVG (converting characters to <path>s) or PNG (least preferentially). 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.
- 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.
- If using Vagrant, install with
vagrant roles enable math --provision
- Manual installation
- Download and place the file(s) in a directory called
- Add the following code at the bottom of your LocalSettings.php:
wfLoadExtension( 'Math' );
- 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.
- If you have problems for represent formulas when trying to use wikipedia restbase, you can try using the following patch
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
You should additionally go to the page Special:MathStatus to see whether all of the components of the Math extension now work. For any problems you see, the best option is to create a task on https://phabricator.wikimedia.org
In addition, there is a Guide for Installing and Setting up Mediawiki with Restbase and Mathoid in MW1.28.
Math output modes
The setting $wgMathValidModes holds an array with the names of output modes that can be used for rendering. If multiple modes are enabled, logged-in users can set a personal preference in the appearance pane of their user preferences page.
You can also use the $wgDefaultUserOptions setting to set which of these modes should be the default, e.g.:
$wgDefaultUserOptions['math'] = 'mathml';
You can use Mathoid, an application that uses MathJax on the server side to convert texvc input to MathML+SVG rendering. This is the most recommended option; Mathoid is the Math rendering mode used on Wikipedia.
Mathoid as a service
"Mathoid as a service" is the recommended approach for the Math extension, and the default one. If you do not add any additional settings to LocalSettings.php, Math will use the Wikimedia Mathoid and RESTBase services to do all math formula rendering. The default settings are:
// Set MathML as default rendering option $wgDefaultUserOptions['math'] = 'mathml'; $wgMathFullRestbaseURL = 'https://wikimedia.org/api/rest_'; $wgMathMathMLUrl = 'https://mathoid-beta.wmflabs.org';
You can modify these settings in order use different Mathoid and RESTBase services, potentially including your own.
Mathoid's CLI interface
You can instead run Mathoid as a command-line utility on the local server. To use this approach, the following settings are recommended:
// Set MathML as default rendering option $wgDefaultUserOptions['math'] = 'mathml'; // Please create a config.yaml in advance. Templates are in the Mathoid repository. $wgMathoidCli = ['/path/to/mathoid/cli.js', '-c', '/path/to/mathoid/config.yaml']; // Raise MediaWiki's memory limit to 1.2G for mathoid. $wgMaxShellMemory = 1228800;
Mathoid cli '/path/to/mathoid/cli.js' is not executablein the error log, you can run the following to make sure that the Apache server allows to change system limits:
setsebool -P httpd_execmem 1 setsebool -P httpd_setrlimit 1
Since MediaWiki 1.32, this mode will also require a Mathoid server to work. In older versions, it requires installing texvc and texvccheck, which may require the most setup work.
This mode will forward the Latex input without rendering, presenting it in a
<span> element, surrounded by $ :formula $.
Make sure to set $wgMathDisableTexFilter to 'always' (see below) if you only want the raw latex formula, else an error will appear due to the failed check for PNG depictions.
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 expression 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.|
The extension creates a number of tracking categories to detect errors and deprecated features. The exact name of the categories is determined by pages in the MediaWiki namespace.
|MediaWiki:Math-tracking-category-error||Category:Pages with math errors||Pages where there is a syntax error in the formula causing the rendering to fail|
|MediaWiki:Math-tracking-category-render-error||Category:Pages with math render errors||Pages where there has been a temporary error in the rendering pipeline causing the rendering to fail. These normally fix themselves|
|MediaWiki:Math-tracking-category-texvc-deprecation||Category:Pages that use a deprecated format of the math tags||Pages which use deprecated texvc syntax like |
|MediaWiki:Math-tracking-category-mhchem-deprecation||Category:Pages that use a deprecated format of the chem tags||
Deprecated chemical markup, see Extension:Math/Roadmap#Step 1 Part C: Manual fixing of mhchem syntax.
Tips and tricks
- You can use the Firefox MathML copy addon to copy formulae to other applications such as Microsoft Word (video), or Google docs with the g(Math) plugin (video)
- You can override the user preferred and default rendermode by adding the
forcemathmodeattribute to the
<math>element. e.g. to force an image being rendered
- All images of rendered formula are stored in a cache and not automatically recreated if the page is viewed or edited. To force the re-rendering of all formulas of a page, purge using the
?action=purge&mathpurge=trueaction. For example the URL https://en.wikipedia.org/w/index.php?title=Integral&action=purge&mathpurge=true will force re-rendering of the w:Integer article. Afterwards you need to bypass your browser cache so that the new created images of the formulas are actually downloaded.
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.
See Extension:Math/advancedSettings for old versions and further information.
- Math/MathJax testing
- Math/Unique Ids
- Math/math table
- Math/mathlatexml table
- Math/mathoid table
- Extension:SimpleMathJax - an alternative way to provide support for rendering mathematical formulas on-wiki, without texvc or LaTeX
- Texvc - description of texvc
- Texvc PHP Alternative
- LaTeX on a shared host
- Another alternative is to use: LaTeX with google chart
- Manual:Enable TeX/problems
|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.|
|This extension is included in the following packages and/or wiki farms:|