aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/table.mdwn
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2007-03-07 11:40:22 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2007-03-07 11:40:22 +0000
commit5d57a8436f2c41687cf047abf0cbd31af61de83c (patch)
tree7c0a2291337c8157f362f1c8084e756549bb9e31 /doc/plugins/table.mdwn
parent750553dfd46b729d0579707135a25e0470c6a388 (diff)
downloadikiwiki-5d57a8436f2c41687cf047abf0cbd31af61de83c.tar
ikiwiki-5d57a8436f2c41687cf047abf0cbd31af61de83c.tar.gz
* Add a table plugin, derived from the one written by Victor Moral.
Diffstat (limited to 'doc/plugins/table.mdwn')
-rw-r--r--doc/plugins/table.mdwn35
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/plugins/table.mdwn b/doc/plugins/table.mdwn
new file mode 100644
index 000000000..88b509004
--- /dev/null
+++ b/doc/plugins/table.mdwn
@@ -0,0 +1,35 @@
+[[template id=plugin name=table author="[[VictorMoral]]"]]
+[[tag type/format]]
+
+This plugin 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|
+ """]]
+
+ \[[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"
+
+## 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` - Set to 0 to make a table without a header. By default,
+ the first data line is used as the table header.