This page last changed on Sep 11, 2011 by pwatson.

Using a macro, you can add extra functionality or include dynamic content in 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.

Including a Macro in your Page

Including Macros with the Macro Browser

To insert a macro into a page using the Macro Browser:

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

For a complete description of the macro browser, see Working with the Macro Browser.

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:

  • To specify the file formats of the attachments displayed.
  • To 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 to open the Macro Browser (or click on the placeholder and choose Edit), where you can edit the macro's parameters.
  • Select a macro placeholder to cut, copy and paste the macro.

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.

Attachments Macro

Displays a list of attachments belonging to the current 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. Defines columns within the page.

Content by Label Macro

Renders a list of content associated with specific labels.

Create Space Button Macro

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

Excerpt Macro

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

Excerpt Include Macro

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

Expand Macro

Displays an expandable/collapsible section of text.

Favourite Pages Macro

Displays a list of your favourite pages.

Gallery Macro

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

Global Reports Macro

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

HTML Macro

Renders your specified HTML code within the current page.

HTML Include Macro

Includes the content of an external HTML file into a Confluence 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 Macro

Displays one or more JIRA issues on your Confluence page.

JIRA Issues Macro

Displays a list of JIRA issues in a page.

JIRA Portlet Macro

Displays a JIRA dashboard portlet in Confluence.

JUnit Report Macro

Display a summary of JUnit test results.

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.

Navmap Macro

Renders the list of pages associated with a specified label as a navigable map.

Noformat Macro

Displays a block of text in monospace font.

Note Macro

Displays a block of text in a yellow highlight box.

Panel Macro

Displays a block of text within a fully customisable panel.

Pagetree Macro

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

Pagetree Search Macro

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

Profile Picture MacroDisplays a user's profile picture on a page.

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 Macro

Searches Confluence, and includes the results in the page.

Section Macro

Used with the Column Macro to define columns within the page.

Space Details Macro

Includes the summary of a Confluence space in the page.

Spaces List Macro

Displays a list of all 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 from your page headings.

Table of Contents 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 highlight box.

Userlister Macro

Displays a list of Confluence users, from an optional group.

View File Macro

Embeds an Office document into your Confluence page.

Warning Macro

Displays a block of text in a red highlight box.

Web-Widget Macro

Same as the Widget macro.

Welcome Message macro

Includes the Confluence site welcome message.

Widget Macro

Displays videos, slide shows, twitter chats, documents and more, sourced from other web sites and displayed on your Confluence page.

Information about Other Macros

Macros Provided by Plugins or User Macros

Other macros are available as plugins or as user macros, and can be installed by your Confluence administrator.

Customers using Adaptavist macros or plugins might be interested in the Adaptavist's Confluence user guide.

Some examples are:

Macros that Do Not Work

Some macros were never intended for external use, and we have always recommended that you do not add them to a wiki page. Nevertheless, it is possible that some Confluence sites have these macros on some pages. Please note that these macros no longer work in Confluence 3.4 onwards. They were part of the Plugin Repository, which we have now replaced with a new plugin manager.

These macros no longer work:

  • {repository-plugin}
  • {recentlyupdated-plugins}
  • {popular-plugins}
  • {download-stat}
  • {confluence-status}
  • {plugin-status}
  • {plugin-repository}
  • {plugins-supported}

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.
  • The Confluence Plugin Guide tells you how to develop a plugin for Confluence.

Related Topics

Working with the Macro Browser
Atlassian Plugin Exchange
Installing Plugins and Macros

Take me back to the Confluence User's Guide.

Document generated by Confluence on Sep 19, 2011 02:35