metadata-from macro

Overview

The metadata-from macro is the simplest macro to get a piece of metadata from another page onto the current one.

The macro can only be used to retrieve the value of a single metadata value name.

Parameters

Parameter

Required

Default

Notes

Version

Parameter

Required

Default

Notes

Version

value-name



The value name of the metadata to retrieve. Any wiki format that is part of the metadata value will be rendered on the current page.



page

 

@self

The page where the value name of the metadata has been added.

Default is to the current page.



Usage

To retrieve a single metadata value from a page, choose the Metadata from  macro from the Confluence macro browser:

The macro editor allows you to configure the macro.

metadata-from macro editor dialogue box options

The macro requires you to add both:

  • the metadata value name

  • the source page for the metadata name. If the metadata being retrieved is from the current page you need to add @self to Insert the macro.

The macro will retrieve the metadata value and display on the current page.

If the metadata includes any wiki formatting as part of the value then this will be rendered on the current page together with the value.

In the example the value of the metadata Division has been defined using the Comala Metadata metadata macro.

On the page, the metadata value is retrieved using the metadata-from macro.

In this example, the display would simply be the value of the metadata Division filtered to be from the page Project initiation Document.

Markup Reference

{metadata-from:Project Initiation Document|Division}


In this example the Project Initiation Document page contains the metadata name Division whose value has been set as Digital Products.

The metadata-from macro retrieves the value for Division from the page Project Initiation Document.

The following would retrieve the value of Division metadata from the current page (if present).

{metadata-from:Division}

Usage with the Comala Document Management app

The metadata-from macro is supported by the Comala Document Management app and will work at workflow level.