blog-posts-report macro

Owned by
Robert Alexander Marshall
Last updated: Dec 19, 2023
2 min read
1 Overview | 2 Parameters | 3 Usage | 4 Reference Markup | 5 Related Comala Metadata macros | 6 Related pages

Overview

The blog-posts-report macro generates a tabular report of all the metadata from matching blog posts in a particular space.

Parameters

Parameter

Required

Default

Notes

Version

Parameter

Required

Default

Notes

Version

value-name (unnamed first parameter)



The list of fields (columns) as a comma separated list to be included in the report. This can include Comala Metadata App added metadata and internal metadata.



key

 

 

Specifies the space from which the blog posts are listed

 

sort





Specifies which column in the report should be sorted by. You can include sort method such as

  • value-name desc

  • value-name desc

You can also specify how to treat the values:

  • as date (for internal date field) metadata only

  • as number

  • as string (makes sort case insensitive)



maxResults

 

500

Specifies a comma separated list of the metadata value names to be summed.

 

totals

 

 

Specifies a comma separate list of columns (metadata value-name (s)) to be summed.

 

Usage

To retrieve the metadata values from matching blog posts, add the Blog post macro using the Confluence macro editor:

At least one metadata value name is required to be added for the macro.

No content is required for the macro body,  the macro placeholder simply displays the entered metadata and any other options chosen.

The macro on the page displays a report for the blog posts with:

  • multiple metadata names added as a comma-separated list to create the columns in the report

  • the values for each metadata name displayed as entries in each column

The content can be limited by configuring the macro to specific spaces using the space key. If the space key is left empty, the report will default to the current space.

The values in specific columns of the report (if the retrieved values are in an applicable format) can summed by adding the metadata names in a comma-separated list in the macro editor totals option.

Reference Markup

{blog-posts-report:Poster,Blog Post,Time, Comments|sort=Blog Post asc|maxResults=3}

This displays the following on the page.