aboutsummaryrefslogtreecommitdiff
path: root/underlays/basewiki/directive/table.mdwn
diff options
context:
space:
mode:
authorWilliam Uther <willu@cse.unsw.edu.au>2008-09-11 17:04:23 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-09-11 17:05:19 -0400
commit4f0ac7fe59c196a602e07cc6c4abfc248999ec6b (patch)
tree725f523faeb8e8db0efd81be4024257799c93ef8 /underlays/basewiki/directive/table.mdwn
parent595b0359157d1f57ee5a87c63e665dfa1d2130ec (diff)
downloadikiwiki-4f0ac7fe59c196a602e07cc6c4abfc248999ec6b.tar
ikiwiki-4f0ac7fe59c196a602e07cc6c4abfc248999ec6b.tar.gz
add underlay files for listdirectives
As was noted, 'listdirectives' didn't include the underlay files that make it really worthwhile. I've just gone through all the plugin documentation, modified it to remove installation information and renamed the files to match the directives rather than the plugins. This can now serve as useful underlay. I've only gone through plugins in the 'plugins' dir. I did not go through the 'contrib' dir.
Diffstat (limited to 'underlays/basewiki/directive/table.mdwn')
-rw-r--r--underlays/basewiki/directive/table.mdwn43
1 files changed, 43 insertions, 0 deletions
diff --git a/underlays/basewiki/directive/table.mdwn b/underlays/basewiki/directive/table.mdwn
new file mode 100644
index 000000000..0ddb0a9a3
--- /dev/null
+++ b/underlays/basewiki/directive/table.mdwn
@@ -0,0 +1,43 @@
+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.