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 is a value that must exist in metadata tags in at least two other pages

  • the Y-axis 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 value that exists on the pages. Again this must be present for at least two of the pages.

Parameters

Parameter

Required

Default

Notes

Version

Parameter

Required

Default

Notes

Version

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 will populate 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 of blog post to limit the content for the macro table to only that type of content

 

function





Specifies the value returned for the cell body using from 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 that will be used to populate the cells of the table body.

In the example, the macro is displaying the Jan Hours metadata value recorded for each of the Project Lead metadata values. The Y Value field identifies the name of the app.

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

Reference Markup

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

The macro will retrieve 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 corresponding header row (x-axis) and header column (y-axis) cell of the table.

Related Comala Metadata App macros

Related documentation