space-metadata-list macro

Overview

The space-metadata-list macro lets an editor attach multiple pieces of metadata to a space with one macro (see the metadata-list macro for the equivalent functionality for pages)

Parameters

Parameter	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 any reserved Confluence metadata names or words.
`hidden`	`false`	`true` – metadata value is not displayed on the current page `false` – metadata value is displayed on the current page This option to hide or display the metadata values affects only the page that contains the `space-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 horizontally
`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 space

Choose the Space Metadata list macro in the Confluence macro browser

The macro editor lets you configure the macro.

Macro editor - Space 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 values to the macro body on the draft page:

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

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

Existing metadata values can be cleared on adding the macro to the page by checking the Clear value option in the macro editor.

This macro is for setting metadata values for the space, not for listing existing metadata values.

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

for example, creating a metadata End Date with a value of Dec 2023 or 08/09/2024 will be returned as a string value and is not recognized as a date format value

Reference Markup

{space-metadata-list}
|| Location | Europe |
|| Division | EMEA|
|| Headquarters | Bilbao, Espagne|
{space-metadata-list}

For the space in which the page is located:

Metadata names are added as space metadata
Metadata values are set as those in the body of the macro

The default is to display the metadata and the values on the page in a tabular format.

Add clear=true to remove any existing space metadata on the page.

Usage with the Comala Document Management app

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

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

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