Extension:SimpleMathJax

From Linux Web Expert

Revision as of 09:27, 27 January 2024 by imported>Tepid b (For the purpose of simply downloading the extension, it is better to do a shallow clone. Otherwise, the entire revision history gets downloaded, which is not useful as far as running the extension is concerned and takes up MUCH more space.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

MediaWiki extensions manual
File:OOjs UI icon advanced-invert.svg
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.4 (2023-11-04)
MediaWiki 1.29+[1]
Database changes No
License MIT License
Download

GitHub:

<translate> Note:</translate>
<translate> No [[<tvar name=1>Special:MyLanguage/Localisation#Translation resources</tvar>|localisation]] updates are
provided by <tvar name=twn>translatewiki.net </tvar>.</translate>


README
Example zetawiki.com
Parameters

  • $wgSmjUseCdn
  • $wgSmjUseChem
  • $wgSmjDisplayMath
  • $wgSmjExtraInlineMath
  • $wgSmjScale
  • $wgSmjEnableMenu
  • $wgSmjDisplayAlign
  • $wgSmjWrapDisplaystyle
Hooks used
Quarterly downloads Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').
Public wikis using Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').

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.

Installation

Or you can git clone. 

$ git clone --depth 1 https://github.com/jmnote/SimpleMathJax.git

If you want to use local MathJax scripts (and not a CDN), then you can use git clone recursive. In most cases, CDN is much faster than your server. However, a CDN may not be available if you have a hardened PHP installation due to disabled_functions restrictions. 

$ git clone --depth 1 --recursive --shallow-submodules 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 settings

The following variables can be defined in LocalSettings.php after calling wfLoadExtension( 'SimpleMathJax' );. Note that for a simple site adding $wgSmjScale = 1.1; might be all you need to make it Just Work™.

Version Setting name Default value Description
0.7.0+ $wgSmjUseCdn true Using CDN or Local resource
0.7.0+ $wgSmjUseChem true enable ‎<chem> tags
( defaults to use chem tags )
0.8.0+ $wgSmjEnableMenu true Make MathJax context menu available
This setting is missed since 0.8.0; it would be a mistake
0.8.0+ $wgSmjExtraInlineMath [] can add some additional inlineMath symbols pairs
0.8.1+ $wgSmjScale 1 The default font size for SimpleMathJax
0.7.4 $wgSmjShowMathMenu false <translate> (removed)</translate>
(replaced by $wgSmjEnableMenu)
0.6.1 $wgSmjSize 110 <translate> (removed)</translate>
(replaced by $wgSmjScale)
0.6.1 $wgSmjInlineMath [] <translate> (removed)</translate>
(replaced by $wgSmjExtraInlineMath)
0.6.1 $wgSmjDisableChem false <translate> (removed)</translate>
(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'] 		<translate> (removed)</translate>
(replaced by $wgSmjUseCDN)
can use local or another remote scripts
( defaults to use cloudflare CDN )
0.6 $wgSimpleMathJaxSize 125 <translate> (removed)</translate>
(replaced by $wgSmjSize)
0.6 $wgSimpleMathJaxUseCDN true <translate> (removed)</translate>
(replaced by $wgSmjScripts)
0.6 $wgSimpleMathInlineMath [] <translate> (removed)</translate>
(replaced by $wgSmjInlineMath)

If you want to change font size, set $wgSmjScale like below. 

wfLoadExtension( 'SimpleMathJax' );
$wgSmjScale = 1.5;

If you want to enable some additional inlineMath symbol pairs, set $wgSmjExtraInlineMath like below. 

wfLoadExtension( 'SimpleMathJax' );
$wgSmjExtraInlineMath = [ [ "$", "$" ], [ "\\(", "\\)" ] ];

If you want to use local module, set $wgSmjUseCdn like below. 

wfLoadExtension( 'SimpleMathJax' );
$wgSmjUseCdn = false;

SimpleMathJax and Live Preview (versions < 0.8.0)

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);

Samples

Comparison
More examples

See also

External links

  1. ↑ SimpleMathJax 0.8.0+ uses manifest_version 2. Manual:Extension.json/Schema
Retrieved from "https://www.linuxwebexpert.com/wiki/index.php?title=Extension:SimpleMathJax&oldid=15638"