aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/table.mdwn
diff options
context:
space:
mode:
authorWilliam Uther <willu@cse.unsw.edu.au>2008-09-11 17:05:51 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-09-11 17:05:51 -0400
commitc69a7f758590c91bd137a8d1cfa99f37bf28045a (patch)
tree16cbc730e9b63528b6a608856e8221b4fba40390 /doc/plugins/table.mdwn
parent4f0ac7fe59c196a602e07cc6c4abfc248999ec6b (diff)
downloadikiwiki-c69a7f758590c91bd137a8d1cfa99f37bf28045a.tar
ikiwiki-c69a7f758590c91bd137a8d1cfa99f37bf28045a.tar.gz
patch plugin documentation to refer to directive pages
Diffstat (limited to 'doc/plugins/table.mdwn')
-rw-r--r--doc/plugins/table.mdwn42
1 files changed, 2 insertions, 40 deletions
diff --git a/doc/plugins/table.mdwn b/doc/plugins/table.mdwn
index 2dccb9458..ec6e34f55 100644
--- a/doc/plugins/table.mdwn
+++ b/doc/plugins/table.mdwn
@@ -1,46 +1,8 @@
[[!template id=plugin name=table author="[[VictorMoral]]"]]
[[!tag type/format]]
-This plugin can build HTML tables from data in CSV (comma-separated values)
+This plugin implements the [[ikiwiki/directive/table]] [[ikiwiki/directive]].
+The directive can build HTML tables from data in CSV (comma-separated values)
or DSV (delimiter-separated values) format.
It needs the perl module [[!cpan Text::CSV]] for the CSV data.
-
-## 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.