---
title: "Report Block"
canonical: "https://support.appfire.com/space/REPS/472914906/Report%20Block"
format: markdown
---
> Macro (aura-html)

## Description

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

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 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. A 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.

## Parameters

| Name | Required | Migratable to Cloud? | Default Value | Description |
| --- | --- | --- | --- | --- |
| maxResults | - [(X)] | - [NO] | all | The maximum number of results to display. |
| firstResult | - [(X)] | - [NO] | 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 | - [(X)] | - [NO] | 0 | *(Since 1.3)* If the item has children, the depth do display its descendants. May be **all** for all descendants, or a whole number value above 0. |
| separator | - [(X)] | - [NO] | newline | The type of separator to display between each item. May be one of the following:<br>- **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 | - [(X)] | - [NO] | 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.<br>- It is a good practice to set the Injection to true at on {report header}, {report body}, {report footer}, or {report column}, instead on the highest level of the report. |

## Editor View

- Not applicable.

## Macro Edit View

- Not applicable.

## Notes

## Examples

### User profile cards

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

> ⚠️ This makes use of the [float macro](https://appfire.atlassian.net/wiki/spaces/CTFCSM/pages/1561725401).

```
{report-block}
{user-reporter}
   {text-sort:user:full name}
{user-reporter}
 
{report-body}
{float:left}
{report-image:user:picture|width=16px|height=16px} *{report-info:user:full name}*
*Username:* {report-info:user:name}
*Email:* {report-info:user:email|link=true}
*Homepage:* {report-link:user:url}Link{report-link}
*Groups:* {report-info:user:groups}
{float}
{report-body}
 
{report-block}

```

### Keychain Injection

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

```
{report-block:injected=true}
{local-reporter:content:children}
{local-reporter}
 
{report-body}
h2. [%content:title%|%content:title%|Visit the page]
%content:excerpt > render wiki%
{report-body}
 
{report-block}
```

# Tutorial Examples

> Macro (contentbylabel)

#