report-link

Macros

report-on

{report-list}

Plugin: Reporting Plugin

Displays the each of the items from a reporter as a list item.

Description

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.

Usage

{report-list:depth=[1,2...all]|outline=true/false|style=[disc, decimal, etc]}

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

Parameters

Name	Required	Default	Description
style		disc/decimal	The style of bullet to display. May be any standard CSS style. Defaults to 'disc' if outlining is off, or 'decimal' if outlining is on.
outline		false	If set to 'true', the list and any sub-lists of children will be displayed with an outline number format (eg. "1.2.3"). Note: This setting will only display correctly in FireFox.
separator		"."	The type of separator to display between each number in outline view. 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 character you wish, specified between quotes.
depth		0	If the item has children, the depth do display its descendents. May be 'all' for all descendents, or a whole number value above 0.
trim		true	If 'false', the body will not have whitespace trimmed from the beginning and end.
maxResults		all	Sets the number of results which will be displayed in this report. If depth is 1 ore more, this will apply to the number of children displayed for each item. So if you have 10 items, each with 10 children, and you set maxResults to 5, there will be 30 items output - 5 at the root level, and 5 for each set of children. (Since 2.0.0)
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.
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.

Recipes

• Custom children list recipe - Display the list of children for a page with customised details displayed.

See Also

• report-body

report-link

Macros

report-on