metadata-list macro

Owned by Robert Alexander Marshall
Last updated: Dec 18, 2023
4 min read
1 Overview | 2 Parameters | 3 Usage | 4 Reference Markup | 5 Usage with the Comala Document Management app | 6 Related macros | 7 Related documentation

Overview

The metadata-list macro allows the attachment of multiple pieces of metadata to an individual page.

The macro is used for setting metadata values not for listing metadata values.

This allows multiple metadata values set and stored on an individual page to be referenced from other pages (see the space-metadata-list macro for the equivalent functionality for spaces).

Parameters

Parameter

Required

Default

Notes

Version

Parameter

Required

Default

Notes

Version

unnamed first parameter(s)





No parameter is required. The metadata names and values are added to the body of the macro.

Do not use a reserved Confluence metadata name.



hidden



false

  • true – metadata value is not displayed on current page

  • false – metadata value is displayed on current page

This option to hide or display the metadata values affects only the page that contains the 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 horizontal



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 page, choose the Metadata List macro in the Confluence macro browser:

The macro editor allows you to configure the 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 their values using the metadata-list macro placeholder:

The metadata name and value can be plain text or include simple wiki markup. In the example above the metadata and their values are rendered in a table on the page:

You can add a piece of this metadata from this page onto another page, for example, using the metadata-from macro to add a single piece of metadata or one of metadata-report macro for multiple pieces of metadata.

Reference Markup

The following will create four individual metadata items and set a value for each of them:

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

The metadata values in this example include wiki markup. This will be displayed on the page as a table:

An optional orientation=horizontal parameter changes the rendering to be horizontal.

{metadata-list|orientation=horizontal} || Name | Comala Metadata Plugin | || Version | 3.5.x | || Product Versions | Confluence 6.x | || Author(s) | Captain Comala | {metadata-list}

It will be displayed as:

If you don't want the list of metadata displayed on this page you can choose to add the "hidden" parameter.

{metadata-list|orientation=horizontal|hidden=true}

The use of the "hidden" parameter does not affect the pages where the metadata is reused.

Usage with the Comala Document Management app

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

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