* table plugin: Actually specify the delimiter.

[ikiwiki.git] / doc / plugins / table.mdwn

diff --git a/doc/plugins/table.mdwn b/doc/plugins/table.mdwn
index e84f6f947c780d8d4157e83db523648e0e99aff8..89bec987c4b0ae42c2342c45b5291ebca5c817da 100644 (file)
--- a/doc/plugins/table.mdwn
+++ b/doc/plugins/table.mdwn
@@ -6,12 +6,23 @@ or DSV (delimiter-separated values) format.
 
 It needs the perl module [[cpan Text::CSV]] for the CSV data.
 
+[[table data="""
+"foo",[[joey]],"bar"
+"bar",[[joeyno]], foo"
+"""]]
+
+[[table data="""
+foo|[[joey]]|bar
+bar|[[joeyno]]|foo
+"""]]
+
 ## examples
 
        \[[table data="""
        Customer|Amount
        Fulanito|134,34
        Menganito|234,56
+       Menganito|234,56
        """]]
     
        \[[table class="book_record" format=csv file="data/books/record1"]]
@@ -22,6 +33,15 @@ In this second example the `record1` page should be similar to:
        "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.
@@ -31,5 +51,5 @@ In this second example the `record1` page should be similar to:
 * `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,
+* `header` - Set to "no" to make a table without a header. By default,
   the first data line is used as the table header.