Revision [4226]

This is an old revision of TableActionInfo made by JavaWoman on 2005-01-07 18:56:23.

 

Table Action Documentation


See also:
Development: TableAction.
This is the documentation page for the Table action.
 

Once the planned 'autodoc' feature for actions is "live", this page will contain the automatically-generated documentation by just including an action; for now, I've just manually created the text.

Documentation


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

Parameters
nametyperequired?defaultdescription
delimitercharoptionalsemicolon (;)delimiter that will be used to separate cells; must be a single character.
delimcharoptional;synonym of delimiter
captionstringoptionalnonetable caption
columnsintegeroptional1number of columns the table is to have.
colsintegeroptional1synonym of columns
borderintegeroptional1borderwidth of table.
cellpaddingintegeroptional3padding within cells in pixels.
cellspacingintegeroptional1space between cells in pixels.
stylestringoptionalnonein-line style for the table.
classstringoptionalnonealternative for style: use the class to style with the stylesheet.
summarystringoptionalnonesummary of what the table contains.
cellsstringrequiredcontent of the table with cells separated by the (defined) delimiter.

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.

Author
JavaWoman

Examples




CategoryDocumentation
There are 13 comments on this page. [Show comments]
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki