data/TWiki/VarTABLE.txt,v
author Colas Nahaboo <colas@nahaboo.net>
Mon, 11 Aug 2008 20:33:37 +0200
changeset 2 7bc60a767fa4
parent 0 414e01d06fd5
permissions -rw-r--r--
TWiki-4.2.2 Release
     1 head	1.1;
     2 access;
     3 symbols;
     4 locks; strict;
     5 comment	@# @;
     6 
     7 
     8 1.1
     9 date	2008.01.22.03.21.24;	author TWikiContributor;	state Exp;
    10 branches;
    11 next	;
    12 
    13 
    14 desc
    15 @buildrelease
    16 @
    17 
    18 
    19 1.1
    20 log
    21 @buildrelease
    22 @
    23 text
    24 @%META:TOPICINFO{author="TWikiContributor" date="1191730164" format="1.1" version="1"}%
    25 %META:TOPICPARENT{name="TWikiVariables"}%
    26 #VarTABLE
    27 ---+++ TABLE{ _attributes_ } -- control attributes of tables and sorting of table columns
    28    * The =%<nop>TABLE{}%= variable is handled by the TablePlugin
    29    * Syntax: =%<nop>TABLE{ _attributes_ }%=
    30 %STARTSECTION{"table_attributes"}%
    31    * Supported attributes:
    32      | *Argument*       | *Comment*  | *Default&nbsp;value*  | *Example*  |
    33      | =sort=           | Set table sorting by clicking headers ="on"= or ="off"=. | <span class="twikiGrayText">unspecified</span> | =sort="on"= |
    34      | =initsort=       | Column to sort initially (="1"= to number of columns). | <span class="twikiGrayText">unspecified</span> | =initsort="2"= |
    35      | =initdirection=  | Initial sorting direction for =initsort=, set to  ="up"= (descending) or ="down"= (ascending). | <span class="twikiGrayText">unspecified</span> | =initdirection="up"= |
    36      | =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. | <span class="twikiGrayText">unspecified</span> | =disableallsort="on"= |
    37      | =headerbg=       | Header cell background colour. | ="#6b7f93"= | =headerbg="#999999"= |
    38      | =headerbgsorted= | Header cell background colour of a sorted column. | the value of =headerbg= | =headerbgsorted="#32596c"= |
    39      | =headercolor=    | Header cell text colour. | ="#ffffff"= | =headercolor="#0000cc"= |
    40      | =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"= |
    41      | =databgsorted=   | Data cell background colour of a sorted column; see =databg=. | the values of =databg= | =databgsorted="#d4e8e4,#e5f5ea"= |
    42      | =datacolor=      | Data cell text colour, a comma separated list. | <span class="twikiGrayText">unspecified</span> | =datacolor="#0000CC, #000000"= |
    43      | =tableborder=    | Table border width (pixels). | ="1"= | =tableborder="2"= |
    44      | =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). | <span class="twikiGrayText">unspecified</span> | =tableframe="hsides"= |
    45      | =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). | <span class="twikiGrayText">unspecified</span>  | =tablerules="rows"= |
    46      | =cellpadding=    | Cell padding (pixels). | ="0"= | =cellpadding="0"= |
    47      | =cellspacing=    | Cell spacing (pixels). | ="0"= | =cellspacing="3"= |
    48      | =cellborder=     | Cell border width (pixels). | <span class="twikiGrayText">unspecified</span> | =cellborder="0"= |
    49      | =valign=         | Vertical alignment of cells and headers, set to ="top"=, ="middle"=, ="bottom"= or ="baseline"=. | <span class="twikiGrayText">unspecified</span>  | =valign="top"= |
    50      | =headervalign=   | Vertical alignment of header cells; overrides =valign=. | <span class="twikiGrayText">unspecified</span>  | =headervalign="top"= |
    51      | =datavalign=     | Vertical alignment of data cells; overrides =valign=. | <span class="twikiGrayText">unspecified</span>  | =datavalign="top"= |
    52      | =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. | <span class="twikiGrayText">unspecified</span>  | =headeralign="left,right"= |
    53      | =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. | <span class="twikiGrayText">unspecified</span>  | =dataalign="center"= |
    54      | =tablewidth=     | Table width: Percentage of window width, or absolute pixel value. | <span class="twikiGrayText">unspecified</span>  | =tablewidth="100%"= |
    55      | =columnwidths=   | Column widths: Comma delimited list of column widths, percentage or absolute pixel value. | <span class="twikiGrayText">unspecified</span>  | =columnwidths="80%,20%"= |
    56      | =headerrows=     | Number of header rows to exclude from sort. (will be rendered in a HTML =thead= section) | ="1"= | =headerrows="1"= |
    57      | =footerrows=     | Number of footer rows to exclude from sort. (will be rendered in a HTML =tfoot= section) | ="0"= | =footerrows="1"= |
    58      | =id=             | Unique table identifier string, used for targeting a table with CSS. | =tableN= (where N is the table order number on the page)  | =id="userTable"= |
    59      | =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. | <span class="twikiGrayText">unspecified</span> | =summary="List of subscribed users"= |
    60      | =caption=        | Table caption: A title that will be displayed just above the table.| <span class="twikiGrayText">unspecified</span> | =caption="Users"= |
    61 %ENDSECTION{"table_attributes"}%
    62    * Example:%BR%
    63      =%<nop>TABLE{ tableborder="0" cellpadding="4" cellspacing="3" cellborder="0" }%= %BR%
    64      =| <nop>*A1*<nop> | <nop>*B1*<nop> |= %BR%
    65      =| A2 | B2 |=
    66    * Related: See TablePlugin for more details
    67 @