• Products
  • Documentation
  • Resources

What are macros?

Using macros helps you to extend the capabilities of your Confluence pages, allowing you to add extra functionality or include dynamic content. For example, use the Attachments macro to list files attached to a page, or use the Widget Connector macro to include things like a YouTube video or Twitter feed.

Add a macro to your page

To add a macro:

  1. When editing, select from the toolbar

  2. Find the macro by name and select it

  3. Configure it as needed

You can also type / on the page to bring up the same list you'd see by selecting from the toolbar. Continue typing the name of the macro to filter the list.

To edit a macro:

  1. Select the macro placeholder.

  2. Select the Edit icon to open the configuration panel.

  3. Configure the parameters. Your changes are saved as you go.

  4. Resume editing the page, and the panel closes.

You can also select the centered , medium-width , and full-width icons to adjust the width of some macros. Select the trashcan iconto remove the macro.

Macro parameters

Many macros have optional parameters you can use to control the macro's output.

With the Attachments Macro, for instance, you have two optional parameters allowing you to:

  • Specify the file formats of the attachments displayed

  • Choose whether or not you want old versions of the attachments displayed

Macro placeholders

Macro placeholders are displayed in the editor where you have added a macro to the page.

When editing a page, you can:

  • Double-click a macro placeholder (or click the placeholder and choose Edit) to open the macro dialog window and edit the macro's parameters

  • Select a macro placeholder to cut, copy and paste the macro

Conflicts between two macros

Some Marketplace macros, or apps, can’t be installed together because they were given the same internal ID. When you try to install an app with a name that conflicts with a previously installed macro, you will see this error message:

Unable to install <app B>
Your instance has <app A> from the same partner that does not allow installation of ‘App B’ due to technical constraints.

The quickest solution is to uninstall one app so that you can install the other.

You may also want to contact the developer through the Atlassian Marketplace and ask them to address the error.

Macros in the legacy editor only

Below is a list of the macros available in the legacy editor.

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

For alternate methods for accomplishing the goal of older macros, learn which macros are being removed.

Macros available in both editors

Below is a list of the macros available in both editors.

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

Macros from the Marketplace

Many more macros are available from the Atlassian Marketplace.

Blocked macros

When you navigate to a page in Confluence, some macros may appear with a message informing you that an administrator has blocked this app:

An administrator has blocked this app

When using macros that leverage apps from the Atlassian Marketplace, it is possible for your organization admin to block an app’s access to your data through a data security policy with an app access rule. When this rule is applied, you can no longer use macros that were provided by apps that have been blocked in the coverage selected by your organization.

Contact your Confluence admin to discuss available options.

What happens to app data associated with a macro that is blocked?

Data that is stored by a blocked macro is subject to the retention policy of the partner who developed the macro. After the retention period, this data may be deleted and may not be able to be restored. Therefore, if you notice missing data, discuss it with your Confluence admin so that any required steps can be taken to preserve the data.

What if I don’t want my users to see the ‘blocked app’ error on the page?

As a workaround, you can remove the app blocked message from the page by removing the macro from the page. This will also delete any data on the page that the app has stored within the macro, but will not remove data the macro may have stored in app storage that is subject to the partner’s retention policy, as above.

 

Still need help?

The Atlassian Community is here for you.