Report List

Description

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

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

NameRequiredAvailable InDefault ValueDescription

style

 (error)

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

 (error)

false

If set to true, the list and any sub-lists of children will be displayed with an outline number format (e.g.: "1.2.3").

This setting will only display correctly in FireFox.

depth

 (error)

0

If the item has children, the depth do display its descendants. May be all for all descendants, or a whole number value above 0.

trim

 (error)

true

If false, the body will not have whitespace trimmed from the beginning and end.

maxResults

 (error)

all

(Since 2.0.0) Sets the number of results which will be displayed in this report.

If depth is 1 or 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.

firstResult

 (error)

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.

injected

 (error)

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. 

class

 (error)


(Since 3.2.0) The CSS class to apply to the report.


Editor View

Tutorial Examples