Gives extra control of table display:
TABLEATTRIBUTES
Plugin setting in this topic.
TABLEATTRIBUTES
preferences setting on site-level (TWikiPreferences) or web-level (any WebPreferences), e.g. Set TABLEATTRIBUTES = tableborder="0" cellpadding="1" ...
%TABLE{...}%
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:
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 | |
|
Plugin settings are stored as preferences variables. To reference
a plugin setting write %<plugin>_<setting>%
, for example, %INTERWIKIPLUGIN_SHORTDESCRIPTION%
data/debug.txt
. Default: 0
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
.
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![]() | Default value | Example |
---|---|---|---|
cellborder | Cell border width (pixels). | unspecified | cellborder="0" |
cellpadding | Cell padding (pixels). | "0" | cellpadding="0" |
cellspacing | Cell spacing (pixels). | "0" | cellspacing="3" |
initsort | Column to sort initially ("1" to number of columns). | unspecified | initsort="2" |
columnwidths | Column widths: Comma delimited list of column widths, percentage or absolute pixel value. | unspecified | columnwidths="80%,20%" |
dataalign | Data cell alignment, one value for all columns, or a comma separated list for different alignment of individual columns. Set to "left" , "center" , "right" or "justify" . Overrides individual cell settings. | unspecified | dataalign="center" |
databgsorted | Data cell background colour of a sorted column; see databg . | the values of databg | databgsorted="#d4e8e4,#e5f5ea" |
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. | "#edf4f9,#ffffff" | databg="#f2f2f2,#ffffff" |
datacolor | Data cell text colour, a comma separated list. | unspecified | datacolor="#0000CC, #000000" |
headeralign | Header cell alignment, one value for all columns, or a comma separated list for different alignment of individual columns. Set to "left" , "center" , "right" or "justify" . Overrides individual cell settings. | unspecified | headeralign="left,right" |
headerbgsorted | Header cell background colour of a sorted column. | the value of headerbg | headerbgsorted="#32596c" |
headerbg | Header cell background colour. | "#6b7f93" | headerbg="#999999" |
headercolor | Header cell text colour. | "#ffffff" | headercolor="#0000cc" |
initdirection | Initial sorting direction for initsort , set to "up" (descending) or "down" (ascending). | unspecified | initdirection="up" |
footerrows | Number of footer rows to exclude from sort. | "0" | footerrows="1" |
headerrows | Number of header rows to exclude from sort. | "1" | headerrows="1" |
sort | Set table sorting "on" or "off" . | unspecified | sort="on" |
tableborder | Table border width (pixels). | "1" | tableborder="2" |
caption | Table caption: A title that will be displayed just above the table. | unspecified | caption="Users" |
tableframe | Table frame, set to "void" (no sides), "above" (the top side only), "below" (the bottom side only), "hsides" (the top and bottom sides only), "lhs" (the left-hand side only), "rhs" (the right-hand side only), "vsides" (the right and left sides only), "box" (all four sides), "border" (all four sides). | unspecified | tableframe="hsides" |
id | Table identifier string. | unspecified | id="userTable" |
tablerules | Table rules, set to "none" (no rules), "groups" (rules will appear between row groups and column groups only), "rows" (rules will appear between rows only), "cols" (rules will appear between columns only), "all" (rules will appear between all rows and columns). | unspecified | tablerules="rows" |
summary | Table summary used by screenreaders: A summary of what the table presents. It should provide an orientation for someone who listens to the table. | unspecified | summary="List of subscribed users" |
tablewidth | Table width: Percentage of window width, or absolute pixel value. | unspecified | tablewidth="100%" |
valign | Vertical alignment of cells and headers, set to "top" , "middle" , "bottom" or "baseline" . | unspecified | valign="top" |
datavalign | Vertical alignment of data cells; overrides valign . | unspecified | datavalign="top" |
headervalign | Vertical alignment of header cells; overrides valign . | unspecified | headervalign="top" |
The %TABLE{...}%
settings override TABLEATTRIBUTES
preferences settings, which override the TABLEATTRIBUTES
Plugin settings.
Line before table: %TABLE{ sort="on" tableborder="0" cellpadding="4" cellspacing="3" cellborder="0" headerbg="#D5CCB1" headercolor="#666666" databg="#FAF0D4, #F3DFA8" 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 |
When |
---|
1-Jan-2004 |
1-Jan-2003 |
2-Jan-2005 |
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 |
configure
in your TWiki installation, and enable the plugin in the {Plugins} section.
Plugin Author: | TWiki:Main/JohnTalintyre, TWiki:Main/PeterThoeny |
Plugin Version: | 1.020 |
Change History: | |
27 Dec 2006 | 1.020: Kenneth Lavrsen: Fixed initsort so all tables can be initsorted and not only the first. When you sort a table by clicking on the header of a column the table gets sorted accordingly. When you click the header of another table the previously sorted table goes back being sorted as specified by initsort. |
13 Dec 2006 | 1.019: Arthur Clemens: Prevent sorting of columns that do no exist. |
02 Dec 2006 | 1.018: Arthur Clemens: Data rows now start with first datacolor and databgcolor . |
26 Nov 2006 | 1.017: Arthur Clemens: Better support for tablerules . |
24 Nov 2006 | 1.016: Arthur Clemens: Added new attribute cellborder . |
25 Oct 2006 | 1.015: Arthur Clemens: Added support for background colors of sorted column. Columns can be unsorted - sorting order is now: sort ascending, sort descending, unsort. Added attributes headervalign and datavalign . |
16 Aug 2006 | Michael Daum: Added CSS support for even/odd table rows |
13 Dec 2005 | Arthur Clemens: Added support for id , summary and caption |
05 Mar 2005 | 1.014: Crawford Currie eliminated deprecated handlers for Dakar |
01 Aug 2004 | Arthur Clemens: Added CSS support for first column and ascending/descending table headers |
21 Mar 2004 | PTh: Internal change: Fixed reference to unofficial variable |
01 Jan 2004 | PTh: Alternating data row colors restart again after each header row |
01 Dec 2003 | PTh: Fixed error when footerrows was specified on an empty table, contributed by TWiki:Main/PaulineCheung |
24 May 2003 | PTh: New |^| rule for multi row span (TWiki:Main/WalterMundt); added tableframe and tablerules (TWiki:Main/JohannesMartin); ignore columnwidths for multi column span; validate headerrows and footerrows (TWiki:Main/DarrylGreen); fixed link color problem and up/down icon color problem for dark header background |
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/DarrylGreen, 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
I | Attachment | Action | Size | Date | Who | Comment |
---|---|---|---|---|---|---|
![]() | diamond.gif | manage | 0.9 K | 02 Dec 2003 - 07:54 | TWikiContributor | Diamond symbol |
![]() | down.gif | manage | 0.8 K | 02 Dec 2003 - 07:54 | TWikiContributor | Down arrow |
![]() | up.gif | manage | 0.8 K | 02 Dec 2003 - 07:53 | TWikiContributor | Up arrow |