Cloud
Data Center 7.10
Versions

Macros

Confluence Data Center and Server documentation

On this page

In this section

Related content

  • No related content found

Still need help?

The Atlassian Community is here for you.

Ask the community

Macros are how you supercharge your Confluence pages. 

You can use macros to:

  • change the format and layout of your page
  • display media like video, audio, and social media content
  • collate and organise Confluence pages, blogs, and files
  • perform actions from a page, such as creating a page from a template. 

Take your Confluence space to the next level using macros. 

On this page:

Screenshot: Page containing Status, Page Properties Report, Livesearch, and Profile Picture macros to help people find information about particular projects.

Macro basics

Add a macro to your page

To add a macro to your page:

  1. From the editor toolbar, choose Insert > Other Macros.
  2. Select a macro from the list.
  3. Enter any required parameters.
  4. Choose Insert.

In the editor you'll see a placeholder that represents the macro. Once you publish your page, you'll see the macro in its full glory. 

Edit a macro

Macro parameters are used to change the behaviour of a macro.

To change the macro parameters:

  1. In the editor, click the macro placeholder and choose Edit.
  2. Update the parameters as required then choose Insert.

Head to the documentation for specific macros below for full details of the parameters available in each macro.

Confluence macros

Here's a list of macros currently available with Confluence Server and Data Center.

Click a macro name for details of the usage, including optional parameters and examples.

Get more macros

This documentation provides information on all the macros that are provided with Confluence by default. There may be other macros in your site, from Marketplace Apps, or perhaps developed in-house. 

Third-party macros from the Atlassian Marketplace

You can find a wide range of Atlassian and third party macros at The Marketplace. These are distributed as apps and can be installed by a Confluence Administrator.

Create your own macros

Users with System Administrator permissions can create user macros - see Writing User Macros. 

If you want to create something more complex, you can develop your own plugin - see Writing Confluence Plugins.

Macro usage statistics

Confluence administrators can check how often each macro is used in your site.

To see how often a macro is used, go to  > General Configuration  > Macro Usage.  This lists how often each macro is used in current spaces but doesn't include any macros used on pages in archived spaces or macros provided by disabled apps.

Unknown macro

In view page mode, disabled macros show a placeholder image:

When macros with body content are disabled, the content will be preserved and display in the editor. 

To display the content in view mode:

  1. In the editor, select the macro and choose Edit.
  2. In the macro browser, select Back.
  3. Search for a new macro and select it.
  4. Check your content displays in the Preview pane.
  5. Select Insert.

In the editor, the disabled macro will switch to the new macro and display your content. Update the page to display the content in view mode.


tip/resting Created with Sketch.

Do more with Confluence

Extend Confluence with one of the hundreds of other macros in the Atlassian Marketplace, such as:

Last modified on Dec 14, 2020

Was this helpful?

Yes
No
Provide feedback about this article

In this section

Related content

  • No related content found
Powered by Confluence and Scroll Viewport.