Extension:SimpleMathJax
SimpleMathJax Release status: stable |
|
---|---|
Implementation | Tag |
Description | Allows to render mathematical formulas using MathJax with MediaWiki math style |
Author(s) | jmnote, vedmaka, jamesmontalvo3, badshah400 |
Latest version | 0.8.1 (2020-10-23) |
MediaWiki | 1.29+[1] |
Database changes | No |
License | GNU General Public License 3.0 |
Download | GitHub: Note: README |
Example | zetawiki.com |
|
|
The SimpleMathJax extension enables MathJax, a JavaScript library, for typesetting TeX formula in MediaWiki inside math environments.
This extension will load resources from cdn.jsdelivr.net
on all wiki pages that have math or chem tags.
<math>E=mc^2</math>
- Advantages
- Simple
- Lightweight
- UTF-8 Support
- Mobile View OK
- Setting Font Size
- chem tag support for chemistry
- additional inlineMath symbols pairs support
- MediaWiki Style! Look at the samples.
InstallationEdit
- Download and place the file(s) in a directory called
SimpleMathJax
in yourextensions/
folder. - Add the following code at the bottom of your LocalSettings.php:
wfLoadExtension( 'SimpleMathJax' );
- If necessary configure at your convenience
- 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( 'SimpleMathJax' );
, you need to use:
require_once "$IP/extensions/SimpleMathJax/SimpleMathJax.php";
Or you can git clone.
$ git clone https://github.com/jmnote/SimpleMathJax.git
If you want to use not CDN but local mathjax scripts, you can use git clone recursive. ( In most cases, CDN is much faster than your server. )
$ git clone --recursive https://github.com/jmnote/SimpleMathJax.git
SimpleMathJax is meant to be used as an alternative to the Math extension. If the Math extension is installed it may take precedence and cause SimpleMathJax to not work. The SimpleMathJax extension is the only thing you need to start rendering equations.
Configuration settingsEdit
The following variables can be defined in LocalSettings.php after calling wfLoadExtension( 'SimpleMathJax' );
. Note that for a simple site adding $wgSmjSize = 110;
might be all you need to make it Just Work™.
Version | Setting name | Default value | Description |
---|---|---|---|
0.6.1+ | $wgSmjSize | 110
|
The default font size for SimpleMathJax |
0.6.1+ | $wgSmjInlineMath | []
|
can add some additional inlineMath symbols pairs |
0.7.0+ | $wgSmjUseCDN | true
|
Using CDN or Local resource |
0.7.0+ | $wgSmjUseChem | true
|
enable <chem> tags( defaults to use chem tags ) |
0.7.4+ | wgSmjShowMathMenu | false
|
Make MathJax context menu available |
0.6.1 | $wgSmjDisableChem | false | removed (replaced by $wgSmjUseChem) |
0.6.1 | $wgSmjScripts | ['//cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js?config=TeX-AMS-MML_HTMLorMML', '//cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/extensions/TeX/mhchem.js'] |
removed (replaced by $wgSmjUseCDN) can use local or another remote scripts ( defaults to use cloudflare CDN ) |
0.6 | $wgSimpleMathJaxSize | 125 | removed (replaced by $wgSmjSize )
|
0.6 | $wgSimpleMathJaxUseCDN | true | removed (replaced by $wgSmjScripts )
|
0.6 | $wgSimpleMathInlineMath | [] | removed (replaced by $wgSmjInlineMath )
|
If you want to change font size, set $wgSmjSize
like below.
wfLoadExtension( 'SimpleMathJax' );
$wgSmjSize = 150;
If you want to enable some additional inlineMath symbol pairs, set $wgSimpleMathJaxInlineMath
like below.
wfLoadExtension( 'SimpleMathJax' );
$wgSmjInlineMath = [ [ "$", "$" ], [ "\\(", "\\)" ] ];
If you want to use local module, set $wgSmjUseCDN like below.
wfLoadExtension( 'SimpleMathJax' );
$wgSmjUseCDN = false;
Making SimpleMathJax work with live preview (versions < 0.8.0)Edit
Prior to version 0.8.0, the following had to be added to MediaWiki:Common.js in order to have the live preview in the editor show rendered math output instead of raw LaTeX source code:
function waitForMathJax($content) {
if (typeof MathJax === 'undefined') {
setTimeout(function () { waitForMathJax($content); }, 1000);
} else {
MathJax.Hub.Queue(["Typeset", MathJax.Hub, $content[0]]).execute();
}
}
mw.hook('wikipage.content').add(waitForMathJax);
SamplesEdit
- Comparison
- en:user:Jmkim dot com/TeX Samples (rendering with wikipedia math engines, English)
- ko:user:Jmkim dot com/TeX 샘플 (rendering with wikipedia math engines, Korean)
- http://zetawiki.com/wiki/TeX_샘플 (rendering with SimpleMathJax)
- More examples
- http://zetawiki.com/wiki/TeX_문법 (Grammar)
- http://zetawiki.com/wiki/TeX_행렬 (Matrix)
- http://zetawiki.com/wiki/TeX_특수문자 (Special Characters)
- http://zetawiki.com/wiki/Mhchem_테스트 (chem tags)
See alsoEdit
External linksEdit
- ↑ SimpleMathJax 0.8.0+ uses manifest_version 2. Manual:Extension.json/Schema