report-table

{report-table}

Plugin: Reporting Plugin

Displays the each of the items from a reporter in a table.

Description

A report table 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. one or more report-columns must be present to define what data is displayed.

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

{xxx-reporter}

{report-column:title=Key 1}{report-info:item:key 1}{report-column}
{report-column:title=Key 2}{report-info:item:key 2}{report-column}

{report-empty}This is displayed if no results are returned by the reporter.{report-empty}

{report-table}

Parameters

Name Required 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.
class
The CSS class to render the table with.
displayTitles
true
If set to false, the title header row will not be displayed. (Since Reporting 1.0.1)
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. (Since Reporting 1.3)

See Also

Labels

macro macro Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.