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 (TWikiPreferences) or web-level (any WebPreferences), e.g.
    • Set TABLEATTRIBUTES = tableborder="0" cellpadding="1" ...
  • Before a table using %TABLE{...}%

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

TablePlugin Global Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, for example, %INTERWIKIPLUGIN_SHORTDESCRIPTION%

• One line description, shown in the 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

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

• Default table attributes:
  • Set TABLEATTRIBUTES = tableborder="1" cellpadding="0" cellspacing="1" headerbg="#99CCCC" databg="#FFFFCC, #FFFFFF"

Table Attributes

Attributes are defined as a TABLEATTRIBUTES Plugin setting in this topic, a TABLEATTRIBUTES preferences setting, or on line before the table using %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	initdirection="up"
headerbg	Header cell background colour. Choose one of the 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"
tablewidth	Table width: Percentage of window width, or absolute pixel value. Default is unspecified	tablewidth="100%"
columnwidths	Column widths: Comma delimited list of column widths, percentage or absolute pixel value. Default is unspecified	columnwidths="80%, 20%"
headerrows	Number of header rows to exclude from sort; default 1	headerrows="1"
footerrows	Number of footer rows to exclude from sort; default 0	footerrows="1"

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

Example

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

Table with two Header Rows and Footer Row
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
Num	Status	Action	Who	When	Progress

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 TablePlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/TablePlugin.txt	Plugin topic
  data/TWiki/TablePlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/TablePlugin.pm	Plugin Perl module
  pub/TWiki/TablePlugin/diamond.gif	Diamond symbol
  pub/TWiki/TablePlugin/down.gif	Down arrow
  pub/TWiki/TablePlugin/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:	JohnTalintyre?, PeterThoeny
Plugin Version:	17 Dec 2002
Change History:
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/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
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.0
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/TablePlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/TablePluginDev

Related Topics: TWikiPreferences, TWikiPlugins, StandardColors

-- JohnTalintyre^? - 07 Oct 2001
-- PeterThoeny - 17 Dec 2002