Confluence Plugin MathJax

ByGeorge Lewe Updated on

Confluence Plugin MathJaxThe Confluence Plugin MathJax makes MathJax available in your Confluence wiki. Must I say more? From within your Confluence editor you can access MathJax functions to display mathematic formulars on your Confluence page. The plugin was developed by David A.W. Barton (davebarton @ cityinthesky.co.uk).

However, his last release is not compatible anymore with Confluence 7.x. We have created an updated release that is. Find it here…

The new release 2.7 also comes in a CHTML version.

What is Confluence ?

I happen to be involved in the administration and operation of Atlassian applications. Confluence is Atlassian’s awesome Enterprise Wiki. I you haven’t heard of or used it yet, check it out. You can download a trial version right from their web site here: https://www.atlassian.com/software/confluence.

What is a Confluence Plugin ?

Most Atlassian products offer a plugin API that encourages developers to create uesful plugins for the application. In fact, these plugins make Confluence or JIRA for example even more amazing. Atlassian distributes those (and their own) plugins through their Marketplace. They are easy to install through the applications Plugin interface and gives you control over exactly those add-ons that you need.

What is MathJax ?

Confluence Plugin MathJaxMathJax is an open source JavaScript display engine for mathematics that works in all browsers. It renders mathematical formulars just beautifully right in your browser so there is no more need to install plugins or readers of any kind to visualize Albert Einstein’s work on your website. Check out the MathJax website for details.

What is the Confluence Plugin MathJax ?

The Confluence Plugin MathJax makes MathJax available in your Confluence wiki. Must I say more? From within your Confluence editor you can access MathJax functions to display mathematic formulars in your Confluence page. The plugin was developed by David A.W. Barton (davebarton @ cityinthesky.co.uk). All credits go to him for this awesome implementation.

His description of the plugin is this:

This plugin provides a thin wrapper around MathJax http://www.mathjax.org/ to enable equations to be entered in Latex notation. MathJax is an open source JavaScript display engine for mathematics that works in all modern browsers.

Two macros for Confluence are provided: mathinline and mathdisplay. They both accept mathematics in Latex notation and output either an inline equation (within the main text) or a displayed equation (separate from the main text, typically centered on the page). AMSmath extensions for Latex are also enabled.

You can download the original (built with mathjax 1.1) binaries from here:
https://github.com/db9052/confluence-mathjax/downloads
You will find the source code there too.

The Compatibility Thing

Like with most application plugins, their functionality stands and falls with their compatibility to the mother application. Once Atlassian updates Confluence, there is a chance that your plugins won’t work anymore. Exactly that happened with Conflunce 5.3 that rendered the Confluence Plugin MathJax incompatible with that version.

Fortunately, the Confluence Plugin MathJax plugin is Open Source software and subject to adjustments by other developers. Since we are using the plugin we have just done that and would like to provide the updated version of this plugin for you here.

We have tested it successfully with up to Confluence version 7.19.3 so far (Server, Data Center).

The Updated Plugin

The plugin you can download from here has the following small changes:

  • Mathjax javascript library was changed to the latest v2.4
  • Mathjax configuration slightly altered to enable equation numbering. autonumber: “AMS”
  • Plugin pom.xml was changed to be compiled for Confluence (5.3 – 5.6)
  • Inline equations now work with Confluence 5.5.6 and higher

You can read more on equation numbering here:
http://docs.mathjax.org/en/latest/tex.html#automatic-equation-numbering
http://docs.mathjax.org/en/latest/options/TeX.html

Installation Instructions

  • Download the zip file (see link below)
  • Extract the jar file
  • Install into Confluence with the UPM (Universal Plugin Manager)

Download

Download “Confluence MathJax Plugin” mathjax2.7.zip | 18.21 MB | 2020-06-17 | 3293

Download “Confluence MathJax Plugin CHTML” mathjax2.7_chtml.zip | 2.20 MB | 2020-06-18 | 1557

Similar Posts