Table Plugin

Name	Table Plugin
Vendor	Bob Swift and other contributors
Authors	Bob Swift
Homepage	http://confluence.atlassian.com/display/CONFEXT/Table+Plugin
Issue Management	http://developer.atlassian.com/jira/browse/TBL
Categories	Content Macros
Version	3.3.1
Availability	Confluence v2.4.2 to v2.10-m1
State	Stable
Support
License	Freeware / Open Source (BSD)
Price	Free
Release Docs	http://confluence.atlassian.com/display/CONFEXT/Table+Plugin
Java API Docs	n/a
Download Source	http://svn.atlassian.com/svn/public/contrib/confluence/table-plugin/trunk
Download JAR	table-plugin-3.3.1.jar

Additions and corrections to above

JVM requirements	Java 1.4 and above
Installation requirements	Confluence Repository Client or upload from Confluence's administration console. Cannot be installed in /WEB-INF/lib

Description

A collection of macros dealing with enhanced table capability in Confluence.

Macros

• CSV Macro - Convert comma separated (csv) and other delimited data into a Confluence table.
• Table-plus macro - Adds column sorting and other attributes to wiki or other tables

Common table based capabilities and parameters

A number of macros that produce or modify tables share common capabilities. This page documents the behavior and parameters for these capabilities. A JavaScript enabled browser is required to enable these capabilities.

Macros that include this support

• Table-plus macro
• CSV Macro
• Excel Plugin
• SQL Plugin

Capabilities

• Column sorting - sort a column by clicking on column heading. Clicking again will reverse the order. Auto sorting before display
• Row highlighting on mouse over - row is highlighted when mouse goes over any row element for non-heading rows
• Column attributes - ability to set the display attributes (color, font) on a column basis
• Auto numbering - ability to automatically add a leading column with the data row count.

Parameters

• 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.
• footing - Number of rows to be considered footing rows (default is 0). Footing rows do not participate in sorting. An auto total row is automatically treated as a footing row.
• enableSorting - Set enableSorting=false to prevent sorting
• enableHighlighting - As the mouse moves over a table row, the row will be highlighted by default. Set enableHighlighting=false to stop this behavior. This parameter was formerly known as highlightRow which still works.
• sortColumn - The table can be auto sorted before it is displayed by any valid column name or number provided by this parameter. No auto sorting will be done if this value is not provided or is invalid. A column number is a 1-based count of columns (excluding auto number column).
• sortDescending - If sortDescending=true, the sort indicated by the sortColumn will be done in reverse order.
• sortTip - Text that is used to provide user feedback with mouse is over a column heading that is sortable. Default text is: "Click to sort" followed by the column name if available.
• sortIcon - Default is false to not show sort indicator icon. Set sortIcon=true to include a sort icon in the first heading row for sortable columns. An icon will show for the last column sorted indicating the direction the column was sorted.
• highlightColor - Color of row when mouse is over a row element. See the notation guide or Web colors for how to specify.
• autoNumber - If autoNumber=true, an additional column will be added that will count each data row.
• autoNumberSort - If autoNumberSort=true, the auto number column will be sortable and will retain the original data row count even after row sorting.
• autoTotal - If autoTotal=true, an additional row will be appended to the end of the table that will contain totals of all numeric columns.
• autoNumberSort - If autoNumberSort=true, the auto number column will be sortable and will retain the original data row count even after row sorting.
• columnTypes - By default, all columns are treated as strings for sorting purposes unless a more specific sort type is provided either by the macro logic or by this parameter. The parameter is a comma separated list of column type indicators to identify column types.
  • S - string
  • I - integer
  • F - float
  • C - currency or similar where it is a float value with pre or post characters
  • D - date in the browser date format. See advancedDate for more information.
  • X - exclude this column from user selectable sorting
  • H - hide the column
  • . or - or : or / - separated numbers, like phone numbers or TCP addresses. Valid values are multiple integer numbers separated by one of the separators indicated by the type.
• columnAttributes - A comma separated list of values used to modify cell attributes for all cells in a column. The position in the comma separated list corresponds to the column that the values apply to. Each value is a double semi-colon list of attributeName=value pairs that will be applied to the column cells.
• enableHeadingAttributes - By default, any column attributes provided will be applied to the all column rows including heading rows. Set enableHeadingAttributes=false to have the column attributes apply only to data rows.
• id - Sets the table id for the table for use in macros (like the chart macro) to identify a specific table.

Advanced date sorting

The default date handling (using the D column type) provides support for the browser default date format. This may not
work properly for tables that have date format that are different than the default format set for individual browsers. More advanced and automatic capabilities are possible by installing a specific date handling library. Documentation and source for the library can be found at JavaScript Toolbox. Install the date.js file on your Confluence server in .../includes/js directory.

Once the date library is installed, the D column type will now match successfully on many different date formats. Alternatively, setting a column type of D followed by a valid date format. Note that date formats that contain a comma (,), must be enclosed in a double quote.

Date examples:

Note that the date library is in English for date formats that include characters. It is possible to easily modify the date library for other languages before installing it on your server.

Examples

{table-plus:columnTypes=S,-,.|autoNumber=true|sortColumn=3
|columnAttributes=,,style="background:yellow; font-size:14pt;"}
|| Name || Phone || TCP ||
| John | 555-1234 | 192.168.1.10 |
| Mary | 555-2134 | 192.168.1.12 |
| Bob | 555-4527 | 192.168.1.9 |
{table-plus}

which renders as:

Version History

• Previous versions were included in Scripting and External Content Macros

Release Notes

• 3.3.1
  When: 15-Jul-2007
  Who: Bob Swift
  What:

  Atlassian Developer Network JIRA (1 issues)
  T	Key	Summary	Reporter	Assignee	Pr	Status
  	TBL-35	autonumbersort=true not sorting as numbers	Bob Swift	Bob Swift		Resolved

• 3.3.0
  When: 22-Jun-2007
  Who: Bob Swift
  What:

  Atlassian Developer Network JIRA (6 issues)
  T	Key	Summary	Reporter	Assignee	Pr	Status
  	TBL-34	Update to 2.4.x API level	Bob Swift	Bob Swift		Closed
  	TBL-33	Maven2 build environment	Bob Swift	Bob Swift		Closed
  	TBL-32	Table header not recognized if thead used instead of tr	Chris Hatch	Bob Swift		Closed
  	TBL-31	Sort order should be AaBbCc instead of ABCabc.	Bernhard Neuhauser	Bob Swift		Resolved
  	TBL-30	Table plus and reporting macro break sorting	Pim van Meurs	Bob Swift		Resolved
  	TBL-29	table plus features do not work if table cells contain tables via an include or metadata-report	James Mortimer	Bob Swift		Resolved

Open Issues

New issue tracking JIRA project

Atlassian Developer Network JIRA (25 issues)
T	Key	Summary	Reporter	Assignee	Pr	Status
	TBL-55	Provide way to freeze first column and/or first row	Jeff Schnitter	Bob Swift		Open
	TBL-54	XSS Vulnerability	Maleko Taylor	Bob Swift		Open
	TBL-53	autofilter	James Mortimer	Bob Swift		Open
	TBL-52	Create a 'groupby' parameter that will create a grouping based on one of the columns	James Mortimer	Bob Swift		Open
	TBL-51	Table-Plus cannot use a CSS to define propeties "ie HighlightColor"	Michael Webster	Bob Swift		Open
	TBL-50	Allow more than one sorting column, with priority	Steven Currie	Bob Swift		Open
	TBL-48	Column split/merge	Tim Mann	Bob Swift		Open
	TBL-47	Add support for Mac style end of line	flabrie	Bob Swift		Open
	TBL-46	Add support for charset encoding	flabrie	Bob Swift		Open
	TBL-45	Add number format option for totals	Bob Swift	Bob Swift		Open
	TBL-44	Common table features sometimes lost when wrapped in cache macro	jeff branc	Bob Swift		Open
	TBL-43	To display limited number of rows from a .csv file on a page...the remaining are to be displayed on clicking some icon(show more)..	ria ninan	Bob Swift		Open
	TBL-42	Unwanted Random {table-plus} Highlighting Seemingly Has No Cause	Matt Bovett	Bob Swift		Open
	TBL-41	Advanced Date Formats do not work correctly	Frank Stiller	Bob Swift		In Progress
	TBL-40	Add ability to select and order columns	Bob Swift	Bob Swift		Open
	TBL-39	Support sorting of columns that have more complex HTML	Andy Armstrong	Bob Swift		Open
	TBL-38	Links to pages not being renamed		Bob Swift		Open
	TBL-37	including code/panel macros insidie table-plus results in disappearing text when going into edit mode	Sandy R	Bob Swift		Open
	TBL-36	{table-plus} incompatible with output from {report-table}	Shawn Stepper	Bob Swift		Open
	TBL-28	Confluence 2.4.3 and TBL 3.2.1 Icons disappear, sorting stops working	Pim van Meurs	Bob Swift		Open
	TBL-27	Set CSS properties for all elements	Jonathan Nolen	Bob Swift		Open
	TBL-26	Alternating row colors	Jonathan Nolen	Bob Swift		Open
	TBL-25	cellpadding settting seems to have no effect	Jonathan Nolen	Bob Swift		Open
	TBL-22	Setting table border to zero still has gray border of 1 pixel	Ross Niemi	Bob Swift		Open
	TBL-13	Option for making new order persistent	Robert Senger	Bob Swift		Open