Phabricator project: #Math

Extension:Math

From MediaWiki.org
Jump to: navigation, search
Translate this page; This page contains changes which are not marked for translation.

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 manualManual:Extensions
Crystal Clear action run.png
Math

Release status:Extension status stable

ExtensionMath.png
ImplementationTemplate:Extension#type Tag
DescriptionTemplate:Extension#description Allows to render mathematical formulas
Author(s)Template:Extension#username Tomasz Wegrzanowski, Brion Vibber and others
Latest versionTemplate:Extension#version continuous updates
MediaWikiTemplate:Extension#mediawiki 1.19+
Database changesTemplate:Extension#needs-updatephp Yes
TablesTemplate:Extension#table1 math
mathoid
mathlatexml
LicenseTemplate:Extension#license GNU General Public License 2.0
Download
ParametersTemplate:Extension#parameters
  • $wgUseTeX
  • $wgTexvc
  • $wgTexvcBackgroundColor
  • $wgMathCheckFiles
  • $wgMathPath
  • $wgMathDirectory
  • $wgMathFileBackend
TagsTemplate:Extension#tags
<math>
Hooks usedTemplate:Extension#hook
ParserFirstCallInit
GetPreferences
LoadExtensionSchemaUpdates
ParserTestTables
ParserTestParser
UnitTestsList

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 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/advancedSettingsExtension:Math/advancedSettings.

Viewing math[edit]

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:

Tips and tricks[edit]

Installation[edit]

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:
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.
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.


Configuration[edit]

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[edit]

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[edit]

Setting name Default value Description
$wgMathValidModes array( 'png', 'source', 'mathml' ) Defines the mode allowed on the server.
$wgMathDisableTexFilterManual:$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

Purging pages that contain equations[edit]

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[edit]

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.

Further readingExtension:Math/advancedSettings[edit]

The Math extension can do much more, beside the basics described here. Check out Extension:Math/advancedSettingsExtension:Math/advancedSettings for old versions and further information.

See also[edit]