マクロでの作業

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

Macros allow you to 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.

On this page:

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:

{attachments}

Optional Parameters in Macros

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.

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 Parameters

Macro 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:
Invalid macro code:

{attachments:Patterns=.*jpg}

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.

Information about Other 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:

• {toc} macro, provided by the [Table of Contents Plugin] - full documentation by CustomWare.
• {float} macro and others, provided by the [Composition plugin] - full documentation by CustomWare.

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

関連トピック

Confluence Notation Guide Overview
Confluence Plugin Guide
[Plugin Index]
[User Macros]

Take me back to Confluence User Guide.