Table Plugin
Introduction
The TablePlugin 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
TABLEATTRIBUTESPlugin setting in this topic. - A
TABLEATTRIBUTESpreferences setting on site-level (TWikiPreferences) or web-level (any WebPreferences), e.g.-
Set TABLEATTRIBUTES = tableborder="0" cellpadding="1" ...
-
- Before a table using
%TABLE{...}%
- Default
- 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 | |
| ||||||||||||||
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{...}%:
- Supported attributes:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The %TABLE{...}% settings override TABLEATTRIBUTES preferences settings, which override the TABLEATTRIBUTES Plugin settings.
The setting disableallsort is normally not used as a TABLE or TABLEATTRIBUTES setting. Plugins such as EditTablePlugin dynamically sets 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 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: %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
Information for programmers.
TablePlugin implements the following precedence:
- the
TABLEATTRIBUTEsettings only write html styling, no CSS - the
TABLEATTRIBUTEsettings can be overridden by a skin's CSS - the
TABLEtag attributes are converted to CSS styling, written in the head; these override any skin's CSS
CSS written by TablePlugin
|
|||||||||||||||||||||
TablePlugin Global Settings
Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, for example, %TABLEPLUGIN_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 tonone, only tables with %TABLE will be sortable. Topic rendering is faster if this is set tonone.- #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="all"
Plugin Installation Instructions
This plugin is pre-installed. TWiki administrators can upgrade the plugin as needed on the TWiki server.
- For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.
- Or, follow these manual installation steps:
- Download the ZIP file from the Plugins home (see below).
- Unzip
TablePlugin.zipin your twiki installation directory. Content:
|
|||||||||||
-
- Set the ownership of the extracted directories and files to the webserver user.
- Make sure the dependencies listed in the table below are resolved. None
- Plugin configuration and testing:
- Run the configure script, enable the plugin in the Plugins section
- Configure the plugin: See plugin settings above.
- 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: VarTABLE, TWikiPreferences, TWikiPlugins, StandardColors
r35 - 25 Sep 2013 - 20:09:45 - TWikiContributor
TWiki
TWiki Web
Users
Groups
Index
Search
Changes
Notifications
RSS Feed
Statistics
Preferences
Linux4SAM
Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries.
Microchip® and others, are registered trademarks or trademarks of Microchip Technology Inc. and its subsidiaries. 
Arm® and others are registered trademarks or trademarks of Arm Limited (or its affiliates). Other terms and product names may be trademarks of others.
Ideas, requests, contributions ? Connect to LinksToCommunities page.