8a8c3b5e292142b752b55c507ba0aef24d30e17a
[openafs-wiki.git] / TWiki / TablePlugin.mdwn
1 # <a name="Table Plugin"></a> Table Plugin
2
3 Gives extra control of table display:
4
5 - Allows sorting
6 - Changing table properties like border width, cell spacing and cell padding
7 - Changing background color for header cells
8 - Changing background color for data cells - colors can _alternate_
9 - Behaviour can be specified for a specific table using %TABLE\{...\}% or with global preferences
10
11 ## <a name="%TOPIC% Global Settings"></a> %TOPIC% Global Settings
12
13 Plugin settings are stored as preferences variables. To reference a plugin setting write <code>**%&lt;plugin&gt;\_&lt;setting&gt;%**</code>, for example, <code>**%INTERWIKIPLUGIN\_SHORTDESCRIPTION%**</code>
14
15 - One line description, shown in the [[TextFormattingRules]] topic:
16   - Set SHORTDESCRIPTION = Control attributes of tables and sorting of table columns
17
18 - Set DEBUG to 1 to get debug messages in `data/debug.txt`. Default: `0`
19   - Set DEBUG = 0
20
21 - Table border width. Default: 1
22   - Set TABLEBORDER = 1
23
24 - Table cell padding. Default: 0
25   - Set CELLPADDING = 0
26
27 - Table cell spacing. Default: 1
28   - Set CELLSPACING = 1
29
30 - Table width, e.g. `100%` for relative, `640` for absolute width. Default: (not set)
31   - Set TABLEWIDTH =
32
33 - Vertical alignment of cells. Set to: `top`, `middle`, `bottom` or `baseline`; default: (empty)
34   - Set VALIGN =
35
36 - Table header cell alignment. Set to: `left`, `center`, `right` or `justify`; default: (empty)
37   - Set HEADERALIGN =
38
39 - Table data cell alignment. Set to: `left`, `center`, `right` or `justify`; default: (empty)
40   - Set DATAALIGN =
41
42 - Background color of header cells ('\*'s around text). Choose one of the [[StandardColors]]. Default: <span>\#99CCCC</span>
43   - Set HEADER\_BG =
44
45 - Text color of header cells ('\*'s around text). Default: not specified, e.g. determined by the browser
46   - Set HEADER\_COLOR =
47
48 - Background color of table rows, two alternate colors. Default: <span>\#FFFFCC</span>, <span>\#FFFFFF</span>
49   - Set DATA\_BG = #FFFFCC, #FFFFFF
50
51 - Text color of table rows, alternate colors. Default: not specified, e.g. determined by the browser
52   - Set DATA\_COLOR =
53
54 - Make sortable:
55   - #Set SORT = attachments
56   - Set SORT = all
57   - #Set SORT = none
58
59 ## <a name="Sorting"></a> Sorting
60
61 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:
62
63 - date if format is:
64   - dd MMM YYY - hh:mm
65   - dd-MMM-YY or dd-MM-YYYY (can be / or space in place of -)
66   - MMM is Jan, Feb, etc
67 - number is digits, with optional decimal point
68 - otherwise treated as text
69
70 ## <a name="Per Table Settings"></a> Per Table Settings
71
72 On line before the table use `%TABLE{...}%`:
73
74 <table border="1" cellpadding="0" cellspacing="0" style="border-width: 1px">
75   <tr>
76     <th bgcolor="#6b7f93" maxcols="0" style=""><a href="http://localhost?sortcol=0;table=1;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Argument</font></a></th>
77     <th bgcolor="#6b7f93" maxcols="0" style=""><a href="http://localhost?sortcol=1;table=1;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Comment</font></a></th>
78     <th bgcolor="#6b7f93" maxcols="0" style=""><a href="http://localhost?sortcol=2;table=1;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Example</font></a></th>
79   </tr>
80   <tr>
81     <td bgcolor="#ecf2f8" style=""><code>sort</code></td>
82     <td bgcolor="#ecf2f8" style=""> Set table sorting <code>on</code> or <code>off</code></td>
83     <td bgcolor="#ecf2f8" style=""><code>sort="on"</code></td>
84   </tr>
85   <tr>
86     <td bgcolor="#ffffff" style=""><code>initsort</code></td>
87     <td bgcolor="#ffffff" style=""> Column to sort initially (1 to number of columns) </td>
88     <td bgcolor="#ffffff" style=""><code>initsort="2"</code></td>
89   </tr>
90   <tr>
91     <td bgcolor="#ecf2f8" style=""><code>initdirection</code></td>
92     <td bgcolor="#ecf2f8" style=""> Initial sorting direction for <code>initsort</code>, set to <code>up</code> or <code>down</code></td>
93     <td bgcolor="#ecf2f8" style=""><code>initsort="down"</code></td>
94   </tr>
95   <tr>
96     <td bgcolor="#ffffff" style=""><code>headerbg</code></td>
97     <td bgcolor="#ffffff" style=""> Header cell background colour. Choose one of the [[TWiki/StandardColors]]</td>
98     <td bgcolor="#ffffff" style=""><code>headerbg="#99CCCC"</code></td>
99   </tr>
100   <tr>
101     <td bgcolor="#ecf2f8" style=""><code>headercolor</code></td>
102     <td bgcolor="#ecf2f8" style=""> Header cell text colour </td>
103     <td bgcolor="#ecf2f8" style=""><code>headercolor="#0000CC"</code></td>
104   </tr>
105   <tr>
106     <td bgcolor="#ffffff" style=""><code>databg</code></td>
107     <td bgcolor="#ffffff" style=""> Data cell background colour, a comma separated list. Specify <code>"none"</code> for no colour, that is to use the colour/background of the page the table is on. </td>
108     <td bgcolor="#ffffff" style=""><code>databg="#C8CB8F, #DBDDB5"</code></td>
109   </tr>
110   <tr>
111     <td bgcolor="#ecf2f8" style=""><code>datacolor</code></td>
112     <td bgcolor="#ecf2f8" style=""> Data cell text colour, a comma separated list </td>
113     <td bgcolor="#ecf2f8" style=""><code>datacolor="#0000CC, #000000"</code></td>
114   </tr>
115   <tr>
116     <td bgcolor="#ffffff" style=""><code>tableborder</code></td>
117     <td bgcolor="#ffffff" style=""> Table border width (pixels) </td>
118     <td bgcolor="#ffffff" style=""><code>tableborder="2"</code></td>
119   </tr>
120   <tr>
121     <td bgcolor="#ecf2f8" style=""><code>cellpadding</code></td>
122     <td bgcolor="#ecf2f8" style=""> Cell padding (pixels) </td>
123     <td bgcolor="#ecf2f8" style=""><code>cellpadding="0"</code></td>
124   </tr>
125   <tr>
126     <td bgcolor="#ffffff" style=""><code>cellspacing</code></td>
127     <td bgcolor="#ffffff" style=""> Cell spacing (pixels) </td>
128     <td bgcolor="#ffffff" style=""><code>cellspacing="3"</code></td>
129   </tr>
130   <tr>
131     <td bgcolor="#ecf2f8" style=""><code>valign</code></td>
132     <td bgcolor="#ecf2f8" style=""> Vertical alignment of cells, set to <code>top</code>, <code>middle</code>, <code>bottom</code> or <code>baseline</code></td>
133     <td bgcolor="#ecf2f8" style=""><code>valign="top"</code></td>
134   </tr>
135   <tr>
136     <td bgcolor="#ffffff" style=""><code>headeralign</code></td>
137     <td bgcolor="#ffffff" style=""> Header cell alignment, set to <code>left</code>, <code>center</code>, <code>right</code> or <code>justify</code>. Overrides individual cell settings </td>
138     <td bgcolor="#ffffff" style=""><code>headeralign="left"</code></td>
139   </tr>
140   <tr>
141     <td bgcolor="#ecf2f8" style=""><code>dataalign</code></td>
142     <td bgcolor="#ecf2f8" style=""> Data cell alignment, set to <code>left</code>, <code>center</code>, <code>right</code> or <code>justify</code>. Overrides individual cell settings </td>
143     <td bgcolor="#ecf2f8" style=""><code>dataalign="center"</code></td>
144   </tr>
145   <tr>
146     <td bgcolor="#ffffff" style=""><code>tablewidth</code></td>
147     <td bgcolor="#ffffff" style=""> Table width: Percentage of window width, or absolute pixel value. Default is unspecified </td>
148     <td bgcolor="#ffffff" style=""><code>tablewidth="100%"</code></td>
149   </tr>
150   <tr>
151     <td bgcolor="#ecf2f8" style=""><code>columnwidths</code></td>
152     <td bgcolor="#ecf2f8" style=""> Column widths: Comma delimited list of column widths, percentage or absolute pixel value. Default is unspecified </td>
153     <td bgcolor="#ecf2f8" style=""><code>columnwidths="80%, 20%"</code></td>
154   </tr>
155   <tr>
156     <td bgcolor="#ffffff" style=""><code>headerrows</code></td>
157     <td bgcolor="#ffffff" style=""> Number of header rows to exclude from sort; default 1 </td>
158     <td bgcolor="#ffffff" style=""><code>headerrows="1"</code></td>
159   </tr>
160   <tr>
161     <td bgcolor="#ecf2f8" style=""><code>footerrows</code></td>
162     <td bgcolor="#ecf2f8" style=""> Number of footer rows to exclude from sort; default 0 </td>
163     <td bgcolor="#ecf2f8" style=""><code>footerrows="1"</code></td>
164   </tr>
165 </table>
166
167 All default to the global setting
168
169 ## <a name="Example"></a> Example
170
171 Line before table: `%TABLE{ sort="on" tableborder="0" cellpadding="1" cellspacing="3" headerbg="#000099" headercolor="#FFFFCC" databg="#C8CB8F, #DBDDB5" headerrows="2" footerrows="1" }%`
172
173 <table border="0" cellpadding="1" cellspacing="3" style="border-width: 0px">
174   <tr>
175     <th bgcolor="#000099" colspan="6" maxcols="0" style=""><span><font color="#FFFFCC"> <strong> Table with two Header Rows and Footer Row </strong> </font></span></th>
176   </tr>
177   <tr>
178     <th bgcolor="#000099" maxcols="0" style=""><a href="http://localhost?sortcol=0;table=2;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#FFFFCC">Num</font></a></th>
179     <th bgcolor="#000099" maxcols="0" style=""><a href="http://localhost?sortcol=1;table=2;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#FFFFCC">Status</font></a></th>
180     <th bgcolor="#000099" maxcols="0" style=""><a href="http://localhost?sortcol=2;table=2;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#FFFFCC">Action</font></a></th>
181     <th bgcolor="#000099" maxcols="0" style=""><a href="http://localhost?sortcol=3;table=2;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#FFFFCC">Who</font></a></th>
182     <th bgcolor="#000099" maxcols="0" style=""><a href="http://localhost?sortcol=4;table=2;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#FFFFCC">When</font></a></th>
183     <th bgcolor="#000099" maxcols="0" style=""><a href="http://localhost?sortcol=5;table=2;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#FFFFCC">Progress</font></a></th>
184   </tr>
185   <tr>
186     <td bgcolor="#C8CB8F" style=""> 1 </td>
187     <td bgcolor="#C8CB8F" style=""> C </td>
188     <td bgcolor="#C8CB8F" style=""> Chose new colours </td>
189     <td bgcolor="#C8CB8F" style=""> John </td>
190     <td bgcolor="#C8CB8F" style=""> 1-Dec-02 </td>
191     <td bgcolor="#C8CB8F" style="">   </td>
192   </tr>
193   <tr>
194     <td bgcolor="#DBDDB5" style=""> 2 </td>
195     <td bgcolor="#DBDDB5" style=""> X </td>
196     <td bgcolor="#DBDDB5" style=""> Release </td>
197     <td bgcolor="#DBDDB5" style=""> John </td>
198     <td bgcolor="#DBDDB5" style=""> 1-Apr-02 </td>
199     <td bgcolor="#DBDDB5" style="">   </td>
200   </tr>
201   <tr>
202     <td bgcolor="#C8CB8F" style=""> 3 </td>
203     <td bgcolor="#C8CB8F" style="">   </td>
204     <td bgcolor="#C8CB8F" style=""> Get feedback </td>
205     <td bgcolor="#C8CB8F" style=""> Anne </td>
206     <td bgcolor="#C8CB8F" style=""> 1-Feb-02 </td>
207     <td bgcolor="#C8CB8F" style="">   </td>
208   </tr>
209   <tr>
210     <td bgcolor="#DBDDB5" style=""> 12 </td>
211     <td bgcolor="#DBDDB5" style=""> C </td>
212     <td bgcolor="#DBDDB5" style=""> Spec error handling </td>
213     <td bgcolor="#DBDDB5" style=""> Jack </td>
214     <td bgcolor="#DBDDB5" style=""> 1-Dec-02 </td>
215     <td bgcolor="#DBDDB5" style="">   </td>
216   </tr>
217   <tr>
218     <td bgcolor="#C8CB8F" style=""> 5 </td>
219     <td bgcolor="#C8CB8F" style="">   </td>
220     <td bgcolor="#C8CB8F" style=""> Abc </td>
221     <td bgcolor="#C8CB8F" style=""> John </td>
222     <td bgcolor="#C8CB8F" style="">   </td>
223     <td bgcolor="#C8CB8F" style="">   </td>
224   </tr>
225   <tr>
226     <th bgcolor="#000099" maxcols="0" style=""><span><font color="#FFFFCC"> <strong> Num </strong> </font></span></th>
227     <th bgcolor="#000099" maxcols="0" style=""><span><font color="#FFFFCC"> <strong> Status </strong> </font></span></th>
228     <th bgcolor="#000099" maxcols="0" style=""><span><font color="#FFFFCC"> <strong> Action </strong> </font></span></th>
229     <th bgcolor="#000099" maxcols="0" style=""><span><font color="#FFFFCC"> <strong> Who </strong> </font></span></th>
230     <th bgcolor="#000099" maxcols="0" style=""><span><font color="#FFFFCC"> <strong> When </strong> </font></span></th>
231     <th bgcolor="#000099" maxcols="0" style=""><span><font color="#FFFFCC"> <strong> Progress </strong> </font></span></th>
232   </tr>
233 </table>
234
235 ## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
236
237 **Note:** You do not need to install anything on the browser to use this plugin. Below installation instructions are for the administrator who needs to install this plugin on the TWiki server.
238
239 - Download the ZIP file from the Plugin web (see below)
240 - Unzip <code>**%TOPIC%.zip**</code> in your twiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0" style="border-width: 1px">
241   <tr>
242     <th bgcolor="#6b7f93" maxcols="0" style=""><a href="http://localhost?sortcol=0;table=3;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">File:</font></a></th>
243     <th bgcolor="#6b7f93" maxcols="0" style=""><a href="http://localhost?sortcol=1;table=3;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Description:</font></a></th>
244   </tr>
245   <tr>
246     <td bgcolor="#ecf2f8" style=""><code><b>data/TWiki/%TOPIC%.txt</b></code></td>
247     <td bgcolor="#ecf2f8" style=""> Plugin topic </td>
248   </tr>
249   <tr>
250     <td bgcolor="#ffffff" style=""><code><b>data/TWiki/%TOPIC%.txt,v</b></code></td>
251     <td bgcolor="#ffffff" style=""> Plugin topic repository </td>
252   </tr>
253   <tr>
254     <td bgcolor="#ecf2f8" style=""><code><b>lib/TWiki/Plugins/%TOPIC%.pm</b></code></td>
255     <td bgcolor="#ecf2f8" style=""> Plugin Perl module </td>
256   </tr>
257   <tr>
258     <td bgcolor="#ffffff" style=""><code><b>pub/TWiki/%TOPIC%/diamond.gif</b></code></td>
259     <td bgcolor="#ffffff" style=""> Diamond symbol </td>
260   </tr>
261   <tr>
262     <td bgcolor="#ecf2f8" style=""><code><b>pub/TWiki/%TOPIC%/down.gif</b></code></td>
263     <td bgcolor="#ecf2f8" style=""> Down arrow </td>
264   </tr>
265   <tr>
266     <td bgcolor="#ffffff" style=""><code><b>pub/TWiki/%TOPIC%/up.gif</b></code></td>
267     <td bgcolor="#ffffff" style=""> Up arrow </td>
268   </tr>
269 </table>
270 - Test if the plugin is correctly installed:
271   - Check above example if the table renders as expected
272   - Try click on heading to sort. Other tables should also be sortable
273
274 ## <a name="Plugin Info"></a> Plugin Info
275
276 <table border="1" cellpadding="0" cellspacing="0" style="border-width: 1px">
277   <tr>
278     <td align="right" bgcolor="#ecf2f8" style=""> Plugin Author: </td>
279     <td bgcolor="#ecf2f8" style="">[[TWiki/JohnTalintyre]], [[TWiki/PeterThoeny]]</td>
280   </tr>
281   <tr>
282     <td align="right" bgcolor="#ffffff" style=""> Plugin Version: </td>
283     <td bgcolor="#ffffff" style=""> 15 Dec 2002 </td>
284   </tr>
285   <tr>
286     <td align="right" bgcolor="#ecf2f8" style=""> Change History: </td>
287     <td bgcolor="#ecf2f8" style="">  </td>
288   </tr>
289   <tr>
290     <td align="right" bgcolor="#ffffff" style=""> 15 Dec 2002: </td>
291     <td bgcolor="#ffffff" style=""> PTh: Added headerrows and footerrows params (TWiki:Main/WoutMertens); added tablewidth and columnwidths params (TWiki:Main/ThorstenSommermann) </td>
292   </tr>
293   <tr>
294     <td align="right" bgcolor="#ecf2f8" style=""> 09 Dec 2002: </td>
295     <td bgcolor="#ecf2f8" style=""> PTh: Added headercolor and datacolor parameters </td>
296   </tr>
297   <tr>
298     <td align="right" bgcolor="#ffffff" style=""> 05 Jun 2002: </td>
299     <td bgcolor="#ffffff" style=""> 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) </td>
300   </tr>
301   <tr>
302     <td align="right" bgcolor="#ecf2f8" style=""> 13 Mar 2002: </td>
303     <td bgcolor="#ecf2f8" style=""> PTh: Added TWiki:Main/ShawnBradford 's initsort and initdirection </td>
304   </tr>
305   <tr>
306     <td align="right" bgcolor="#ffffff" style=""> 12 Mar 2002: </td>
307     <td bgcolor="#ffffff" style=""> PTh: Added valign, headeralign and dataalign; fixed bug of swapped cellpadding/cellspacing; fixed warning of uninitialized value </td>
308   </tr>
309   <tr>
310     <td align="right" bgcolor="#ecf2f8" style=""> 05 Jan 2002: </td>
311     <td bgcolor="#ecf2f8" style=""> PTh: Fixed sorting bug of cells with leading white space </td>
312   </tr>
313   <tr>
314     <td align="right" bgcolor="#ffffff" style=""> 06 Dec 2001: </td>
315     <td bgcolor="#ffffff" style=""> PTh: Fixed date sorting bug <br /> 03 Dec 2001 PTh: Fixed sort="off" bug and more </td>
316   </tr>
317   <tr>
318     <td align="right" bgcolor="#ecf2f8" style=""> 29 Nov 2001: </td>
319     <td bgcolor="#ecf2f8" style=""> PTh: Fixed Perl warnings </td>
320   </tr>
321   <tr>
322     <td align="right" bgcolor="#ffffff" style=""> 16 Nov 2001: </td>
323     <td bgcolor="#ffffff" style=""> PTh: Added table border, cell spacing, cell padding, gif files </td>
324   </tr>
325   <tr>
326     <td align="right" bgcolor="#ecf2f8" style=""> 07 Oct 2001: </td>
327     <td bgcolor="#ecf2f8" style=""> JT: Initial version </td>
328   </tr>
329   <tr>
330     <td align="right" bgcolor="#ffffff" style=""> CPAN Dependencies: </td>
331     <td bgcolor="#ffffff" style=""> none </td>
332   </tr>
333   <tr>
334     <td align="right" bgcolor="#ecf2f8" style=""> Other Dependencies: </td>
335     <td bgcolor="#ecf2f8" style=""> none </td>
336   </tr>
337   <tr>
338     <td align="right" bgcolor="#ffffff" style=""> Perl Version: </td>
339     <td bgcolor="#ffffff" style=""> 5.0 </td>
340   </tr>
341   <tr>
342     <td align="right" bgcolor="#ecf2f8" style=""> Plugin Home: </td>
343     <td bgcolor="#ecf2f8" style=""><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
344   </tr>
345   <tr>
346     <td align="right" bgcolor="#ffffff" style=""> Feedback: </td>
347     <td bgcolor="#ffffff" style=""><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a></td>
348   </tr>
349 </table>
350
351 **_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]], [[StandardColors]]
352
353 -- [[JohnTalintyre]] - 07 Oct 2001 <br /> -- [[PeterThoeny]] - 15 Dec 2002 <br />