Math library for MediaWiki (patched)
Go to file
Translation updater bot 5477d44323 Localisation updates from https://translatewiki.net.
Change-Id: I441bbee800381bdf2919dc26de1d77b17493cc1f
2015-07-25 21:57:18 +02:00
db Increase size of the math_mathml in the mathlatexml table 2014-11-18 12:42:27 +01:00
i18n Localisation updates from https://translatewiki.net. 2015-07-25 21:57:18 +02:00
images Convert VisualEditor Beta Feature to a normal (non-optional) plugin 2014-04-29 13:34:40 -07:00
maintenance Merge "Minor clean up, optimisations and documentation corrections" 2015-01-22 19:39:56 +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 Remove client-side MathJax support 2015-07-16 00:46:29 +00:00
tests Remove useless debug functionality 2015-07-14 10:34:37 -04:00
texvccheck Fix perl script permissions and shebang 2015-07-01 13:27:22 +00:00
.gitattributes Update to MathJax 2.3 2014-01-27 21:36:02 +00:00
.gitignore Remove client-side MathJax support 2015-07-16 00:46:29 +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
.rubocop.yml Prepare repository for running RuboCop after every push to Gerrit 2014-10-21 15:04:22 +02:00
.rubocop_todo.yml Prepare repository for running RuboCop after every push to Gerrit 2014-10-21 15:04:22 +02:00
COPYING Add COPYING 2014-03-01 16:15:39 +00:00
Gemfile Prepare repository for running RuboCop after every push to Gerrit 2014-10-21 15:04:22 +02:00
Gemfile.lock QA: update Ruby gems 2014-11-07 08:53:58 -07:00
Gruntfile.js build: Configure banana-checker and jsonlint 2015-06-19 21:54:10 -07:00
Makefile Makefile in root directory 2014-01-28 20:55:48 +01:00
Math.alias.noTranslate.php Move integration tests to a new special page 2015-03-30 11:47:31 -04:00
Math.alias.php Localisation updates from https://translatewiki.net. 2015-04-30 22:19:51 +02:00
Math.hooks.php Remove client-side MathJax support 2015-07-16 00:46:29 +00:00
Math.php Merge "Remove client-side MathJax support" 2015-07-19 19:44:54 +00:00
MathInputCheck.php Validate TeX input for all renderers, not just texvc 2014-01-22 10:07:27 +00:00
MathInputCheckTexvc.php Use namespaced \MediaWiki\Logger\LoggerFactory 2015-04-16 07:33:29 +00:00
MathLaTeXML.php Remove useless debug functionality 2015-07-14 10:34:37 -04:00
MathMathML.php Fix: Undefined variable passed to hook 2015-07-16 10:33:34 -04:00
MathRenderer.php Remove useless debug functionality 2015-07-14 10:34:37 -04:00
MathSource.php MWException -> Exception 2015-01-09 17:55:54 -08:00
MathTexvc.php Pass arguments to ParserAfterParse by reference 2015-07-22 15:36:48 +00:00
README Update to PSR-3 logging 2015-03-18 17:26:01 +00:00
RELEASE-NOTES-2.0 $wgMathValidModes and orthogonal MathJax enabler 2014-04-08 15:29:42 +00:00
SpecialMathShowImage.php Remove useless debug functionality 2015-07-14 10:34:37 -04:00
SpecialMathStatus.php Replace deprecated $wgSpecialPageGroups 2015-05-16 12:37:42 +02:00
mathParserTests.txt Coverage tests for the Math extension 2014-03-11 15:35:07 +00:00
package.json build: Configure banana-checker and jsonlint 2015-06-19 21:54:10 -07: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.

== Logging ==
The math extension supports PSR-3 logging:
Configuration can be dona via
$wgDebugLogGroups['Math'] = array( 'level' => 'info', 'destination' => '/path/to/file.log' );