This page last changed on Jun 08, 2009 by ggaskell.

The Metadata macro allows you to embed metadata into pages and blog posts for presentation with the Metadata Summary Macro. Each metadata item consists of a field name and an associated value. When a metadata macro is rendered on a page, each metadata item is presented on a single line, starting with the name of the field, followed by its value, for example:

Is-Secret: Yes
Author-Nickname: Banana Split

Each metadata macro is 'labelled', allowing you to:

  • insert multiple Metadata macros on a single page or blog post, each with a different label
  • use the Metadata Summary macro to generate a summary based on Metadata macros tagged with a specific label.
Metadata macro 'label's are completely unrelated to page labels. A Metadata macro's label is only used by the Metadata Summary macro for the purpose of generating its summary.

As far as the Metadata Summary macro is concerned, each field only possesses a single value. Hence, if you added multiple values to a field (for example, by separating each value with a comma), the Metadata Summary macro treats this as a single value and presents it as such.

On this page:

Usage with the Macro Browser

To insert the metadata macro into a page using the Macro Browser,

  1. Open your desired Confluence page, then click the 'Edit' button. The 'Edit Page' mode opens.
  2. Next, click the Macro Browser icon on the editor toolbar. The Macro Browser will open in the middle of the screen.
  3. In the Macro Browser, type the name of your desired macro into the search box at the top right of the window. Macros with a matching name will appear in the centre pane. Click on the desired macro to see its options screen. Here, you can set the macro parameters then click 'insert' to put the macro into the page.

Once you've found the metadata macro, click 'insert' to add it to your page.

Usage with the Wiki Markup Editor

{details:label=test}
Is-Secret: Yes
Author-Nickname: Banana Split
{details}

Each metadata item is added on a separate line. Separate each field and value with a colon (:) followed by a space. For example: colour: Red.

In the example above,

  • test is the label of this metadata macro, which can be identified uniquely on a page in a metadata summary
  • Is-Secret is a field of value Yes
  • Author-Nickname is another field with a value of Banana Split.

Parameters

Parameters are settings for Confluence macros that allow the user to control their content or presentation. The table below lists relevant parameters for this macro.

Parameter names are displayed differently in the macro browser interface and in wiki markup. Below, parameter names used in the macro browser are indicated in Bold text, while their equivalents in wiki markup are indicated in (bracketed) text. If the latter is not shown, then in wiki markup, the parameter's name should be omitted and only its value should be added immediately after the colon symbol (:).

Parameter Required in Wiki Markup? Default Description
Metadata Label
(label)
yes none Used by the Metadata Summary macro to generate a summary based on all Metadata macros tagged with this label throughout the current space.


RELATED TOPICS

Working with Macros

Take me back to the Confluence User Guide.

Document generated by Confluence on Nov 05, 2009 23:35