Child pages
  • Metadata Macro
Skip to end of metadata
Go to start of metadata

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. Open the Confluence page or blog post that you want to edit, then click the 'Edit' button.
  2. Click the Macro Browser icon on the toolbar. The macro browser window will open.
  3. Scroll through the list of macros to find the one you want. Alternatively, start typing the macro name into the search box at the top right of the macro browser. Macros with a matching name will appear in the main pane.
  4. Click the desired macro.
  5. Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
  6. Click 'Insert' to add the macro onto the page.

(tick) You can also insert macros via autocomplete. For more information, see Using Autocomplete in the Rich Text Editor.

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 options that you can include in Confluence macros to control the content or format of the macro output. The table below lists relevant parameters for this macro.

Parameter names are different in the macro browser and in wiki markup. Below we show the macro browser parameter names in bold text, and the equivalent wiki markup parameters in (bracketed) text. If we do not show any parameter name for the wiki markup, then you should leave out the parameter name and simply include the parameter value as the first parameter, immediately after the colon (:).

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 Wikis Help Guide.