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 CGI TABLEATTRIBUTES Plugin setting in this topic.
  • A CGI TABLEATTRIBUTES preferences setting on site-level (TWikiPreferences) or web-level (any WebPreferences), e.g.
    • CGI Set TABLEATTRIBUTES = tableborder="0" cellpadding="1" ...
  • Before a table using CGI %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 YYYY - hh:mm (MMM is Jan, Feb, etc.)
  • 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 CGI CGI %<plugin>_<setting>%, for example, CGI CGI %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 CGI data/debug.txt. Default: CGI 0
  • Set DEBUG = 0

• Make all tables in a topic sortable. If this is set to CGI all, all tables that have a header row (including those that do not have %TABLE before them) will be made sortable. If set to CGI none, only tables with %TABLE will be sortable. Topic rendering is faster if this is set to CGI none.
  • #Set SORT = none
  • Set SORT = all

• Default table attributes:
  • Set TABLEATTRIBUTES = tableborder="1" cellpadding="0" cellspacing="0" valign="top" headercolor="#ffffff" headerbg="#687684" headerbgsorted="#334455" databg="#ffffff,#edf4f9" databgsorted="#f1f7fc,#ddebf6" tablerules="rows"

Table Attributes

Attributes are defined as a CGI TABLEATTRIBUTES Plugin setting in this topic, a CGI TABLEATTRIBUTES preferences setting, or on line before the table using CGI %TABLE{...}%:

• Supported attributes:

  Argument	Comment	Default value	Example
  CGI sort	Set table sorting by clicking headers CGI "on" or CGI "off".	unspecified	CGI sort="on"
  CGI initsort	Column to sort initially (CGI "1" to number of columns).	unspecified	CGI initsort="2"
  CGI initdirection	Initial sorting direction for CGI initsort, set to CGI "up" (descending) or CGI "down" (ascending).	unspecified	CGI initdirection="up"
  CGI disableallsort	Disable all sorting, both initsort and header sort. This is mainly used by plugins such as the EditTablePlugin to disable sorting in a table while editing the table.	unspecified	CGI disableallsort="on"
  CGI headerbg	Header cell background colour.	CGI "#6b7f93"	CGI headerbg="#999999"
  CGI headerbgsorted	Header cell background colour of a sorted column.	the value of CGI headerbg	CGI headerbgsorted="#32596c"
  CGI headercolor	Header cell text colour.	CGI "#ffffff"	CGI headercolor="#0000cc"
  CGI databg	Data cell background colour, a comma separated list. Specify CGI "none" for no colour, that is to use the colour/background of the page the table is on.	CGI "#edf4f9,#ffffff"	CGI databg="#f2f2f2,#ffffff"
  CGI databgsorted	Data cell background colour of a sorted column; see CGI databg.	the values of CGI databg	CGI databgsorted="#d4e8e4,#e5f5ea"
  CGI datacolor	Data cell text colour, a comma separated list.	unspecified	CGI datacolor="#0000CC, #000000"
  CGI tableborder	Table border width (pixels).	CGI "1"	CGI tableborder="2"
  CGI tableframe	Table frame, set to CGI "void" (no sides), CGI "above" (the top side only), CGI "below" (the bottom side only), CGI "hsides" (the top and bottom sides only), CGI "lhs" (the left-hand side only), CGI "rhs" (the right-hand side only), CGI "vsides" (the right and left sides only), CGI "box" (all four sides), CGI "border" (all four sides).	unspecified	CGI tableframe="hsides"
  CGI tablerules	Table rules, set to CGI "none" (no rules), CGI "groups" (rules will appear between row groups and column groups only), CGI "rows" (rules will appear between rows only), CGI "cols" (rules will appear between columns only), CGI "all" (rules will appear between all rows and columns).	unspecified	CGI tablerules="rows"
  CGI cellpadding	Cell padding (pixels).	CGI "0"	CGI cellpadding="0"
  CGI cellspacing	Cell spacing (pixels).	CGI "0"	CGI cellspacing="3"
  CGI cellborder	Cell border width (pixels).	unspecified	CGI cellborder="0"
  CGI valign	Vertical alignment of cells and headers, set to CGI "top", CGI "middle", CGI "bottom" or CGI "baseline".	unspecified	CGI valign="top"
  CGI headervalign	Vertical alignment of header cells; overrides CGI valign.	unspecified	CGI headervalign="top"
  CGI datavalign	Vertical alignment of data cells; overrides CGI valign.	unspecified	CGI datavalign="top"
  CGI headeralign	Header cell alignment, one value for all columns, or a comma separated list for different alignment of individual columns. Set to CGI "left", CGI "center", CGI "right" or CGI "justify". Overrides individual cell settings.	unspecified	CGI headeralign="left,right"
  CGI dataalign	Data cell alignment, one value for all columns, or a comma separated list for different alignment of individual columns. Set to CGI "left", CGI "center", CGI "right" or CGI "justify". Overrides individual cell settings.	unspecified	CGI dataalign="center"
  CGI tablewidth	Table width: Percentage of window width, or absolute pixel value.	unspecified	CGI tablewidth="100%"
  CGI columnwidths	Column widths: Comma delimited list of column widths, percentage or absolute pixel value.	unspecified	CGI columnwidths="80%,20%"
  CGI headerrows	Number of header rows to exclude from sort. (will be rendered in a HTML CGI thead section)	CGI "1"	CGI headerrows="1"
  CGI footerrows	Number of footer rows to exclude from sort. (will be rendered in a HTML CGI tfoot section)	CGI "0"	CGI footerrows="1"
  CGI id	Unique table identifier string, used for targeting a table with CSS.	CGI tableN (where N is the table order number on the page)	CGI id="userTable"
  CGI 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	CGI summary="List of subscribed users"
  CGI caption	Table caption: A title that will be displayed just above the table.	unspecified	CGI caption="Users"

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

The setting CGI disableallsort is normally not used as a TABLE or TABLEATTRIBUTES setting. Plugins such as EditTablePlugin dynamically sets CGI disableallsort to disable sorting while editing a table. For this to work it is important that EditTablePlugin runs before TablePlugin, which is the default. The setting CGI sort can be overwritten by a URL parameter or hidden formfield of the same name. Plugins such as EditTablePlugin can use this to disable table header sorting while in edit mode.

Examples

Use of %TABLE{...}%

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

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

TablePlugin and CSS

TablePlugin implements the following precedence:

• the CGI TABLEATTRIBUTE settings only write html styling, no CSS
• the CGI TABLEATTRIBUTE settings can be overridden by a skin's CSS
• the CGI TABLE tag attributes are converted to CSS styling, written in the head; these override any skin's CSS

CSS written by TablePlugin

Plugin Installation Instructions

• Download the ZIP file from the Plugin web (see below)
• Unzip CGI CGI TablePlugin.zip in your twiki installation directory. Content:

  File:	Description:
  CGI CGI data/TWiki/TablePlugin.txt	Plugin topic
  CGI CGI lib/TWiki/Plugins/TablePlugin.pm	Plugin Perl module
  CGI CGI lib/TWiki/Plugins/TablePlugin/Core.pm	Plugin Perl module

• (Dakar) Visit CGI 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