Versions Compared

Old Version 4

changes.mady.by.user Robert Alexander Marshall

Saved on

compared with

New Version Current

changes.mady.by.user Robert Alexander Marshall

Saved on

Key

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

...

The basic metadata macro allows the attachment of a single piece of metadata to a page.

This allows a single metadata value stored on an individual page to be referenced from other pages (see the space-metadata macro for the equivalent functionality for spaces).

Parameters

Parameter

Required

Default

Notes

Version

unnamed first parameter

Image Removed

(tick)


This is the name given to the added metadata.

  • the metadata name is case sensitive


hidden


false

  • true – metadata value is not displayed on current page

  • false – metadata value is displayed on current page

(info)
Info

The 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 page, choose the Metadata (Metadata Plugin) macro in the Confluence macro browser:

macro browser metadata plugin optionImage Removedmacro browser metadata plugin optionImage Added

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

Image Modified

Insert the macro to the page.

Add the value of the metadata to the metadata macro placeholder.

Image RemovedImage Added

To see the page display, choose the placeholder Edit option.

Image RemovedImage Added

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

Image Modified(info)
Info

The 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 |Captain Comala| is stored for the Owner metadata. The wiki markup will create a cell in a table containing the text value of the metadata, Owner.

metadata value page render unfilled table cell

If you don't want the metadata value displayed on this page, simply check the Hidden option in the macro editor. 

Image AddedImage Removed
Info
(info)

This only hides the metadata value on the current page. It will not affect the visibility on any pages where the metadata is reused.

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 page onto another page, for example, using the metadata-from macro or one of the report macros.

...