metadata-list macro

Overview

The metadata-list macro allows the attachment of multiple pieces of metadata to an individual page.

The macro is used for setting metadata values not for listing metadata values.

This allows multiple metadata values set and stored on an individual page to be referenced from other pages (see the space-metadata-list macro for the equivalent functionality for spaces).

Parameters

Parameter	Required	Default	Notes	Version

Parameter	Default	Notes
`unnamed first parameter(s)`		No parameter is required. The metadata names and values are added to the body of the macro. Do not use a reserved Confluence metadata name.
`hidden`	`false`	`true` – metadata value is not displayed on current page `false` – metadata value is displayed on current page This option to hide or display the metadata values affects only the page that contains the `metadata-list` macro. It does not affect any pages where the metadata is reused.
`orientation`	`vertical`	`vertical` – metadata values are displayed vertically `horizontal` – metadata values are displayed horizontal
`clear`	`false`	Clears the values for any metadata on the page on adding the macro to the page `true` – any existing metadata values are removed `false` – any existing metadata values are retained

Usage

To add multiple pieces of metadata to a page:

Choose the Metadata list macro in the Confluence macro browser:

The macro editor lets you configure the macro.

Macro editor - Metadata list macro

The macro editor only includes the following options for the macro:

display metadata as a vertical or horizontal list
hide the metadata from being displayed on this page
clear any existing metadata values of the page before setting the new metadata and values

You must Insert the macro to add the metadata names and their values using the metadata-list macro placeholder:

The metadata name and value can be plain text or include simple wiki markup.

In the example above, the metadata and their values are rendered in a table on the page:

The macro is used for setting metadata values, not for listing metadata values.

When using the macro to set metadata that is a date and time, Confluence search and CQL return the value as a string unless the metadata value is added in the following format: yyyyMMddHHmmssSSS. For example:

Inauguration Date with a value of Feb 2019 or 08/09/2023 is returned as a string value and is not recognized as a date format

You can add a piece of this metadata from this page onto another page. For example, using the metadata-from macro to add a single piece of metadata or the metadata-report macro for multiple pieces of metadata.

Reference markup

The following creates four individual metadata items and sets a value for each of them:

{metadata-list}
|| Name | Comala Metadata Plugin |
|| Version | 3.5.x |
|| Product Versions | Confluence 6.x |
|| Author(s) | Captain Comala |
{metadata-list}

The metadata values in this example include wiki markup. This is displayed on the page as a table:

An optional orientation=horizontal parameter changes the rendering to be horizontal.

{metadata-list|orientation=horizontal}
|| Name | Comala Metadata Plugin |
|| Version | 3.5.x |
|| Product Versions | Confluence 6.x |
|| Author(s) | Captain Comala |
{metadata-list}

It is displayed as:

If you don't want the list of metadata displayed on the page, you can choose to add the "hidden" parameter.

{metadata-list|orientation=horizontal|hidden=true}

The use of the "hidden" parameter does not affect the pages where the metadata is reused.

Usage with the Comala Document Management app

The metadata-list macro is partially supported by the Comala Document Management app.

{trigger:pageupdated}
    	{metadata-list}
          || Name | Comala Metadata Plugin |
          || Version | 3.5.x |
          || Product Versions | Confluence 6.x |
          || Author(s) | Captain Comala |
        {metadata-list}
    {trigger}

If the macro is used at the workflow level in the Comala Document Management app, it should not be used together with the orientation parameter. For example, {metadata-list|orientation=horizontal}. This is unsupported and causes an error.