This section describes the parameters available in templates used to generate reports.
The following parameters are always available.
Parameter
| Description
|
| REPORT-NAME | The report's name. |
| REPORT-DESCRIPTION | The report's description. |
| REPORT-TIME | The time the report was generated. |
| REPORT-FILENAME | The file the report is being saved to. |
| CHANNEL-FILTER-NAME | The channel filter being used to select channels to include in the report. |
| WORKPAD-NAME | The workpad the report is being generated from. |
| TEMPLATE-FILENAME | The template file being used to generate the report. |
| GROUP-ITEMS-BY-CHANNEL | Flags if items should be grouped by channel. |
| WATERMARK-IMAGE-URL | The file path to the watermark image. |
The following parameters are available inside a Channels or Channels-IfGroupingItems repeating section.
Parameter
| Description
|
| CHANNEL-METADATA | Inserts channel metadata.
This parameter is the main way of accessing information about the channel.
|
| CHANNEL-METADATA-TYPE | Inserts the type of the specified channel metadata (text/html/unknown).
This parameter is most useful when used with a mode=atom10 argument which restricts the output to "text" or "html", making it suitable for generating Atom 1.0 output.
|
The following parameters are available inside a FeedItems repeating section.
Parameter
| Description
|
| ITEM-METADATA | Inserts item metadata.
This parameter is the main way of accessing information about the item.
|
| ITEM-METADATA-TYPE | Inserts the format of the specified item metadata (text/html/unknown).
This parameter is most useful when used with a mode=atom10 argument which restricts the output to "text" or "html", making it suitable for generating Atom 1.0 output.
|
| ITEM-METADATA-DUMP | Inserts the item's metadata tree.
This is useful when writing new templates and you want to see what metadata the item has.
|
| ITEM-IMAGE-URL | Inserts the URL for the item's image. |
The following parameters are available in workpad reports only.
Parameter
| Description
|
| WORKPAD-NAME | The name of the workpad. |
| WORKPAD-DESCRIPTION | The workpad's description. |
| ITEM-NOTES | Any notes that have been entered by the user for the feed item. |
The following parameters are available inside a CustomFields repeating section.
| CUSTOM-FIELD-NAME | The name of the current custom field. |
| CUSTOM-FIELD-NAME | The value of the current custom field. |