X-Git-Url: http://git.tremily.us/?a=blobdiff_plain;f=doc%2Fplugins%2Ftable.mdwn;fp=doc%2Fplugins%2Ftable.mdwn;h=88b509004d75947077bd9b4dabcbb4fbb4d36829;hb=5d57a8436f2c41687cf047abf0cbd31af61de83c;hp=0000000000000000000000000000000000000000;hpb=750553dfd46b729d0579707135a25e0470c6a388;p=ikiwiki.git

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.