report-body - Atlassian Plugins

report-block

Macros

report-column

{report-body}

Plugin: Reporting Plugin, from version 1.0

This macro contains the wiki code which will be executed for each item of the surrounding report.

Description

It is used by the report-block and report-list macros. It will usually contain one or more uses of the report-info macro to display reported values.

Usage

{report-body}Wiki content goes here.{report-body}

Parameters

Name	Required	Default	Description
trim		false	If set to `'true'`, the body will be have any whitespace at the beginning or end trimmed before being displayed.
injected		false	(Since 2.0.0) If set to true, the body will have any '%prefix:keychain%' values injected with values from the current report item prior to being rendered.

Examples

List children of the current page

{report-list}

{content-reporter:scope=@self > children}
   {text-sort:content:title}
{content-reporter}

{report-body}{report-info:content:title|link=true}{report-body}

{report-list}

Keychain Injection

Output the title and excerpt of each child page. As you can see, you can mix injected properties and standard {report-info} calls.

{report-block}
{local-reporter:content:children}
{local-reporter}
{report-body:injected=true}
h2. %content:title%
{report-info:content:excerpt|render=wiki}
{report-body}

{report-block}

Conditional display

From Reporting 2 onwards {report-body} can be displayed conditionally based on filters (e.g. text-filter). This is done by putting any filters the current item must match immediately before the {report-body} definition. For example:

{report-block}
{local-reporter:content:children}

{report-body}This is always output.{report-body}

{text-filter:content:title|include=FOO.*}
{user-filter:content:creator|user=bob}
{report-body}Only children who's title starts with FOO and were created by Bob will have this displayed.{report-body}

{report-body}This is always output too.{report-body}

{report-block}

Recipes

Aggregate news report recipe - Display news items from across multiple spaces.
Custom children list recipe - Display the list of children for a page with customised details displayed.
Include all child pages recipe - Includes the wiki content of all children of a page, headed by the page title and a link to edit the page.
Space Labels Recipe - Display a list of all labels in each space, and the content with each label.
Space list recipe - Display a list of spaces available in a custom format using the Reporting Plugin.
User contact cards - Display user contact details using a contact card-style layout.