1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/data/TWiki/VarTABLE.txt Sat Jan 26 15:50:53 2008 +0100
1.3 @@ -0,0 +1,43 @@
1.4 +%META:TOPICINFO{author="TWikiContributor" date="1191730164" format="1.1" version="1"}%
1.5 +%META:TOPICPARENT{name="TWikiVariables"}%
1.6 +#VarTABLE
1.7 +---+++ TABLE{ _attributes_ } -- control attributes of tables and sorting of table columns
1.8 + * The =%<nop>TABLE{}%= variable is handled by the TablePlugin
1.9 + * Syntax: =%<nop>TABLE{ _attributes_ }%=
1.10 +%STARTSECTION{"table_attributes"}%
1.11 + * Supported attributes:
1.12 + | *Argument* | *Comment* | *Default value* | *Example* |
1.13 + | =sort= | Set table sorting by clicking headers ="on"= or ="off"=. | <span class="twikiGrayText">unspecified</span> | =sort="on"= |
1.14 + | =initsort= | Column to sort initially (="1"= to number of columns). | <span class="twikiGrayText">unspecified</span> | =initsort="2"= |
1.15 + | =initdirection= | Initial sorting direction for =initsort=, set to ="up"= (descending) or ="down"= (ascending). | <span class="twikiGrayText">unspecified</span> | =initdirection="up"= |
1.16 + | =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"= |
1.17 + | =headerbg= | Header cell background colour. | ="#6b7f93"= | =headerbg="#999999"= |
1.18 + | =headerbgsorted= | Header cell background colour of a sorted column. | the value of =headerbg= | =headerbgsorted="#32596c"= |
1.19 + | =headercolor= | Header cell text colour. | ="#ffffff"= | =headercolor="#0000cc"= |
1.20 + | =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"= |
1.21 + | =databgsorted= | Data cell background colour of a sorted column; see =databg=. | the values of =databg= | =databgsorted="#d4e8e4,#e5f5ea"= |
1.22 + | =datacolor= | Data cell text colour, a comma separated list. | <span class="twikiGrayText">unspecified</span> | =datacolor="#0000CC, #000000"= |
1.23 + | =tableborder= | Table border width (pixels). | ="1"= | =tableborder="2"= |
1.24 + | =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"= |
1.25 + | =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"= |
1.26 + | =cellpadding= | Cell padding (pixels). | ="0"= | =cellpadding="0"= |
1.27 + | =cellspacing= | Cell spacing (pixels). | ="0"= | =cellspacing="3"= |
1.28 + | =cellborder= | Cell border width (pixels). | <span class="twikiGrayText">unspecified</span> | =cellborder="0"= |
1.29 + | =valign= | Vertical alignment of cells and headers, set to ="top"=, ="middle"=, ="bottom"= or ="baseline"=. | <span class="twikiGrayText">unspecified</span> | =valign="top"= |
1.30 + | =headervalign= | Vertical alignment of header cells; overrides =valign=. | <span class="twikiGrayText">unspecified</span> | =headervalign="top"= |
1.31 + | =datavalign= | Vertical alignment of data cells; overrides =valign=. | <span class="twikiGrayText">unspecified</span> | =datavalign="top"= |
1.32 + | =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"= |
1.33 + | =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"= |
1.34 + | =tablewidth= | Table width: Percentage of window width, or absolute pixel value. | <span class="twikiGrayText">unspecified</span> | =tablewidth="100%"= |
1.35 + | =columnwidths= | Column widths: Comma delimited list of column widths, percentage or absolute pixel value. | <span class="twikiGrayText">unspecified</span> | =columnwidths="80%,20%"= |
1.36 + | =headerrows= | Number of header rows to exclude from sort. (will be rendered in a HTML =thead= section) | ="1"= | =headerrows="1"= |
1.37 + | =footerrows= | Number of footer rows to exclude from sort. (will be rendered in a HTML =tfoot= section) | ="0"= | =footerrows="1"= |
1.38 + | =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"= |
1.39 + | =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"= |
1.40 + | =caption= | Table caption: A title that will be displayed just above the table.| <span class="twikiGrayText">unspecified</span> | =caption="Users"= |
1.41 +%ENDSECTION{"table_attributes"}%
1.42 + * Example:%BR%
1.43 + =%<nop>TABLE{ tableborder="0" cellpadding="4" cellspacing="3" cellborder="0" }%= %BR%
1.44 + =| <nop>*A1*<nop> | <nop>*B1*<nop> |= %BR%
1.45 + =| A2 | B2 |=
1.46 + * Related: See TablePlugin for more details