CSV Macro

Description

Convert csv and other deliminated data into a Confluence table. CSV is not a formal standard, but the best reference is The Comma Separated Value (CSV) File Format. The support in this macro comes close to following this pseudo-standard (see SCRP-16).

Documentation

Parameters

In addition to the parameters listed below, this macro supports Common table capabilities.

• output - Determines how the output is formated:
  • html - Data is output as a HTML table (default).
  • wiki - Data is output as a Confluence wiki table. Use this option if you want data within the table to be formated by the Confluence wiki renderer.
• script - Location of csv data. Default is the macro body only. If a location of data is specified, the included data will follow the body data.
  • #filename - Data is read from the file located in /script/filename. Subdirectories can be specified.
  • global page template name - Data is read from a global page template.
  • space:page template name - Data is read from a space template.
  • ^attachment - Data is read from an attachment to the current page.
  • page^attachment - Data is read from an attachment to the page name provided.
  • space:page^attachment - Data is read from an attachment to the page name provided in the space indicated.

    Subject to change Expect changes to the script parameter name and how included data is referenced in the future.

• heading - Number of rows to be considered heading rows (default is 1 row). Specify heading=false or heading=0 to not show any heading lines. Heading rows do not participate in sorting.
• border - The border width in pixels. Defaults to normal table border width.
• width - The table width in pixels. Default is 100%.
• delimiter - Delimiter that separates columns.
  • , (comma) - The default column separator.
  • whitespace - Blanks, tabs, and other white space are used to separate columns.
  • blanks - Blank or blanks only.
  • pipe - '|'
  • other single character delimiter - may be within double quotes with some restictions. Examples: ";" and "=" work. "|" does not.
• quote - the character used to represent quoted data. Quoted data may contain delimiters or new lines. Quote character data must be doubled inside a quoted string.
  • double - Double quote character (default).
  • single - Single quote character.
• escape - The '|' character in data can cause formatting of the table to be incorrect because it is interpreted as a column boundary. Set escape=true to allow this character to be escaped so that it will not affect the formatting. The default is false so that things like wiki links are handled correctly.
• showWiki - Default is false. Set to true to show a non-formatted version of the wiki table following the formatted table. This is used to help resolve formating issues.

Adding headings to existing data

• The body of the macro will be added to the top of any included data from attachments, so heading text can be added to data that does not have headings.

Usage Examples

Simple comma separated data

{csv}
 , January, February, March, April
Max, 37.5, 32.7, 28.0, 25.3
Min, 31.3, 26.8, 25.1, 18.7
{csv}

Whitespace separated data with wiki formating

{csv:output=wiki|width=900|border=15|delimiter=whitespace}
Month Max Min Average
January 25.5 *6.3* 15.9
February 32.4 12.8 22.6
March 44.6 24.5 34.6
April 59.7 37.1 48.4
May 72.5 48.7 60.6
June 81.3 57.9 69.6
July 85.2 62.8 74
August 82.5 60.7 71.6
September 73.7 51.7 62.7
October 61.1 40.1 50.6
November 43.6 27.4 35.5
December 29.9 13.6 21.8
{csv} 

Compatibility With Other Macros

• Confluence Chart Plugin - can be used to create data for a chart
• Beanshell Macro - to generate csv macro and data as output from Java code (use output=wiki)
• Groovy Macro - to generate csv macro and data as output from Groovy code (use output=wiki)
• Jython Macro - to generate csv macro and data as output from Jython code (use output=wiki)

Open Issues with this component