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 %TABLE{...}% or with global preferences

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

• 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 StandardColors. Default: #99CCCC
  • 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: #FFFFCC, #FFFFFF
  • 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 %TABLE{...}%:

All default to the global setting

Example

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

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

Related Topics: TWikiPreferences, TWikiPlugins, StandardColors

-- JohnTalintyre - 07 Oct 2001
-- PeterThoeny - 09 Dec 2002