Wiki
Clone wikiKeysight Plugins For Atlassian Products / Confluence Plugins / MathJax Plugin
Introduction
The MathJax contains a pair of macros to insert a nicely rendered equation onto the page using the MathJax Javascript library. As the heavy lifting is performed by a Javascript library when viewed in the readers webbrowser, these macro will not render nicely for Word or PDF output.
The plugin has a configuration page allowing Confluence administrators to set the Content Delivery Network url. By it's very nature, this allows the Confluence Admin to lock onto a particular version of the library.
Version 3.x of the MathJax Confluence app requires version 3.x of the MathJax library. Please check and make sure a 3.x version of the MathJax library is pointed to via the app configuration page.
Features at a Glance
| Feature | Description |
|---|---|
| MathJax Inline Equation Macro | Inserts an equation inline with other text. |
| MathJax Block Equation Macro | Inserts an equation into it's own block. |
Features in Detail
Mathjax Inline Equation Macro
Description
This is a macro to insert a nicely rendered equation inline with text, such as in a paragraph, on the page.
Usage
To use the macro, insert the macro using the normal Confluence methods, then enter the equation in Latex format into the Equation macro parameter.
| Parameters | Description |
|---|---|
| Equation | The equation in latex format. |
Purpose
To place equations on to pages.
Notes
When inserting latex content, such as \sqrt{a}, Confluence can get confused
and report Unknown macro: 'a'. This is because it's picking up the {a}
in the html attributes of the macro and thinking you are trying to use the
old-school confluence macro syntax {}. I've not found a way to prevent this
behavior presently, but it only seems to impact the view of the macro in the
editor, so it seems like a bug that can be lived with.
Mathjax Block Equation Macro
Description
This is a macro to insert a nicely rendered equation into it's own block on the page.
Usage
To use the macro, insert the macro using the normal Confluence methods. The macro has no parameters, so there is nothing to adjust. In the body of the macro insert the equation using Latex format. When the page is rendered, the equation will be transformed by the MathJax javascript library into a beautify rendered equation. then adjust the parameters as needed.
Purpose
To place equations on to pages.
Updated