diff options
author | Joey Hess <joey@kodama.kitenet.net> | 2008-09-11 18:41:26 -0400 |
---|---|---|
committer | Joey Hess <joey@kodama.kitenet.net> | 2008-09-11 18:41:26 -0400 |
commit | 9921a4a8a1a696ce69acce5e14943f0149d926ff (patch) | |
tree | 926ebf50f913087a99c05993a3b01e2d935c9878 /doc/ikiwiki/directive/table.mdwn | |
parent | 7d98c3d52bcdf2a3010843d176bf9fd79643207b (diff) |
Move the directive documentation into its own underlay, separate from basewiki, since it's sorta large compared to the rest of basewiki.
Diffstat (limited to 'doc/ikiwiki/directive/table.mdwn')
-rw-r--r-- | doc/ikiwiki/directive/table.mdwn | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/ikiwiki/directive/table.mdwn b/doc/ikiwiki/directive/table.mdwn new file mode 100644 index 000000000..0d1af1249 --- /dev/null +++ b/doc/ikiwiki/directive/table.mdwn @@ -0,0 +1,45 @@ +The `table` directive is supplied by the [[!iki plugins/table]] plugin. + +This directive can build HTML tables from data in CSV (comma-separated values) +or DSV (delimiter-separated values) format. + +## examples + + \[[!table data=""" + Customer|Amount + Fulanito|134,34 + Menganito|234,56 + Menganito|234,56 + """]] + + \[[!table class="book_record" format=csv file="data/books/record1"]] + +In this second example the `record1` page should be similar to: + + "Title","Perl Best Practices" + "Author","Damian Conway" + "Publisher","O’Reilly" + +To make a cell span multiple columns, follow it with one or more empty +cells. For example: + + \[[!table data=""" + left||right| + a|b|c|d + this cell spans 4 columns||| + """]] + +## usage + +* `data` - Values for the table. +* `file` - A file in the wiki containing the data. +* `format` - The format of the data, either "csv", "dsv", or "auto" + (the default). +* `delimiter` - The character used to separate fields. By default, + DSV format uses a pipe (`|`), and CSV uses a comma (`,`). +* `class` - A CSS class for the table html element. +* `header` - By default, or if set to "row", the first data line is used + as the table header. Set it to "no" to make a table without a header, or + "column" to make the first column be the header. + +[[!meta robots="noindex, follow"]] |