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.
Including a macro in your page
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 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.
These optional parameters are included within the curly braces, following a colon, like this:
{attachments:patterns=.*jpg}
When specifying more than one parameter within the same macro, the pipe symbol ('|') is used to separate one from the other, like this:
{attachments:old=true|patterns=.*jpg}
Confluence Macros
Many macros are shipped with Confluence. The macros currently available in Confluence are listed below. For each macro, all the optional parameters are also listed with examples of their usage.
Other macros
Other macros are available as [plugins] or as [user macros], and can be installed by your Confluence administrator.
Writing your own macros
To learn how to write your own macro, or use macros written by other people, read the Confluence Plugin Guide
RELATED TOPICS
Confluence Notation Guide Overview
Confluence Plugin Guide
[Plugin Index]
[User Macros]
Take me back to Confluence User Guide
