MathWrap for Confluence

User guide

MathWrap renders maths written as $…$ and $$…$$ in ordinary Confluence pages. This guide covers everything the app does. If something here does not match what you see, email support@piptim.com.

Writing formulas

Type or paste maths straight into the normal Confluence editor, the way Markdown, Jupyter and AI assistants already write it:

Formulas use LaTeX maths syntax as supported by KaTeX (https://katex.org/docs/supported), including environments such as aligned, cases and matrices.

Converting a page

  1. Publish the page as usual.
  2. Open the page menu (•••) and choose Math: wrap / unwrap $ formulas, or press Ctrl+Shift+M (Cmd+Shift+M on Mac).
  3. Press Wrap $ into formulas.

The page refreshes and every formula is rendered. A short report tells you how many formulas were converted, confirms that none were left behind as text, and lists anything that was deliberately skipped. Running Wrap again later converts only the text you have added since.

Each run saves one new page version, so you can always roll back from the page history. Avoid running it while someone else has the page open for editing.

What is left alone

MathWrap follows the same rules as Markdown maths, so ordinary dollar signs are safe:

Editing formulas

One formula: open the page for editing, select the formula, and choose the edit (pencil) icon. A TeX editor opens with a live preview. Press Save, or Ctrl+Enter / Cmd+Enter.

Many formulas at once: press Unwrap formulas into $ in the same menu. Every formula turns back into the exact $…$ text it came from. Edit the text freely, publish, then Wrap again.

You can also insert a formula by hand: type / in the editor and choose Inline Math or Block Math.

Automatic conversion (space administrators)

A space administrator can have pages converted as soon as they are published, so nobody has to open the menu:

  1. Go to the space's Space settings and open the MathWrap tab.
  2. Switch on Convert formulas automatically when a page is published.

Conversion usually happens within a few seconds of publishing, sometimes up to about half a minute. The new page version is recorded as made by the app. Automatic conversion is off by default, and switching it off later leaves already-converted formulas in place.

Exporting to PDF and Word

Confluence's own Export to PDF and Export to Word include every formula as a typeset, vector-drawn image. No extra step is needed and nothing is attached to your page.

Moving from another maths app

If a page contains formulas from LaTeX Math by Appfire or LaTeX Math+ by Narva, the MathWrap menu says so and offers two choices:

Numbered-equation references from LaTeX Math are recognised but not converted, because turning a reference into a formula would change what the page says. The report lists them so you can decide.

Licensing

If the app's licence lapses, the Wrap, Unwrap and migration actions and the automatic-conversion setting are disabled. Formulas already on your pages keep rendering.

Leaving MathWrap

Formulas are stored in your pages as MathWrap macros. If you uninstall the app, Confluence can no longer draw them. To leave cleanly:

  1. On each page with formulas, run Unwrap formulas into $. The page goes back to plain $…$ text that needs no app.
  2. Then uninstall.

Settings the app keeps (the automatic-conversion switch per space) are deleted by Atlassian within 28 days of uninstalling. See the privacy policy.

Getting help

See Support — or email support@piptim.com. Security issues: Security.