data/TWiki/TablePlugin.txt
changeset 0 414e01d06fd5
child 1 e2915a7cbdfa
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/data/TWiki/TablePlugin.txt	Sat Jan 26 15:50:53 2008 +0100
     1.3 @@ -0,0 +1,174 @@
     1.4 +%META:TOPICINFO{author="TWikiContributor" date="1191730164" format="1.0" version="26"}%
     1.5 +---+ Table Plugin
     1.6 +
     1.7 +Gives extra control of table display:
     1.8 +	* Allows sorting
     1.9 +	* Changing table properties like border width, cell spacing and cell padding
    1.10 +	* Changing background color and text color for header cells
    1.11 +	* Changing background color and text color for data cells - colors can _alternate_
    1.12 +	* Table attributes can be set and overridden in this order:
    1.13 +		* Default =TABLEATTRIBUTES= Plugin setting in this topic.
    1.14 +		* A =TABLEATTRIBUTES= preferences setting on site-level (%TWIKIWEB%.TWikiPreferences) or web-level (any WebPreferences), e.g.
    1.15 +			* =Set TABLEATTRIBUTES = tableborder="0" cellpadding="1" ...=
    1.16 +		* Before a table using =%<nop>TABLE{...}%=
    1.17 +   * Row spans
    1.18 +
    1.19 +---++ Sorting
    1.20 +
    1.21 +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:
    1.22 +
    1.23 +	* date if format is:
    1.24 +		* dd MMM YYYY - hh:mm (MMM is Jan, Feb, etc.)
    1.25 +		* dd-MMM-YY or dd-MMM-YYYY (can be / or space in place of -) (MMM is Jan, Feb, etc)
    1.26 +	* number is digits, with optional decimal point
    1.27 +	* otherwise treated as text
    1.28 +
    1.29 +---++ Row spans
    1.30 +
    1.31 +Table cells with a single caret indicate follow-up rows of multi-row spans. For example,
    1.32 +<table width="100%"><tr><td>
    1.33 +<verbatim>
    1.34 +| One One | One Two | One Three |
    1.35 +| ^ | Two Two | Two Three |
    1.36 +| Three One | ^ | Three Three |
    1.37 +</verbatim>
    1.38 +</td><td align="right">
    1.39 +| One One | One Two | One Three |
    1.40 +| ^ | Two Two | Two Three |
    1.41 +| Three One | ^ | Three Three |
    1.42 +</td></tr></table>
    1.43 +
    1.44 +---++ <nop>%TOPIC% Global Settings
    1.45 +
    1.46 +Plugin settings are stored as preferences variables. To reference
    1.47 +a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, for example, ==%<nop>INTERWIKIPLUGIN_SHORTDESCRIPTION%==
    1.48 +
    1.49 +	* One line description, shown in the %TWIKIWEB%.TextFormattingRules topic:
    1.50 +		* Set SHORTDESCRIPTION = Control attributes of tables and sorting of table columns
    1.51 +
    1.52 +	* Set DEBUG to 1 to get debug messages in =data/debug.txt=.  Default: =0=
    1.53 +		* Set DEBUG = 0
    1.54 +
    1.55 +	* 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=.
    1.56 +		* #Set SORT = none
    1.57 +		* Set SORT = all
    1.58 +
    1.59 +	* Default table attributes:
    1.60 +		* Set TABLEATTRIBUTES = tableborder="1" cellpadding="0" cellspacing="0" valign="top" headercolor="#ffffff" headerbg="#687684" headerbgsorted="#334455" databg="#ffffff,#edf4f9" databgsorted="#f1f7fc,#ddebf6" tablerules="rows"
    1.61 +
    1.62 +---++ Table Attributes
    1.63 +
    1.64 +Attributes are defined as a =TABLEATTRIBUTES= Plugin setting in this topic, a =TABLEATTRIBUTES= preferences setting, or on line before the table using =%<nop>TABLE{...}%=:
    1.65 +%INCLUDE{"%TWIKIWEB%.VarTABLE" section="table_attributes"}%
    1.66 +
    1.67 +The =%<nop>TABLE{...}%= settings override =TABLEATTRIBUTES= preferences settings, which override the =TABLEATTRIBUTES= Plugin settings. 
    1.68 +
    1.69 +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.
    1.70 +
    1.71 +---++ Examples
    1.72 +
    1.73 +---+++ Use of %<nop>TABLE{...}%
    1.74 +
    1.75 +Line before table: =%<nop>TABLE{ sort="on" tableborder="0" cellpadding="4" cellspacing="3" cellborder="0" headerbg="#D5CCB1" headercolor="#666666" databg="#FAF0D4, #F3DFA8" headerrows="2" footerrows="1" }%=
    1.76 +
    1.77 +%TABLE{ sort="on" tableborder="0" cellpadding="4" cellspacing="3" cellborder="0" headerbg="#D5CCB1" headercolor="#666666" databg="#FAF0D4, #F3DFA8" headerrows="2" footerrows="1" }%
    1.78 +| *Table with two Header Rows and Footer Row* ||||||
    1.79 +| *Num* | *Status* | *Action* | *Who* | *When* | *Progress* |
    1.80 +| 1 | C | Chose new colours | John | 1-Dec-02 | |
    1.81 +| 2 | X | Release | John | 1-Apr-02 | |
    1.82 +| 3 |	| Get feedback | Anne | 1-Feb-02 | |
    1.83 +| 12 | C | Spec error handling | Jack | 1-Dec-02 | |
    1.84 +| 5 |	| Abc | John | | |
    1.85 +| *Num* | *Status* | *Action* | *Who* | *When* | *Progress* |
    1.86 +
    1.87 +---+++ Table with 4 digit year dates and no use of %<nop>TABLE{...}%
    1.88 +
    1.89 +| *When* |
    1.90 +| 1-Jan-2004 |
    1.91 +| 1-Jan-2003 |
    1.92 +| 2-Jan-2005 |
    1.93 +
    1.94 +
    1.95 +---++ !TablePlugin and CSS
    1.96 +Information for programmers.
    1.97 +
    1.98 +!TablePlugin implements the following precedence:
    1.99 +   * the =TABLEATTRIBUTE= settings only write html styling, no CSS
   1.100 +   * the =TABLEATTRIBUTE= settings can be overridden by a skin's CSS
   1.101 +   * the =TABLE= tag attributes are converted to CSS styling, written in the head; these override any skin's CSS
   1.102 +    
   1.103 +---+++ CSS written by !TablePlugin
   1.104 +|=.twikiTable=  |The table  |
   1.105 +|=.twikiSortedCol=  |A sorted column  |
   1.106 +|=.twikiSortedAscendingCol=  |Sorted column, ascending  |
   1.107 +|=.twikiSortedDescendingCol=  |Sorted column, descending  |
   1.108 +|=.tableSortIcon=  |The sort icon holder (span)  |
   1.109 +|=.twikiFirstCol=  |The first column  |
   1.110 +|=.twikiTableEven= |Even numbered rows  |
   1.111 +|=.twikiTableOdd= |Odd numbered rows  |
   1.112 +|=.twikiTableCol= + column number  | Unique column identifier, for instance: =twikiTableCol0= |
   1.113 +|=.twikiTableRow= + type + row number | Unique row identifier, for instance: =twikiTableRowdataBg0= |
   1.114 +
   1.115 +
   1.116 +---++ Plugin Installation Instructions
   1.117 +This plugin is pre-installed with your TWiki release. You should not have to install it other than to do an upgrade.
   1.118 +
   1.119 +	* Download the ZIP file from the Plugin web (see below)
   1.120 +	* Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
   1.121 +	  | *File:* | *Description:* |
   1.122 +	  | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
   1.123 +	  | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
   1.124 +	  | ==lib/TWiki/Plugins/%TOPIC%/Core.pm== | Plugin Perl module |
   1.125 +	* (Dakar) Visit =configure= in your TWiki installation, and enable the plugin in the {Plugins} section.
   1.126 +	* Test if the plugin is correctly installed:
   1.127 +		* Check above example if the table renders as expected
   1.128 +		* Try click on heading to sort.  Other tables should also be sortable
   1.129 +
   1.130 +---++ Plugin Info
   1.131 +
   1.132 +|  Plugin Author: | TWiki:Main/JohnTalintyre, TWiki:Main/PeterThoeny |
   1.133 +|  Copyright: | &copy; 2001-2007, TWiki:Main/JohnTalintyre, Peter@Thoeny.org ([[http://www.twiki.net/][TWIKI.NET]]), TWiki Contributors |
   1.134 +|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
   1.135 +|  Plugin Version: | 1.032 (22 Dec 2007) |
   1.136 +|  Change History: | <!-- specify latest version first -->&nbsp; |
   1.137 +|  16 Dec 2007 | 1.030: Kenneth Lavrsen: Fixed the problem of tables being sorted by by TablePlugin while the table is being edited by plugins such as EditTablePlugin. This required adding a new attribute =disableallsort= so plugins such as EditTablePlugin can temporarily disable all sorting for a table. Additionally the CGI variable (URL parameter or hidden formfield) =sort= can be set to "off" which disables all header sorting in the topic. This is used by plugins such as EditTablePlugin to disable the sorting by clicking header fields during editing of tables. Ref: TWikibug:Item5135 and TWikibug:Item2690. |
   1.138 +|  03 Dec 2007 | Arthur Clemens: Fixed rendering and order of html elements =thead=, =tfoot= and =tbody=; corrected =id= parameter. |
   1.139 +|  24 Nov 2007 | Arthur Clemens: Fixed sorting of columns with only icons; also removed TWiki formatting before sorting. |
   1.140 +|  06 Oct 2007 | 15180: PTh: Added %TWIKIWEB%.VarTABLE to have it listed in %TWIKIWEB%.TWikiVariables |
   1.141 +|  27 Jun 2007 | 1.024 - 1.027 Various small bug fixes. |
   1.142 +|  24 Jun 2007 | 1.023: Arthur Clemens: Inline styles are now written to the head; updated default sort icons (from %TWIKIWEB%.TWikiDocGraphics). |
   1.143 +|  23 Jun 2007 | 1.022: Arthur Clemens: Fixed styling of param =tablerules= on Internet Explorer. |
   1.144 +|  23 May 2007 | 1.021: Michael Daum: Fixed css attribute priority to cooperate nicely with skin themes. |
   1.145 +|  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. |
   1.146 +|  13 Dec 2006 | 1.019: Arthur Clemens: Prevent sorting of columns that do no exist.  |
   1.147 +|  02 Dec 2006 | 1.018: Arthur Clemens: Data rows now start with first =datacolor= and =databgcolor=.  |
   1.148 +|  26 Nov 2006 | 1.017: Arthur Clemens: Better support for =tablerules=.  |
   1.149 +|  24 Nov 2006 | 1.016: Arthur Clemens: Added new attribute =cellborder=.  |
   1.150 +|  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=. |
   1.151 +|  16 Aug 2006 | Michael Daum: Added CSS support for even/odd table rows |
   1.152 +|  13 Dec 2005 | Arthur Clemens: Added support for =id=, =summary= and =caption= |
   1.153 +|  05 Mar 2005 | 1.014: Crawford Currie eliminated deprecated handlers for Dakar |
   1.154 +|  01 Aug 2004 | Arthur Clemens: Added CSS support for first column and ascending/descending table headers |
   1.155 +|  21 Mar 2004 | PTh: Internal change: Fixed reference to unofficial variable |
   1.156 +|  01 Jan 2004 | PTh: Alternating data row colors restart again after each header row |
   1.157 +|  01 Dec 2003 | PTh: Fixed error when footerrows was specified on an empty table, contributed by TWiki:Main/PaulineCheung |
   1.158 +|  24 May 2003 | PTh: New =&#124;^&#124;= 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 |
   1.159 +|  17 Dec 2002 | PTh: Removed individual table Plugin settings; added TABLEATTRIBUTES Plugins setting and TABLEATTRIBUTES preferences setting |
   1.160 +|  15 Dec 2002 | PTh: Added headerrows and footerrows params (TWiki:Main/DarrylGreen, TWiki:Main/WoutMertens); added tablewidth and columnwidths params (TWiki:Main/ThorstenSommermann) |
   1.161 +|  09 Dec 2002 | PTh: Added headercolor and datacolor parameters |
   1.162 +|  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) |
   1.163 +|  13 Mar 2002 | PTh: Added TWiki:Main/ShawnBradford 's initsort and initdirection |
   1.164 +|  12 Mar 2002 | PTh: Added valign, headeralign and dataalign; fixed bug of swapped cellpadding/cellspacing; fixed warning of uninitialized value |
   1.165 +|  05 Jan 2002 | PTh: Fixed sorting bug of cells with leading white space  |
   1.166 +|  06 Dec 2001 | PTh: Fixed date sorting bug <br /> 03 Dec 2001 PTh: Fixed sort="off" bug and more |
   1.167 +|  29 Nov 2001 | PTh: Fixed Perl warnings |
   1.168 +|  16 Nov 2001 | PTh: Added table border, cell spacing, cell padding, gif files |
   1.169 +|  07 Oct 2001 | JT: Initial version |
   1.170 +|  CPAN Dependencies: | none |
   1.171 +|  Other Dependencies: | none |
   1.172 +|  Perl Version: | 5.0 |
   1.173 +|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
   1.174 +|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
   1.175 +|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |
   1.176 +
   1.177 +__Related Topics:__ %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins, %TWIKIWEB%.StandardColors