Description
Augments are a new capability starting with plugin version 6.0. They are a set of macro parameters that provide the ability to augment the data found in the table with additional columns derived from other information available. More capabilities are planned for the future. This is supported by the CSV macro for version 6.0. The list of supported replacements in version 6.0 follows later.
Why would you use augments? In some cases, you may have little control over how the data is produced. For instance, importing csv files produced by external processes. The data may not be in the best format for displaying in Confluence. In some cases, if the data could be changed in minor ways, then it would be shown better in Confluence. For instance, links could be added or data manipulated more accurately reflect the context.
Examples
- Augment examples
- Example output with augments - JCLI output examples
Parameters
Parameter | Default | Macro Browser Label | Description |
|---|---|---|---|
| augments | Augments to data row values | Comma separated list of augments to the data, one for each column. | |
| headingAugments | Augments to heading row values | Comma separated list of augments to the data, one for each column. | |
| footingAugments | Augments to footing row values | Comma separated list of augments to the data, one for each column. | |
| columns | Columns to show | Comma separated list of column names or numbers in any order. Defaults to all columns in existing order. Columns are enumerated starting at 1. For augment support, use * to represent a augmented column to be added. |
Replacement
Replacement keys enclosed in % will have replacements as indicated below. Example: %#% will be replaced by the current row number.
| Key | Replacement | Difference if heading or footing row? |
|---|---|---|
| * | original value | |
| empty | original value | |
| blank | blank | |
| # | row number (starting at 1 for the first data row) | blank |
| number | value of the column identified by column number (1 based) | |
| name | value of the column identified by column name lookup if valid | |
| ! | | (may be needed when using wiki markup) | |
| [ | { (may be needed when using wiki markup) | |
| ] | } (may be needed when using wiki markup) |
