{report-on}
Plugin: Reporting Plugin
Sets the report item context to the item/key value specified.
Description
This is useful when you wish to display several key values from a sub-item of the item currently being reported on. For example, you may wish to the full name and email address of the current page's last modifier:
{report-on:content:modifier}
Last Modifier: {report-info:user:full name|link=true} ({report-info:user:email|link=true})
{report-on}
Also, it will automatically loop multiple values if the supplied key is a collection or iterator, rendering the contents against each item.
Usage
{report-on:item:key}
Sub-Item 1: {report-info:item:subkey 1}<br/>
Sub-Item 2: {report-info:item:subkey 2}<br/>
{report-on}
Parameters
| Name | Required | Default | Description |
|---|---|---|---|
| [default]/key |  | @self
| The key value to display. Defaults to '@self' (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 item prior to being rendered. If the current value being reported on is a collection, the injection will happen on each collection item as it is processed. |
| default | | The contents of this parameter will be used if the item/key is empty. It will be rendered as wiki text. Alternately, the body of macro can also be used, if more complex wiki text is required. | |
| separator | | comma
| If the item/key points to a list of results, the type of separator to display between each item. May be one of the following:
|
| trim | | true
| If false, the whitespace at the beginning and end of the body will not be removed. |
Discussions