This page last changed on Jan 16, 2011 by rshuttleworth.

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.

Warning 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. In the Confluence editor, choose Insert > Other Macros.
  2. Find and select the required macro.

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

When editing, you can click on the macro placeholder and choose Edit to display the parameters for this macro in the Macro Browser.

Parameters are options that you can set for Confluence macros to control the content or format of the macro output. The table below lists parameters for this macro that can be set in the Macro Browser.

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.

hidden
(hidden)

no

false

Controls whether the text between the details tags will appear on that page when users read it.


RELATED TOPICS

Working with Macros

Take me back to the Confluence User's Guide.

Document generated by Confluence on Sep 19, 2011 02:35