---
title: "space-metadata-list macro"
canonical: "https://support.appfire.com/space/COMALACM/655890257/space-metadata-list%20macro"
format: markdown
---
> Macro (aura-html)

## <span style="color: #333333">Overview</span>

<span style="color: #333333">The </span>`space-metadata-list`<span style="color: #333333"> macro lets an editor attach multiple pieces of metadata to a space with one macro (see the </span>[metadata-list](https://appfire.atlassian.net/wiki/spaces/COMALACM/pages/655758458)<span style="color: #333333">[ macro](https://appfire.atlassian.net/wiki/spaces/COMALACM/pages/655758458)</span><span style="color: #333333"> for the equivalent functionality for pages)</span>

## Parameters

| Parameter | Default | Notes | Version |
| --- | --- | --- | --- |
| `unnamed first parameter(s)` |  | No parameter is required. The metadata names and values are added to the body of the macro.<br>> ℹ️ Do not use any [reserved](https://appfire.atlassian.net/wiki/spaces/COMALACM/pages/656579602) Confluence metadata names or words. |  |
| `hidden` | `false` | - `true` – metadata value is not displayed on the current page
- `false` – metadata value is displayed on the current page<br>> ℹ️ This option to hide or display the metadata values affects only the page that contains the `space-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 horizontally |  |
| `clear` | `false` | Clears the values for any metadata on the page on adding the macro to the page<br>- `true`** **– any existing metadata values are removed
- `false` – any existing metadata values are retained |  |

## Usage

> Macro (excerpt)
> 
> To add multiple pieces of metadata to a space
> 
> - Choose the [Space Metadata list](https://appfire.atlassian.net/wiki/spaces/COMALACM/pages/655890257) macro in the Confluence macro browser
> 
> ![image](media://668284ff-deec-400e-8479-829d8904631c)
> 
> The macro editor lets you configure the macro.
> 
> ![image](media://f450dfe6-0cf8-423c-9991-beb0199f3380)
> 
> 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 values to the macro body on the draft page:
> 
> ![image](media://ec289247-9584-4d55-a0e6-4fd5e3def3ea)
> 
> The metadata name and value can be plain text or include simple wiki markup.
> 
> In the example above, metadata and their values are rendered in a table on the page:
> 
> ![image](media://2bc0d2dc-57df-4712-ab7b-d1def5dd4049)
> 
> Existing metadata values can be cleared on adding the macro to the page by checking the **Clear value** option in the macro editor.
> 
> > ℹ️ This macro is *for setting metadata values* for the space, not for listing existing metadata values.
> 
> > 📝 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

## Reference Markup

```plaintext
{space-metadata-list}
|| Location | Europe |
|| Division | EMEA|
|| Headquarters | Bilbao, Espagne|
{space-metadata-list}
```

For the space in which the page is located:

- **Metadata names** are added as space metadata
- **Metadata values** are set as those in the body of the macro

The default is to display the metadata and the values on the page in a tabular format.

![image](media://fb67f249-8776-4921-b515-802097bb4528)

Add `clear=true` to remove any existing space metadata on the page.

## Usage with the Comala Document Management app

The `{space-metadata-list}` macro is partially supported by the Comala Document Management app.

```plaintext
{trigger:pageupdated}
    	{space-metadata-list}
          || Name | Comala Metadata Plugin |
          || Version | 3.5.x |
          || Product Versions | Confluence 6.x |
          || Author(s) | Captain Comala |
        {space-metadata-list}
    {trigger}
```

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

## Related macros

> Macro (contentbylabel)

## Related pages

- [Adding metadata to spaces](https://appfire.atlassian.net/wiki/spaces/COMALACM/pages/655988362)
- [Retrieving and displaying space metadata](https://appfire.atlassian.net/wiki/spaces/COMALACM/pages/655758622)
- [Using metadata in a space](https://appfire.atlassian.net/wiki/spaces/COMALACM/pages/655758361)