Report Block
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 the each of the items from a reporter in a block of wiki text.
A report block must contain two things:
- A reporter macro (such as Content Reporter or User Reporter), which finds the list of items to report on, and
- 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 | Available In | Migratable to Cloud? | Default Value | Description |
|---|---|---|---|---|---|
maxResults | | Server, Data Center |
| all | The maximum number of results to display. |
firstResult | | Server, Data Center |
| 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 | | Server, Data Center |
| 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 | | Server, Data Center |
| none | The type of separator to display between each item. May be one of the following:
|
injected | | Server, Data Center |
| false | (Since 2.0.0) If
* 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
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.
This makes use of the float macro from the Composition Plugin.
{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 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