Skip to end of metadata
Go to start of metadata

{report-block}

Plugin Version: from version 4.0.0

This plugin will display the report results in a series of blocks.

Description

The user can specify whether the plugin will separate each item with a character (e.g. a comma, a hyphen, etc.) or a completely new paragraph.

Displays the each of the items from a reporter in a block of wiki text.

A report block must contain two things:

  1. A reporter macro (such as content-reporter or user-reporter), which finds the list of items to report on, and
  2. report-body macro, which contains the wiki code which will be executed for each item. It may also optionally include a report-empty macro, which specifies what will be displayed if no items are returned from the reporter.

Usage

Wiki Markup

{code}
{report-block}

{xxx-reporter}

{report-body}
This content is repeated for each item.
{report-body}

{report-empty}This is displayed if no results are returned by the reporter.{report-empty}

{report-block}
{code}

Confluence 4+ Editor

Parameters

Name

Required

Default

Description

maxResults

all

The maximum number of results to display.

firstResult

1

_(Since 2.0.0)_ Specify the number of the first result to start displaying in the report. The first item has a number of 1.

depth

0

_(Since 1.3)_ If the item has children, the depth do display its descendents. May be 'all' for all descendents, or a whole number value above 0.

separator

none

The type of separator to display between each item. May be one of the following: * *bracket* \- Square brackets ('\[', '\]') surrounding each item. * *brace* \- Braces ('\{', '\}') surrounding each item. * *comma* \- A comma (',') between each item. * *paren* \- Parentheses ('(', ')') surrounding each item. * *pipe* \- A pipe ('\|') between each item. * *newline* \- A line break after each item. * *"custom"* \- Any other value you wish, specified between quotes.

injected

false

_(Since 2.0.0)_ If {{true}}, the report bodies will have any ''%prefix:keychain%'' values injected with values from the current report item prior to being rendered.

Notes

Examples

User profile cards

This example will display the user profile as a set of cards, filling the screen from left to right, wrapping where necessary.

Note: This makes use of the float macro from the Composition Plugin.

Keychain Injection

Output the title and excerpt of each child page. This uses injection to put data into places the report-info macro can't go, such as inside link markup or as parameters for other macros.

Recipes

No content found for label(s) +recipe,+report-block.