blog-posts-report macro

blog-posts-report macro

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) is a comma-separated list to be included in the report. This can include Comala Metadata app custom 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 a 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-separated 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.

Macro editor - Blog post report macro with added fields and space key

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 as a comma-separated list to create the columns in the report

  • Values for each metadata name 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 defaults to the current space.

The values in specific columns of the report (if the retrieved values are in an applicable format) can be 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.

Rendered blog post report including comments

Related macros

Related pages

Need support? Create a request with our support team.

Copyright © 2005 - 2025 Appfire | All rights reserved.