Confluence 2.8 : Working with Macros
This page last changed on Jun 23, 2008 by smaddox.
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 pageGenerally speaking, a macro is simply a command wrapped inside curly braces {...}. For instance, the Attachments Macro is written as:
{attachments} Optional Parameters in MacrosMany macros allow you to include 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:
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, use the pipe symbol ('|') to separate one from the other, like this: {attachments:old=true|patterns=.*jpg}
Case Sensitivity in Macro ParametersMacro parameters are case sensitive. In most cases, the macro will expect its parameters to be in lower case. Make sure you follow the documentation for the specific macro and match the expected case, otherwise the parameter may be ignored. For example, this code correctly has the parameter 'patterns' with a lower case 'p' as expected by the Attachments Macro: {attachments:patterns=.*jpg} This code will not work, because the parameter 'Patterns' has an upper case 'p', which the Attachments Macro will not recognise: {attachments:Patterns=.*jpg} Confluence MacrosMany 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 macrosOther 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:
Writing your own macrosTo learn how to write your own macro, or use macros written by other people, read the Confluence Plugin Guide. RELATED TOPICSConfluence Notation Guide Overview Take me back to Confluence User Guide. |
![]() |
Document generated by Confluence on Jun 24, 2008 18:05 |