space-metadata macro

Overview

The space-metadata macro lets you attach a single piece of metadata to a space (see the metadata macro for the equivalent functionality for pages).

The macro can be added to any page in the space for the metadata to be added to the space.

Parameters

Parameter	Required	Default	Notes	Version

Parameter

Required

Default

Notes

Version

unnamed first parameter

This is the name given to the added metadata.

The name is case sensitive

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 value affects only the page that contains the metadata macro. It does not affect any pages where the metadata is reused.

Usage

To add a single piece of metadata to a space:

Choose the Space Metadata (Metadata Plugin) macro in the Confluence macro browser

space metadata plugin macro browser icon

Simply add your chosen metadata name to the macro editor, for example, Department. The metadata name is case sensitive.

Macro editor - Space Metadata macro

To add the value of the metadata

Insert the macro to the page
Enter the metadata value into the metadata macro placeholder

To see the display of the space metadata value on the current page in the macro editor:

Choose the macro placeholder Edit option

The added space metadata value is now displayed in the macro editor Preview.

Macro editor - Space Metadata with the metadata value displayed in the preview

The space metadata macro body accepts both plain text and simple wiki markup for the value.

The metadata is stored as un-rendered wiki markup, so in this case, the value ||Squadron Leader Comala| is stored for the Department metadata. The wiki markup creates a filled cell in a table on the published page containing the text value of the metadata, Department.

squadron leader comala metadata value displayed as filled table cell

When using the macro to set metadata that is a date and time, Confluence search and CQL 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 is returned as a string value and is not recognized as a date format value

You can add the individual metadata from this space onto a page, for example, using the space-metadata-from macro or one of the report macros.

The macros retrieving the metadata value render the markup into the page they are used on.

Reference markup

{space-metadata:Department}Systems Support{space-metadata}

The metadata value name is added to the space-metadata macro. The metadata value is the content of the macro's body.

Adding the hidden parameter means the metadata value is not displayed on the page where the macro has been added. This does not affect the display of the metadata value when it is retrieved on other content.

{space-metadata:Department|hidden=true}Systems Support{space-metadata}

Usage with the Comala Document Management app

The space-metadata macro is NOT supported by the Comala Document Management app and does not work at the workflow level.