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{...}%
• 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 if format is:
  • dd MMM YYY - hh:mm
  • dd-MMM-YY or dd-MMM-YYYY (can be / or space in place of -)
  • MMM is Jan, Feb, etc
• 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 |

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 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.
  • #Set SORT = none
  • Set SORT = all

• Default table attributes:
  • Set TABLEATTRIBUTES = tableborder="0" cellpadding="1" cellspacing="1" headerbg="#dadada" headercolor="#000000" databg="#eaeaea, #ffffff"
  • Classic skin 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{...}%:

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

Examples

Use of %TABLE{...}%

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

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

Plugin Installation Instructions

• 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

• (Dakar) Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
• 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

Attachment	Action	Size	Date	Who	Comment
up.gif	manage	0.8 K	07 Feb 2006 - 15:09	TWikiContributor	Up arrow
down.gif	manage	0.8 K	07 Feb 2006 - 15:09	TWikiContributor	Down arrow
diamond.gif	manage	0.9 K	07 Feb 2006 - 15:09	TWikiContributor	Diamond symbol