Welcome, Registration, and other StartingPoints; TWiki history & Wiki style; All the docs...

Table Plugin

Gives extra control off 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>%, i.e. %INTERWIKIPLUGIN_SHORTDESCRIPTION%

  • One line description, is 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

  • Color for header cells ('*'s around text). Default: #99CCCC
    • #Set HEADER_BG = red

  • Background color for table rows, two alternate colors. Default: #FFFFCC,#FFFFFF
    • Set DATA_BG = #FFFFCC,#FFFFFF

  • 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{...}%:

Argument Comment Example
sort Set table sorting on or off sort="on"
headerbg Header cell background colour headerbg="#99CCCC"
databg Data cell background colour, a comma seperated list databg="#C8CB8F,#DBDDB5"
tableborder Table border width (pixels) tableborder="2"
cellpadding Cell padding (pixels) cellpadding="0"
cellspacing Cell spacing (pixels) cellspacing="3"

All default to the global setting

Examples

Line before table: %TABLE{sort="on" tableborder="0" cellpadding="3" cellspacing="1" headerbg="#99CCCC" 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

  • 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?
Plugin Version: 06 Dec 2001
Change History: 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: 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

-- JohnTalintyre? - 07 Oct 2001
-- PeterThoeny - 06 Dec 2001

Go

Navigation

Webs Webs

Attachments Attachments

  Attachment Action Size Date Who Comment
gif diamond.gif props, move 0.9 K 14 Nov 2001 - 03:13 PeterThoeny? Diamond symbol
gif down.gif props, move 0.8 K 14 Nov 2001 - 03:13 PeterThoeny? Down arrow
gif up.gif props, move 0.9 K 14 Nov 2001 - 03:13 PeterThoeny? Up arrow
r7 - 07 Dec 2001 - 07:28:00 - PeterThoeny?
This site is powered by the TWiki collaboration platform.
All material on this collaboration platform is the property of the contributing authors.
All material marked as authored by Eben Moglen is available under the license terms CC-BY-SA version 4.
Syndicate this site RSSATOM