Conversion from another LaTeX addon

There are several deprecated or unsupported LaTeX add-ons for Confluence. Please see below for some examples on how to migrate their macros to LaTeX Math.

Step-by-step guide

We will convert the old macros by using user macros. For more information on how to create user macros, see here.

  1. Install LaTeX Math.
  2. On the Manage Add-ons page, disable the add-on that you wish to migrate from.
  3. Now when viewing a page with LaTeX macros, you will see an error that the old macros are unknown (e.g. "latex-inline")
  4. Find the example below with the matching name and add that user macro to Confluence.
    1. If there is no matching user macro example, you can try adjusting one examples below or contact Bolo Software support for more guidance.
  5. That's it! The affected macros will now be rendered by LaTeX Math.

If automatic conversion is enabled in LaTeX Math settings, then when editing new versions of affected pages, the user macros will be replaced by LaTeX Math versions of those macros. This will provide a better editing experience, since the LaTeX Math editor is designed to make LaTeX easier to work with.

User Macro templates

Macro nameMacro body processingTemplate
latex-inlineUnrendered
## @param body:title=LaTeX to render|type=string|desc=LaTeX to render|required=true|option-showNameInPlaceholder=false|option-showValueInPlaceholder=true
##
## Use this macro to avoid new lines:
#macro(doNothing)#end
##
<ac:macro ac:name="mathinline">
  <ac:parameter ac:name="body"><![CDATA[$parambody]]></ac:parameter>
  <ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
  <ac:parameter ac:name="autoconvert">TRUE</ac:parameter>
</ac:macro>#doNothing()
latex-blockUnrendered
## @param body:title=LaTeX to render|type=string|desc=LaTeX to render|required=true|option-showNameInPlaceholder=false|option-showValueInPlaceholder=true
##
<ac:macro ac:name="mathblock">
  <ac:plain-text-body><![CDATA[$body]]></ac:plain-text-body>
  <ac:parameter ac:name="atlassian-macro-output-type">BLOCK</ac:parameter>
  <ac:parameter ac:name="autoconvert">TRUE</ac:parameter>
</ac:macro>
latex-macro-inlineUnrendered
## @param expr:title=LaTeX to render|type=string|desc=LaTeX to render|required=true|option-showNameInPlaceholder=false|option-showValueInPlaceholder=true
##
## Use this macro to avoid new lines:
#macro(doNothing)#end
##
<ac:macro ac:name="mathinline">
  <ac:parameter ac:name="body"><![CDATA[$paramexpr]]></ac:parameter>
  <ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
  <ac:parameter ac:name="autoconvert">TRUE</ac:parameter>
</ac:macro>#doNothing()
latex-macro-blockUnrendered
## @param expr:title=LaTeX to render|type=string|desc=LaTeX to render|required=true|option-showNameInPlaceholder=false|option-showValueInPlaceholder=true
##
## Use this macro to avoid new lines:
#macro(doNothing)#end
##
<ac:macro ac:name="mathblock">
  <ac:plain-text-body><![CDATA[$body]]></ac:plain-text-body>
  <ac:parameter ac:name="atlassian-macro-output-type">BLOCK</ac:parameter>
  <ac:parameter ac:name="autoconvert">TRUE</ac:parameter>
</ac:macro>#doNothing()