Description
This macro outputs specific information about an item being reported on.
When used in a report, it will report on the current item. When used outside a report, it will report on the current page by default, or the content referred to by the source parameter.
It can handle regular text, dates, numbers, booleans (true/false), and lists, as well as any other object which has a default value specified in a Supplier.
Parameters
Name | Required | Migratable to Cloud? | Default Value | Description |
|---|---|---|---|---|
key/[default] |
|
| The key chain to retrieve for the item. A key chain is a list of prefix:key values separated by ">" characters. e.g.:content:creator > user:name See the Suppliers for Reporting page for more details on what options are available. | |
link |
|
| false | If set to true and the current item/key has a URL link, the text generated will be linked to that URL. |
source |
|
| The source to retrieve information for. By default, this will be the current report item if in a report, or the current page if not in a report. May be "@self" (the current page) or a link to other content (e.g.: "SPACEKEY:Page Name", "PageName^attachment.ext"). | |
format |
|
| The date (eg. 'dd MMM, yyyy') or number (eg. '#,##0.00') format to display the item in. This will only be used if the data is a date or a number, respectively. Otherwise, it will be ignored. | |
render |
|
| none | If set to wiki, the generated text will be rendered as wiki text. Otherwise, it will be output as written. |
info (Hover Text) |
|
| (Since 3.4.0) The text which will be displayed when the user hovers their mouse over the link. | |
separator |
|
| comma | The type of separator to display between each item, if the key value pointed to is a collection of other items. May be one of the following:
|
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 the macro can also be used, if more complex wiki text is required. |
Editor View
Not applicable.
Macro Edit View
Not applicable.
Notes
Not applicable.