Wikka Documentation: TableActionInfo

[2030] Latest edit on 2009-08-19 07:41:34 by DarTar [layout]

Additions:

BIG	GREEN	FROGS
yes	yes	no
no	no

Note that ### must be used to indicate an empty cell.
Complex tables can also be created by embedding HTML code in a wiki page.
Deletions:
Short description
Turns a simple list of cell contents into a (data) table.

Parameters

name type required? default description

delimiter char optional semicolon (;) delimiter that will be used to separate cells; must be a single character.

delim char optional ; synonym of delimiter

caption string optional none table caption

columns integer optional 1 number of columns the table is to have.

cols integer optional 1 synonym of columns

border integer optional 1 borderwidth of table.

cellpadding integer optional 3 padding within cells in pixels.

cellspacing integer optional 1 space between cells in pixels.

style string optional none in-line style for the table.

class string optional none alternative for style: use the class to style with the stylesheet.

summary string optional none summary of what the table contains.

cells string required content 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

Simple table with "forced" empty cell (###):
{{table columns="3" cells="a;b;c;1;###;3"}}

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"}}

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@@"}}

Error message created when required parameter cells is missing:
{{table cols="5" caption="invalid 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="\"
cells="\\\\==a==\==b==\==c==\
//1//\**2**\@@3@@\
\\//last
cell//\\"
}}

[863] Edited on 2008-02-22 09:19:12 by DarTar [styling]

Additions:
""<table class="data" cellspacing="0" cellpadding="2" border="1">
Deletions:
~~""<table cellspacing="0" cellpadding="2" border="1">~~

[541] Edited on 2008-01-30 15:49:39 by DarTar [this page needs to be rewritten]

Additions:

Table Action Documentation

Documentation

Short description

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

Parameters

name	type	required?	default	description
delimiter	char	optional	semicolon (;)	delimiter that will be used to separate cells; must be a single character.
delim	char	optional	;	synonym of delimiter
caption	string	optional	none	table caption
columns	integer	optional	1	number of columns the table is to have.
cols	integer	optional	1	synonym of columns
border	integer	optional	1	borderwidth of table.
cellpadding	integer	optional	3	padding within cells in pixels.
cellspacing	integer	optional	1	space between cells in pixels.
style	string	optional	none	in-line style for the table.
class	string	optional	none	alternative for style: use the class to style with the stylesheet.
summary	string	optional	none	summary of what the table contains.
cells	string	required		content 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

Simple table with "forced" empty cell (###):
{{table columns="3" cells="a;b;c;1;###;3"}}
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"}}
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@@"}}
Error message created when required parameter cells is missing:
{{table cols="5" caption="invalid 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="\"
cells="\\\\==a==\==b==\==c==\
//1//\**2**\@@3@@\
\\//last
cell//\\"
}}

CategoryDocumentation

Creative Common Attribution-ShareAlike License

Valid XHTML 1.0 Transitional :: Valid CSS :: Powered by WikkaWiki

Page was generated in 0.0841 seconds