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 {metadata-list} macro  macro allows the attachment of multiple pieces of metadata to an individual page.

Note that the macro name is misleading - it (blue star) The macro is used for setting metadata values , not for listing metadata values.

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

Parameters

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.


hidden


false

  • true – metadata value is not displayed on current page

  • false – metadata value is displayed on current page

Note that this

(blue star) 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

Excerpt

To add multiple pieces of metadata to a page, choose the Metadata List macro in the Confluence macro browser:

Image RemovedImage Added

The macro editor allows you to configure the macro.

Image RemovedImage Added

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:

Image RemovedImage Added

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:

Image RemovedImage Added

Note this (blue star) This macro is for setting metadata values, not for listing existing metadata values. 

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.

...

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

Code Block
languagetext
themeRDark
{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.

Code Block
languagetextthemeRDark
{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.

Code Block
languagetext
themeRDark
{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.

Code Block
languagetext
themeRDark
{trigger:pageupdated}
    	{metadata-list}
          || Name | Comala Metadata Plugin |
          || Version | 3.5.x |
          || Product Versions | Confluence 6.x |
          || Author(s) | Captain Comala |
        {metadata-list}
    {trigger}

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.

Related macros

Child pages (Children Display)
pageComala Metadata Macros
first5

Related documentation