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 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 %<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="1" cellpadding="0" cellspacing="0" valign="top" headeralign="center" headercolor="#ffffff" headerbg="#6b7f93" headerbgsorted="#334455" headercolor="#ffffff" databg="#ffffff,#edf4f9" databgsorted="#f5f5f5,#dce7ee"
  • Classic skin table attributes:
    • #Set TABLEATTRIBUTES = tableborder="1" cellpadding="0" cellspacing="1" headerbg="#99cccc" databg="#ffffff,#ffffcc"

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

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.

Examples

Use of %TABLE{...}%

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 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