Math library for MediaWiki (patched)
Go to file
C. Scott Ananian 209f3218ad Regularize spacing in `texvc` and `texvccheck`
Tweak the position of spaces between function invocations and arguments
so that the expansion of mediawiki-specific functions (`\Rho`, etc) is
consistent with how spacing is added to normal function invocations.

This helps ensure that `texvc`/`texvccheck` is idempotent -- that is,
that it can parse what it emits, and render it without change.

Change-Id: I05fc8fa0201debf611ed4900d3cc953a6a8188ac
2014-10-12 22:04:41 +02:00
db Add separate database tables for Mathoid 2014-05-27 06:53:50 +00:00
i18n Localisation updates from https://translatewiki.net. 2014-10-08 21:26:18 +02:00
images Convert VisualEditor Beta Feature to a normal (non-optional) plugin 2014-04-29 13:34:40 -07:00
maintenance MathCoverageTest: encode test file using JSON instead of PHP serialize. 2014-10-12 18:02:50 +00:00
math Regularize spacing in `texvc` and `texvccheck` 2014-10-12 22:04:41 +02:00
mathoid Separate Mathoid from the Math extension 2014-02-10 18:28:08 +00:00
modules Move vertical-align back to ext.math.css 2014-10-12 18:22:06 +00:00
tests Move vertical-align back to ext.math.css 2014-10-12 18:22:06 +00:00
texvccheck Regularize spacing in `texvc` and `texvccheck` 2014-10-12 22:04:41 +02: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 Rename fallback-svg and fallback-png to fallback-image 2014-10-12 13:42:01 +02:00
Math.i18n.php Update i18n shim 2014-04-22 13:30:23 +00:00
Math.php Fine grained options for wgMathDisableTeXFilter 2014-10-10 18:27:04 +00: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 Avoid unnecessary database reads 2014-09-06 02:34:30 +00:00
MathMathML.php Rename fallback-svg and fallback-png to fallback-image 2014-10-12 13:42:01 +02:00
MathRenderer.php Avoid calling readFromDatabase in source mode 2014-10-11 16:41:38 +02:00
MathSource.php Avoid calling readFromDatabase in source mode 2014-10-11 16:41:38 +02:00
MathTexvc.php Move vertical-align back to ext.math.css 2014-10-12 18:22:06 +00: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 Revert "Bug 70119: Strip style from SVG image" 2014-10-10 01:01:13 +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.