Wiki source for TableActionInfo

Show raw source

=====Extended Table Action Documentation=====

>>==See also:==
~-[[ | table markup]] (since 1.1.7)
~-Development: TableAction.>>This is the documentation page for a proposed **extended table action**. The code is available on the TableAction page. The development of this action has been discontinued since the implementation of a new [[ | table markup]] in the [[WikkaUnstable | main development line]].::c::


==Short description==
Turns a simple list of cell contents into a (data) table.

""<table cellspacing="0" cellpadding="2" border="1">
<tr><th scope="col">name</th><th scope="col">type</th><th scope="col">required?</th><th scope="col">default</th><th scope="col">description</th></tr>
<tr><td>delimiter</td><td>char</td><td>optional</td><td>semicolon (;)</td><td>delimiter that will be used to separate cells; must be a single character.</td></tr>
<tr><td>delim</td><td>char</td><td>optional</td><td>;</td><td>synonym of <em>delimiter</em></td></tr>
<tr><td>caption</td><td>string</td><td>optional</td><td>none</td><td>table caption</td></tr>
<tr><td>columns</td><td>integer</td><td>optional</td><td>1</td><td>number of columns the table is to have.</td></tr>
<tr><td>cols</td><td>integer</td><td>optional</td><td>1</td><td>synonym of <em>columns</em></td></tr>
<tr><td>border</td><td>integer</td><td>optional</td><td>1</td><td>borderwidth of table.</td></tr>
<tr><td>cellpadding</td><td>integer</td><td>optional</td><td>3</td><td>padding within cells in pixels.</td></tr>
<tr><td>cellspacing</td><td>integer</td><td>optional</td><td>1</td><td>space between cells in pixels.</td></tr>
<tr><td>style</td><td>string</td><td>optional</td><td>none</td><td>in-line style for the table.</td></tr>
<tr><td>class</td><td>string</td><td>optional</td><td>none</td><td>alternative for style: use the class to style with the stylesheet.</td></tr>
<tr><td>summary</td><td>string</td><td>optional</td><td>none</td><td>summary of what the table contains.</td></tr>
<tr><td>cells</td><td>string</td><td><strong>required</strong></td><td></td><td>content of the table with cells separated by the (defined) delimiter.</td></tr>
==Long description==
Wikka markup within cells is interpreted but HTML markup for cell contents is not possible.

There is only one required paramater: cells; if this is missing an error message will be displayed, along with the original action markup.

It is possible to define cell contents across multiple lines; surrounding whitespace is trimmed before generating output, embedded whitespace (including newlines) is retained.

Cell contents must be separated by a delimiter character; by default this is a semicolon, but if this would conflict with cell contents, a delimiter can be defined with the delimiter (or delim) parameter. Superfluous delimiters at the start and end of the cells parameter are discarded, so it's possible to write each cell row on a separate line, and end each cell with the delimiter: this makes it relatively easy to maintain table contents.

A caption can be defined, as well as a summary.
There is limited support for table headers (th cells): if cell content is embedded in sets of 2 to 5 '=' characters (as in heading markup) these will be discarded and a header cell (th) will be generated instead of a data cell (td). Row groups (thead, tfoot, tbody) are NOT supported.
The result is valid (data) table markup although accessibility will be limited.


~- Simple table with "forced" empty cell (""###""):--- ""{{table columns="3" cells="a;b;c;1;###;3"}}""--- {{image url="" alt="sample output table action" title="sample output table action"}}
~- Using delimiter '+' instead of ';' because a cell contains a semicolon; and Wikka heading markup being turned into table header cells: ---""{{table columns="3" cellpadding="1" delim="+" cells="==a==+b+c+==1==+2;3;4;5+6"}}""--- {{image url="" alt="sample output table action" title="sample output table action"}}
~- Header cells created with Wikka heading markup, and Wikka markup (italic, bold and centered) within table cells:--- ""{{table columns="3" cellpadding="2" cells="==a==;==b==;==c==;//1//;**2**;@@3@@"}}""--- {{image url="" alt="sample output table action" title="sample output table action"}}
~- Error message created when required parameter ##cells## is missing:--- ""{{table cols="5" caption="invalid table action"}}""--- {{image url="" alt="sample output table action" title="sample output table action"}}
~- Action across multiple lines, with also newlines separating table rows within the cells parameter; surrounding (extra) delimiters are automatically discarded so each table row, including the last, can be terminated with the (defined) delimiter. Note that the last table row starts with two (implicit) empty cells while the content for the last cell contains a new line (rendered as intended):--- ""{{table cols="3" cellpadding="10" delimiter="\"<br />
cells="\\\\==a==\==b==\==c==\<br />
//1//\**2**\@@3@@\<br />
\\//last<br />
cell//\\"<br />
}}""--- {{image url="" alt="sample output table action" title="sample output table action"}}

Valid XHTML :: Valid CSS: :: Powered by WikkaWiki