Phabricator project: #Math

# Extension:Math

(Redirected from Manual:Enable TeX)

Other languages:
català • ‎Deutsch • ‎English • ‎español • ‎suomi • ‎français • ‎italiano • ‎日本語 • ‎한국어 • ‎polski • ‎português • ‎português do Brasil • ‎sicilianu • ‎Tiếng Việt • ‎中文
MediaWiki extensions manual
Math

Release status: stable

Implementation Tag
Description Allows to render mathematical formulas
Author(s) Tomasz Wegrzanowski, Brion Vibber and others
MediaWiki 1.23+
Database changes Yes
Tables math
mathoid
mathlatexml
Parameters
• $wgUseTeX •$wgTexvc
• $wgTexvcBackgroundColor •$wgMathCheckFiles
• $wgMathPath •$wgMathDirectory
• $wgMathFileBackend Tags [itex] Translate the Math extension if it is available at translatewiki.net Check usage and version matrix. 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 found at the English Wikipedia's documentation. This extension was part of core MediaWiki until MediaWiki version 1.18. More information about installing and configuring this extension, including for older versions, can be found at Extension:Math/advancedSettings. ## Viewing math 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 Safari or other WebKit browsers, you may also install math fonts and enable native MathML rendering by [[<tvar|ext>Special:MyLanguage/Extension:Math/advancedSettings#CSS for the MathML with SVG fallback mode</>|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. ## Installation • If using Vagrant, install with vagrant roles enable math -p ### Manual installation • Download and place the file(s) in a directory called Math in your extensions/ folder. • Add the following code at the bottom of your LocalSettings.php: wfLoadExtension( 'Math' ); // 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. To users running MediaWiki 1.24 or earlier: The instructions above describe the new way of installing this extension using wfLoadExtension() If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of wfLoadExtension( 'Math' );, you need to use: require_once "$IP/extensions/Math/Math.php";


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

Unfortunately, there is no well tested guide on installing Mathoid and Restbase to work with the Math extension, but there is at least a working draft. Extension:Math/Restbase please contribute.

## 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.:

### No rendering

Mode: 'source', (pre-July 2015: MW_MATH_SOURCE)

This mode will forward the Latex input without rendering, presenting it in a <span> element, surrounded by $:formula$.

Make sure to set $wgMathFullRestbaseURL 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. ### MathJax Mode: MW_MATH_MATHJAX This mode uses the MathJax application for client-side rendering. It is now deprecated, and requires MediaWiki 1.25 or lower in order to run. See Client-side rendering with MathJax for how to use it. ## List of significant configuration settings Setting name Default value Description$wgMathValidModes array( 'png', 'source', 'mathml' ) Defines the mode allowed on the server.
$wgMathDisableTexFilter 'never' 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

## Forcing a re-render of 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.

## Error reporting

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.