Working with Macros

Macros perform programmatic functions within a page and can be used to generate complex content structures or dynamic content.

Macros allow you to create markup or include dynamic content in a page that may not be possible using Confluence notation. 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.

Generally speaking, a macro is simply a command wrapped inside curly braces {...}.

For instance, the Attachments Macro is written as:

Optional Parameters in Macros

For each macro, you can also have optional parameters that can often be combined to refine or control the macro's output.

With attachments, 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.

These optional parameters are included within the curly braces, following a colon, like this:

When specifying more than one parameter within the same macro, the pipe symbol is used to separate one from the other, like this:

The macros currently available in Confluence are listed below. For each macro, all the optional parameters are also listed with examples of their usage.

• Attachments Macro — Displays a list of attachments belonging to the current page.
• Blog Posts Macro — Lists the most recent news items in the space.
• 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.
• Create Space Button Macro — Renders a create space button linked to the create space page.
• Dynamic Tasklist Macro — Displays a dynamic task list which can be modified in 'view' mode.
• Flowchart Macro — Displays flowcharts and other diagrams composed of shapes joined by lines.
• Thumbnail Macro - Creates a thumbnail of an inline image.
• 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.
• IM Presence Macro — Displays graphically when a contact is online.
• Include Page Macro — Inserts the contents of the specified page into the current one.
• 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.
• Noformat Macro — Displays a block of text in monospace font.
• Recently Updated Content Macro — Includes a list of recently changed content.
• RSS Feed Macro — Displays the contents of an RSS feed.
• Search Macro — Searches Confluence, and includes the results in the page.
• Space Details Macro — Includes the summary of a Confluence space in the page.
• Spacegraph Macro — Displays a chart of the pages in a space and their connections.
• Spaces List Macro — Displays a list of all spaces visible to the user.
• Userlister Macro — Displays a list of Confluence users, from an optional group.
• Welcome Message Macro — Includes the Confluence site welcome message.

RELATED TOPICS

Confluence Notation Guide Overview

Take me back to Help Home