Table Plugin

Gives extra control of table display:

  • Allows sorting
  • Changing table properties like border width, cell spacing and cell padding
  • Changing background color and text color for header cells
  • Changing background color and text color for data cells - colors can alternate
  • Table attributes can be set and overridden in this order:
    • Default TABLEATTRIBUTES Plugin setting in this topic.
    • A TABLEATTRIBUTES preferences setting on site-level (SitePreferences) or web-level (any WebPreferences), e.g.
      • Set TABLEATTRIBUTES = tableborder="0" cellpadding="1" ...
    • Before a table using %TABLE{...}%
  • Row spans

Sorting

Click on column heading text to sort by a column. Initial column will be sorted in descending order, click again to get ascending order. The type of data in the cell is determined automatically:

  • Date with supported date formats View date formatsView date formats
    • Default Foswiki format
      • 31 Dec 2001 - 23:59
      • 31-Dec-2001 - 23:59
    • Foswiki format without time (defaults to 00:00)
      • 31 Dec 2001
      • 31-Dec-2001
    • Date separated by '/', '.' or '-', time with '.' or ':'
    • Date and time separated by ' ', '.' and/or '-'
      • 2001/12/31 23:59:59
      • 2001.12.31.23.59.59
      • 2001/12/31 23:59
      • 2001.12.31.23.59
      • 2001-12-31 23:59
      • 2001-12-31 - 23:59
      • 2009-1-12
      • 2009-1
      • 2009
    • ISO format
      • 2001-12-31T23:59:59
      • 2001-12-31T
    • ISO dates may have a timezone specifier, either Z or a signed difference in hh:mm format. For example:
      • 2001-12-31T23:59:59+01:00
      • 2001-12-31T23:59Z
  • Number is digits, with optional decimal point
  • Otherwise treated as text

Row spans

Table cells with a single caret indicate follow-up rows of multi-row spans. For example,

| One One | One Two | One Three |
| ^ | Two Two | Two Three |
| Three One | ^ | Three Three |
One One One Two One Three
Two Two Two Three
Three One Three Three

TablePlugin Global Settings

You can override the default settings for the plugin by defining the following preferences.

Preference Meaning Default
TABLEPLUGIN_SORT Make all tables in a topic sortable. If this is set to all, all tables that have a header row (including those that do not have %TABLE before them) will be made sortable. If set to none, only tables with %TABLE will be sortable. Topic rendering is faster if this is set to none. all
TABLEPLUGIN_TABLEATTRIBUTES Default table attributes tableborder="1" cellpadding="0" cellspacing="0" valign="top" headercolor="#ffffff" headerbg="#687684" headerbgsorted="#334455" databg="#ffffff,#edf4f9" databgsorted="#f1f7fc,#ddebf6" tablerules="rows"

Table Attributes

Attributes are defined as a TABLEATTRIBUTES preference, or on the line before the table using %TABLE{...}%:

  • Supported attributes:
    Argument Comment Default value Example
    sort Set table sorting by clicking headers "on" or "off". unspecified sort="on"
    initsort Column to sort initially ("1" to number of columns). unspecified initsort="2"
    initdirection Initial sorting direction for initsort, set to "up" (descending) or "down" (ascending). unspecified initdirection="up"
    disableallsort Disable all sorting, both initsort and header sort. This is mainly used by plugins such as the EditTablePlugin to disable sorting in a table while editing the table. unspecified disableallsort="on"
    headerbg Header cell background colour. "#6b7f93" headerbg="#999999"
    headerbgsorted Header cell background colour of a sorted column. the value of headerbg headerbgsorted="#32596c"
    headercolor Header cell text colour. "#ffffff" headercolor="#0000cc"
    databg Data cell background colour, a comma separated list. Specify "none" for no colour, that is to use the colour/background of the page the table is on. "#edf4f9,#ffffff" databg="#f2f2f2,#ffffff"
    databgsorted Data cell background colour of a sorted column; see databg. the values of databg databgsorted="#d4e8e4,#e5f5ea"
    datacolor Data cell text colour, a comma separated list. unspecified datacolor="#0000CC, #000000"
    tableborder Table border width (pixels). "1" tableborder="2"
    tableframe Table frame, set to "void" (no sides), "above" (the top side only), "below" (the bottom side only), "hsides" (the top and bottom sides only), "lhs" (the left-hand side only), "rhs" (the right-hand side only), "vsides" (the right and left sides only), "box" (all four sides), "border" (all four sides). unspecified tableframe="hsides"
    tablerules Table rules, set to "none" (no rules), "groups" (rules will appear between row groups and column groups only), "rows" (rules will appear between rows only), "cols" (rules will appear between columns only), "all" (rules will appear between all rows and columns). unspecified tablerules="rows"
    cellpadding Cell padding (pixels). "0" cellpadding="0"
    cellspacing Cell spacing (pixels). "0" cellspacing="3"
    cellborder Cell border width (pixels). unspecified cellborder="0"
    valign Vertical alignment of cells and headers, set to "top", "middle", "bottom" or "baseline". unspecified valign="top"
    headervalign Vertical alignment of header cells; overrides valign. unspecified headervalign="top"
    datavalign Vertical alignment of data cells; overrides valign. unspecified datavalign="top"
    headeralign Header cell alignment, one value for all columns, or a comma separated list for different alignment of individual columns. Set to "left", "center", "right" or "justify". Overrides individual cell settings. unspecified headeralign="left,right"
    dataalign Data cell alignment, one value for all columns, or a comma separated list for different alignment of individual columns. Set to "left", "center", "right" or "justify". Overrides individual cell settings. unspecified dataalign="center"
    tablewidth Table width: Percentage of window width, or absolute pixel value. unspecified tablewidth="100%"
    columnwidths Column widths: Comma delimited list of column widths, percentage or absolute pixel value. unspecified columnwidths="80%,20%"
    headerrows Number of header rows to exclude from sort. (will be rendered in a HTML thead section) "1" headerrows="1"
    footerrows Number of footer rows to exclude from sort. (will be rendered in a HTML tfoot section) "0" footerrows="1"
    id Unique table identifier string, used for targeting a table with CSS. tableN (where N is the table order number on the page) id="userTable"
    summary Table summary used by screenreaders: A summary of what the table presents. It should provide an orientation for someone who listens to the table. unspecified summary="List of subscribed users"
    caption Table caption: A title that will be displayed just above the table. unspecified caption="Users"

The %TABLE{...}% settings override TABLEATTRIBUTES preferences settings, which override the TABLEATTRIBUTES Plugin settings.

The setting disableallsort is normally not used as a TABLE or TABLEATTRIBUTES setting. Plugins such as EditTablePlugin dynamically sets disableallsort to disable sorting while editing a table. For this to work it is important that EditTablePlugin runs before TablePlugin, which is the default. The setting sort can be overwritten by a URL parameter or hidden formfield of the same name. Plugins such as EditTablePlugin can use this to disable table header sorting while in edit mode.

Examples

Use of %TABLE{...}%

Line before table: %TABLE{ sort="on" tableborder="0" cellpadding="4" cellspacing="3" cellborder="0" headerbg="#D5CCB1" headercolor="#666666" databg="#FAF0D4, #F3DFA8" headerrows="2" footerrows="1" }%

Table with two Header Rows and Footer Row
Num Status Action Who When Progress
Num Status Action Who When Progress
1 C Chose new colours John 1-Dec-02  
2 X Release John 1-Apr-02  
3   Get feedback Anne 1-Feb-02  
12 C Spec error handling Jack 1-Dec-02  
5   Abc John    

Table with 4 digit year dates and no use of %TABLE{...}%

When
1-Jan-2004
1-Jan-2003
2-Jan-2005

TablePlugin and CSS

Information for programmers.

TablePlugin implements the following precedence:

  • the TABLEATTRIBUTE settings only write html styling, no CSS
  • the TABLEATTRIBUTE settings can be overridden by a skin's CSS
  • the TABLE tag attributes are converted to CSS styling, written in the head; these override any skin's CSS

CSS written by TablePlugin

.foswikiTable The table
.foswikiSortedCol A sorted column
.foswikiSortedAscendingCol Sorted column, ascending
.foswikiSortedDescendingCol Sorted column, descending
.tableSortIcon The sort icon holder (span)
.foswikiFirstCol The first column
.foswikiTableEven Even numbered rows
.foswikiTableOdd Odd numbered rows
.foswikiTableCol + column number Unique column identifier, for instance: foswikiTableCol0
.foswikiTableRow + type + row number Unique row identifier, for instance: foswikiTableRowdataBg0

Plugin Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

  • Test if the plugin is correctly installed:
    • Check above example if the table renders as expected
    • Try click on heading to sort. Other tables should also be sortable

Plugin Info

Copyright: Copyright (C) 2001-2008 TWiki:Main/JohnTalintyre, Peter Thoeny, peter@thoeny.org and TWiki Contributors; © 2008-2009 Foswiki Contributors
License: GPL (GNU General Public License)
Version: 5755 (2009-12-08)
Release: 1.044
Change History:  
08 Dec 2009 1.044: Arthur Clemens: Improved documentation for date formats.
21 Sep 2009 1.043: Kenneth Lavrsen: Added check for valid value for initsort. Ignore if it is not a number.
12 Sep 2009 1.042: Kenneth Lavrsen: Added a new API call initialiseWhenRender which plugins like CompareRevisionsAddOn can use to reset the table counters between two renderings of the same topic
03 Sep 2009 1.041: Kenneth Lavrsen: Fix for crash when cell contains the number 0. Allow sorting of negative numbers even when suffixed with unit. Treat whitespace as zero if pure numerical context.
02 Sep 2009 1.040: Kenneth Lavrsen: Fixed the fix of parsing date-time columns so that plain numbers are not interpreted as dates causing wrong sorting
03 Jun 2009 1.039: Michael Daum: fixed parsing date-time columns
19 Apr 2009 1.038: Removed support for settings in the plugin topic which is a bad idea anyway as they get overwritten at each Foswiki upgrade. Define the global settings in Main.SitePreferences instead.
Fixed an issue where TablePlugin produced invalid css if no 'px' or '%' is passed in a size parameter.
Small refactoring in style attribute handling.
16 Dec 2008 1.037: Foswiki version
30 Sep 2008 1.035: Fix sorting of attachment date column.
03 Aug 2008 1.034: TWiki 4.2.1 release version
20 Mar 2008 1.033: TWikibug:Item5387: allow rowspanned columns to contain HTML tags; otherwise it is impossible to add an invisible anchor to a rowspanned cell
16 Dec 2007 1.030: Kenneth Lavrsen: Fixed the problem of tables being sorted by by TablePlugin while the table is being edited by plugins such as EditTablePlugin. This required adding a new attribute disableallsort so plugins such as EditTablePlugin can temporarily disable all sorting for a table. Additionally the CGI variable (URL parameter or hidden formfield) sort can be set to "off" which disables all header sorting in the topic. This is used by plugins such as EditTablePlugin to disable the sorting by clicking header fields during editing of tables. Ref: TWikibug:Item5135 and TWikibug:Item2690.
03 Dec 2007 Arthur Clemens: Fixed rendering and order of html elements thead, tfoot and tbody; corrected id parameter.
24 Nov 2007 Arthur Clemens: Fixed sorting of columns with only icons; also removed TWiki formatting before sorting.
06 Oct 2007 15180: PTh: Added VarTABLE to have it listed in System.Macros
27 Jun 2007 1.024 - 1.027: Various small bug fixes.
24 Jun 2007 1.023: Arthur Clemens: Inline styles are now written to the head; updated default sort icons (from DocumentGraphics).
23 Jun 2007 1.022: Arthur Clemens: Fixed styling of param tablerules on Internet Explorer.
23 May 2007 1.021: Michael Daum: Fixed css attribute priority to cooperate nicely with skin themes.
27 Dec 2006 1.020: Kenneth Lavrsen: Fixed initsort so all tables can be initsorted and not only the first. When you sort a table by clicking on the header of a column the table gets sorted accordingly. When you click the header of another table the previously sorted table goes back being sorted as specified by initsort.
13 Dec 2006 1.019: Arthur Clemens: Prevent sorting of columns that do no exist.
02 Dec 2006 1.018: Arthur Clemens: Data rows now start with first datacolor and databgcolor.
26 Nov 2006 1.017: Arthur Clemens: Better support for tablerules.
24 Nov 2006 1.016: Arthur Clemens: Added new attribute cellborder.
25 Oct 2006 1.015: Arthur Clemens: Added support for background colors of sorted column. Columns can be unsorted - sorting order is now: sort ascending, sort descending, unsort. Added attributes headervalign and datavalign.
16 Aug 2006 Michael Daum: Added CSS support for even/odd table rows
13 Dec 2005 Arthur Clemens: Added support for id, summary and caption
05 Mar 2005 1.014: Crawford Currie eliminated deprecated handlers for Dakar
01 Aug 2004 Arthur Clemens: Added CSS support for first column and ascending/descending table headers
21 Mar 2004 PTh: Internal change: Fixed reference to unofficial variable
01 Jan 2004 PTh: Alternating data row colors restart again after each header row
01 Dec 2003 PTh: Fixed error when footerrows was specified on an empty table, contributed by TWiki:Main/PaulineCheung
24 May 2003 PTh: New |^| rule for multi row span (TWiki:Main/WalterMundt); added tableframe and tablerules (TWiki:Main/JohannesMartin); ignore columnwidths for multi column span; validate headerrows and footerrows (TWiki:Main/DarrylGreen); fixed link color problem and up/down icon color problem for dark header background
17 Dec 2002 PTh: Removed individual table Plugin settings; added TABLEATTRIBUTES Plugins setting and TABLEATTRIBUTES preferences setting
15 Dec 2002 PTh: Added headerrows and footerrows params (TWiki:Main/DarrylGreen, TWiki:Main/WoutMertens); added tablewidth and columnwidths params (TWiki:Main/ThorstenSommermann)
09 Dec 2002 PTh: Added headercolor and datacolor parameters
05 Jun 2002 PTh: Added "none" value to databg parameter (suggested by TWiki:Main/TaitCyrus); fixed sorting by stripping HTML tags, removing links and making sort ignore case (suggested by TWiki:Main/ShawnBradford)
13 Mar 2002 PTh: Added TWiki:Main/ShawnBradford 's initsort and initdirection
12 Mar 2002 PTh: Added valign, headeralign and dataalign; fixed bug of swapped cellpadding/cellspacing; fixed warning of uninitialized value
05 Jan 2002 PTh: Fixed sorting bug of cells with leading white space
06 Dec 2001 PTh: Fixed date sorting bug
03 Dec 2001 PTh: Fixed sort="off" bug and more
29 Nov 2001 PTh: Fixed Perl warnings
16 Nov 2001 PTh: Added table border, cell spacing, cell padding, gif files
07 Oct 2001 JT: Initial version
Plugin Home: http://foswiki.org/Extensions/TablePlugin
Support: http://foswiki.org/Support/TablePlugin

 
This site is powered by FoswikiCopyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback