metadata-table macro

Overview

The metadata-table macro produces tabular reports of metadata from matching pages in a two-dimensional matrix format.

For the two-dimensional matrix, the:

X-axis (X Value) is a value that must exist in metadata tags in at least two other pages
Y-axis (Y Value) is a value that must exist in metadata tags in at least two other pages

The cells of the tabular report are the values of the metadata on the pages. Again, this must be present on at least two of the pages.

Parameters

Parameter	Required	Default	Notes	Version

Parameter	Default	Notes
`X Value`		Metadata value name for the x-axis of the tabular data that must be present in at least two of the pages.
`Y Value`		Metadata value name for the y-axis of the tabular data that must be present in at least two of the pages.
`Value`		Metadata value name that populates the cell body of the table that must be present in at least two of the pages.
`Label`		Page label to filter results of the macro. Limits the content to only that which has the specified label(s).
`pages`	`children`	Limits content to a group of pages: `@children` `@ancestors` `@descendents` `@identity`
`root`	`current`	Use `@self` for the current page (the default), `@parent` for the parent page, or the name of any page
`type`	`page`	Use `page` or `blog post` to limit the content for the macro table to that type of content
`function`		Specifies the value returned for the cell body using each value of the metadata `Value` `sum` `count` `min` `max` `text`

Usage

To retrieve the values for of pages with a particular metadata for the table X-axis and Y-axis

Choose the Metadata table macro from the Confluence macro browser:

In the macro editor, add the metadata value names for each of the X Value, Y Value, and the Value parameters. These are used to populate the header row and header column cells of the table

Macro editor - Metadata table macro with X Value, Y Value, and Value parameter values

In the example, the macro displays the Jan Hours metadata value recorded for each of the X-Value Project Lead metadata values. The Y Value field differentiates the values by the Name of the app against which these hours have been recorded.

The macro returns one value for each of the table cells on each page. Using multiple values of the same metadata on a page results in inconsistent results, as only the value is returned for the first metadata encountered.

Reference markup

{metadata-table:Atlassian Product,Name,Installs}

The macro retrieves the Installs metadata values for the child pages of the current page.

These are displayed in tabular form for matching pages in a two-dimensional matrix.

The matrix is created using the other metadata names:

Product Name with values of Confluence and Jira
Name with values for each of the apps

Each entry in the matrix is from the page with the metadata values in the corresponding header row (x-axis) and header column (y-axis) cell of the table.

Related macros

Related pages

Adding, retrieving and displaying metadata