...
...
...
...
...
...
...
...
...
...
...
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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
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 | ||
|---|---|---|---|---|---|---|
| No parameter is required. The metadata names and values are added to the body of the macro.
| |||||
|
|
|
|
|
| ||||
|
|
| ||
|
| Clears the values for any metadata on the page on adding the macro to the page
|
Usage
| Excerpt | |||||
|---|---|---|---|---|---|
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:
You must Insert the macro to add the metadata names and their values using the {   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:
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
|
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 | ||||
|---|---|---|---|---|
| ||||
{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 | ||||
|---|---|---|---|---|
| ||||
{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 | ||||
|---|---|---|---|---|
| ||||
{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 | ||||
|---|---|---|---|---|
| ||||
{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) | ||||
|---|---|---|---|---|
|