Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
maxLevel3
minLevel2
absoluteUrltrue
excludeSee also
typeflat
separatorpipe

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

unnamed first parameter

(tick)


This is the name given to the added metadata. The name is case sensitive.

Info

Do not use any reserved Confluence metadata names or words.


hidden


false

  • true – metadata value is not displayed on current page

  • false – metadata value is displayed on current page

Info
Note that this

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

Excerpt

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 iconImage Removedspace metadata plugin macro browser iconImage Added

Simply add your chosen metadata name to the macro editor e.g. Department. This metadata name will be case sensitive.

space metadata insert macro windowImage Removedspace metadata insert macro windowImage Added

To add the value of the metadata, Insert the macro to the page and enter the metadata value into the metadata macro placeholder.

Image RemovedImage Added

To see the display of the space metadata value on the current page, choose the macro placeholder Edit option.

Image RemovedImage Added

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

Image RemovedImage Added

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 will create a filled cell in a table containing the text value of the metadata, Department.

squadron leader comala metadata value displayed as filled table cell

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

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.

...