Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt
hiddentrue

Define metadata properties

The {set-metadata} macro is used to define metadata key=value pairs which are stored at the content-level (page or blog post).

The values can later be retrieved via the {the get-metadata} macrometadata macro, or any other plugin capable of reading metadata. In addition, the values can be used as as Value References in any macro or feature which supports them.

Where to use it?

Optional.

One or more {setset-metadata} macros can be put in a {trigger} macro.

Parameters

Parameters

Required

Default

Notes

first unnamed
parameter

(tick)


The metadata key (name by which the value can be accessed).

  • Character restrictions?
macro body

The metadata value

trim


true

Should the macro body contents be trimmed (remove whitespace)?

  • true – yes, trim (recommended)
  • false – no, leave as is

page


 current page

Where should the metadata be stored (default = current page)?

  • @parent – store on the parent page, not the current page
  • @children – store on child pages, not the current page

Note: This parameter only works on pages, not blog posts.

...

...retrieving later

You can either use the {get-metadata} macro, or a macro that supports such content.

...

(info) Metadata values created with the {set-metadata} macro are only indexed by Confluence and appear in the Confluence search if the Comala Metadata app is installed.

...