Using a macro, you can add extra functionality or include dynamic content on a page. For example, the Attachments macro will list a page's attachments in the page itself, so that readers do not have to visit the Attachments tab.

Adding a Macro to your Page

Including Macros with the Macro Browser

To add a macro to a page:

  1. In the Confluence editor, choose Insert > Other Macros.
  2. Find and select the required macro.

Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete.

To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro.

Macro Parameters

Many macros allow you to include optional parameters 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, where you can edit the macro's parameters.
  • Select a macro placeholder to cut, copy and paste the macro.

On this page:

Related pages:

Macros Shipped with your Confluence Installation

When you download your Confluence installation file, many macros are shipped with the download. Below is a list of the macros currently shipped with Confluence. Click a macro name for details of the usage, including optional parameters and examples.

Activity Stream Macro
Anchor Macro

Allows you to link to a specific part of a page.

Attachments Macro

Displays a list of attachments on a given page.

Blog Posts Macro

Lists the most recent news items in the space.

Change-History Macro

Displays a history of updates made to a page.

Chart Macro

Displays a chart based on tabular data.

Cheese Macro

Displays the words "I like cheese!"

Children Display Macro

Displays the children and descendants of the current page.

Code Block Macro

Displays code in your document with the appropriate syntax highlighting.

Column Macro

Used with the Section macro to define columns on a page. See  Working with page layouts and columns and sections.

Content by Label Macro

Displays a list of content associated with specific labels.

Content by User Macro

Displays a list of the content items that have been created by a specified Confluence user.

Content Report Table Macro

Displays a set of pages and blog posts in tabular format, based on the labels specified in the macro parameters.

Contributors Macro

Displays a list of Confluence users who have made a contribution of some type to a page.

Contributors Summary Macro

Displays a table of contribution-based statistics for a set of pages.

Create from Template Macro

Creates a page from a given template.

Create Space Button Macro

Displays a create space button linked to the create space page.

Excerpt Include Macro

Allows you to display an excerpt from another page within the current page.

Excerpt Macro

Define a part of a page as the page's 'excerpt' which can then be displayed in another page.

Expand Macro

Displays an expandable/collapsible section of text.

Favourite Pages Macro

Displays a list of your favourite pages.

Gadget Macro

Allows you to add Confluence gadgets to pages or blog posts.

Gallery Macro

Forms a thumbnail gallery of all images attached to a page.

Global Reports Macro

Displays a list of links to global reports within a table.

HTML Include Macro

Includes the content of an external HTML file into a Confluence page.

HTML Macro

Renders your specified HTML code within the current page.

IM Presence Macro

Displays graphically when a contact is online.

Include Page Macro

Inserts the contents of the specified page into the current one.

Info Macro

Displays a block of text in a blue highlight box.

JIRA Issues Macro

Displays one or more JIRA issues, and offers the option to create an issue in JIRA.

JUnit Report Macro

Display a summary of JUnit test results.

Labels List Macro

Displays a hyperlinked alphabetical index of all labels within the current space.

Livesearch Macro

Add a dynamic search box to a wiki page.

Loremipsum Macro

Display a few paragraphs of pseudo-Latin text.

Multimedia Macro

Displays videos, animations and more, sourced from a file attached to a Confluence page and displayed on your page.

Navigation Map Macro

Displays a navigable map of the pages tagged with a given label.

Network Macro

Displays a list of Network activity for users on your Confluence site.

Noformat Macro

Displays a block of text in monospace font.

Note Macro

Displays a block of text in a yellow highlighted box.

Office Excel Macro

Displays the content of an Excel spreadsheet on a wiki page.

Office PowerPoint Macro

Displays the content of a PowerPoint presentation on a wiki page.

Office Word Macro

Displays the content of a Word document on a wiki page.

Page Index Macro

Creates a hyperlinked alphabetical index of all page titles within the current space.

Page Properties Macro

Allows you to embed metadata into a page and then display that data in tabular form using the Page Properties Report macro .Previously known as the Metadata Details macro.

Page Properties Report Macro

Presents a tabulated summary of selected metadata, which has been embedded on pages using the Page Properties macro. Previously known as the Details Summary macro.

Page Tree Macro

Displays a dynamic, hierarchical list of pages starting from a specified parent (root) page.

Page Tree Search Macro

Adds a search box to your Confluence page and searches a hierarchy of pages starting from a specified parent (root) page.

Panel Macro

Displays a block of text within a customisable panel.

PDF Macro

Displays the content of a PDF document on a wiki page.

Popular Labels Macro

Displays the most popular labels used throughout your Confluence site or within a space.

Profile Picture Macro

Displays a user's profile picture on a page.

Recently Updated Dashboard Macro

Displays a list of the most recently changed content within Confluence and is intended for use on the Confluence dashboard.

Recently Updated Macro

Displays a list of recently changed content (pages, news items, comments, etc).

Recently Used Labels Macro

Lists labels most recently used in a specified scope (global, space, or personal)

Related Labels Macro

Lists labels frequently appearing on the same pages as the current page's labels.

RSS Feed Macro

Displays the contents of an RSS feed.

Search Results Macro

Searches Confluence, and includes the results in the page.

Section Macro

Used with the Column macro to define columns on a page. See  Working with page layouts and columns and sections.

Space Attachments Macro

Displays a list of attachments belonging to the current space.

Space Details Macro

Displays the details of a Confluence space, including the space name, description, and more.

Space Jump Macro

Allows you to link from a page in one space to a page with the same name in another space, without knowing the name of the page when you create the link.

Spaces List Macro

Displays a list of the spaces visible to the user.

Status Macro

Displays a coloured lozenge, useful for reporting project status.

Table of Contents Macro

Displays a table of contents based on the headings on the page.

Table of Content Zone Macro

Displays a table of contents from a defined page 'zone'.

Tasklist Macro

Displays a dynamic task list which can be modified in view mode.

Tip Macro

Displays a block of text in a green box.

User List Macro

Displays a list of Confluence users in a given group.

User Profile Macro

Displays a summary of a given Confluence user's profile.

User Status List Macro

Displays a history of a given Confluence user's status updates.

View File Macro

Range of macros to embed an Office document or PDF file into your Confluence page.

Warning Macro

Displays a block of text in a red highlight box.

Widget Connector Macro

Displays content from other websites including videos, slide shows, twitter chats, documents and more on your Confluence page.

Information about Other Macros

Other macros are available as plugins or as user macros, and can be installed by your Confluence administrator. For example, macros that may be of interest are available from Adaptavist, CustomWare and the Confluence SharePoint Connector. Not applicable to Confluence OnDemand.

Writing your own Macros

To learn how to write your own macro, take a look at the following documentation:

  • User macros are simple template-like macros that allow you to create simple formatting macros using the Confluence web interface. Read more about Writing User Macros. Not applicable to Confluence OnDemand.
  • The Confluence Plugin Guide tells you how to develop a plugin for Confluence.

Code examples

See: