report-block

repeating-data

Macros

report-body

Get Satisfaction support network

{report-block}

Plugin: Reporting Plugin, from version 1.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:

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.

Usage

{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}

Parameters

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

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.

{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 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}

report-block

Discussion