TablePlugin < TWiki

---+ Table Plugin

Gives extra control of table display:
   * Allows sorting
   * Changing table properties like border width, cell spacing and cell padding
   * Changing background color for header cells
   * Changing background color for data cells - colors can _alternate_
   * Behaviour can be specified for a specific table using %<nop>TABLE{...}% or with global preferences


---++ <nop>%TOPIC% Global Settings

Plugin settings are stored as preferences variables. To reference
a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, for example, ==%<nop>INTERWIKIPLUGIN_SHORTDESCRIPTION%==

   * One line description, shown in the %TWIKIWEB%.TextFormattingRules topic:
      * Set SHORTDESCRIPTION = Control attributes of tables and sorting of table columns

   * Set DEBUG to 1 to get debug messages in =data/debug.txt=.  Default: =0=
      * Set DEBUG = 0

   * Table border width.  Default: 1
      * Set TABLEBORDER = 1

   * Table cell padding.  Default: 0
      * Set CELLPADDING = 0

   * Table cell spacing.  Default: 1
      * Set CELLSPACING = 1

   * Vertical alignment of cells. Set to: =top=, =middle=, =bottom= or =baseline=; default: (empty)
      * Set VALIGN = 

   * Table header cell alignment. Set to: =left=, =center=, =right= or =justify=; default: (empty)
      * Set HEADERALIGN = 

   * Table data cell alignment. Set to: =left=, =center=, =right= or =justify=; default: (empty)
      * Set DATAALIGN = 

   * Background color of header cells ('*'s around text). Choose one of the %TWIKIWEB%.StandardColors. Default: <span style="background : #99CCCC;">#99CCCC</span>
      * Set HEADER_BG = 

   * Text color of header cells ('*'s around text).  Default: not specified, e.g. determined by the browser
      * Set HEADER_COLOR = 

   * Background color of table rows, two alternate colors.  Default: <span style="background : #FFFFCC;">#FFFFCC</span>, <span style="background : #FFFFFF;">#FFFFFF</span>
      * Set DATA_BG = #FFFFCC, #FFFFFF

   * Text color of table rows, alternate colors.  Default: not specified, e.g. determined by the browser
      * Set DATA_COLOR = 

   * Make sortable:
      * #Set SORT = attachments
      * Set SORT = all
      * #Set SORT = none

---++ 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 if format is:
      * dd MMM YYY - hh:mm
      * dd-MMM-YY or dd-MM-YYYY (can be / or space in place of -)
      * MMM is Jan, Feb, etc
   * number is digits, with optional decimal point
   * otherwise treated as text

---++ Per Table Settings

On line before the table use =%<nop>TABLE{...}%=:

| *Argument* | *Comment* | *Example* |
| =sort=     | Set table sorting =on= or =off= | =sort="on"= |
| =initsort= | Column to sort initially (1 to number of columns) | =initsort="2"= |
| =initdirection= | Initial sorting direction for =initsort=, set to  =up= or =down= | =initsort="down"= |
| =headerbg= | Header cell background colour. Choose one of the %TWIKIWEB%.StandardColors | =headerbg="#99CCCC"= |
| =headercolor= | Header cell text colour | =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. | =databg="#C8CB8F, #DBDDB5"= |
| =datacolor= | Data cell text colour, a comma separated list | =datacolor="#0000CC, #000000"= |
| =tableborder= | Table border width (pixels) | =tableborder="2"= |
| =cellpadding= | Cell padding (pixels) | =cellpadding="0"= |
| =cellspacing= | Cell spacing (pixels) | =cellspacing="3"= |
| =valign= | Vertical alignment of cells, set to =top=, =middle=, =bottom= or =baseline= | =valign="top"= |
| =headeralign= | Header cell alignment, set to =left=, =center=, =right= or =justify=. Overrides individual cell settings | =headeralign="left"= |
| =dataalign= | Data cell alignment, set to =left=, =center=, =right= or =justify=. Overrides individual cell settings | =dataalign="center"= |

All default to the global setting

---++ Example

Line before table: =%<nop>TABLE{ sort="on" tableborder="0" cellpadding="1" cellspacing="3" headerbg="#000099" headercolor="#FFFFCC" databg="#C8CB8F, #DBDDB5" }%=

%TABLE{ sort="on" tableborder="0" cellpadding="1" cellspacing="3" headerbg="#000099" headercolor="#FFFFCC" databg="#C8CB8F, #DBDDB5" }%
| *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 | | |

---++ Plugin Installation Instructions

*Note:* You do not need to install anything on the browser to use this plugin. Below installation instructions are for the administrator who needs to install this plugin on the TWiki server.

   * Download the ZIP file from the Plugin web (see below)
   * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
     | *File:* | *Description:* |
     | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
     | ==data/TWiki/%TOPIC%.txt,v== | Plugin topic repository |
     | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
     | ==pub/TWiki/%TOPIC%/diamond.gif== | Diamond symbol |
     | ==pub/TWiki/%TOPIC%/down.gif== | Down arrow |
     | ==pub/TWiki/%TOPIC%/up.gif== | Up arrow |
   * 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

|  Plugin Author: | %TWIKIWEB%.JohnTalintyre, %TWIKIWEB%.PeterThoeny |
|  Plugin Version: | 09 Dec 2002 |
|  Change History: | <!-- specify latest version first -->&nbsp; |
|  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 <br /> 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 |
|  CPAN Dependencies: | none |
|  Other Dependencies: | none |
|  Perl Version: | 5.0 |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |

__Related Topics:__ %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins, %TWIKIWEB%.StandardColors

-- %TWIKIWEB%.JohnTalintyre - 07 Oct 2001 <br />
-- %TWIKIWEB%.PeterThoeny - 09 Dec 2002 <br />
Attachments
Topic attachments
I	Attachment	History	Action	Size	Date	Who	Comment
gif	diamond.gif	r1	manage	0.9 K	2001-11-14 - 03:13	UnknownUser	Diamond symbol
gif	down.gif	r1	manage	0.8 K	2001-11-14 - 03:13	UnknownUser	Down arrow
gif	up.gif	r1	manage	0.9 K	2001-11-14 - 03:13	UnknownUser	Up arrow
This topic: TWiki > TablePlugin
Topic revision: r14 - 2002-12-10 - PeterThoeny
Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TablePlugin.