web commit by http://subvert.org.uk/~bma/: Add my thoughts.

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

diff --git a/doc/plugins/table.mdwn b/doc/plugins/table.mdwn
index 88b509004d75947077bd9b4dabcbb4fbb4d36829..6920c8f8080e53175afc9ccb5ab3c70519564a72 100644 (file)
--- a/doc/plugins/table.mdwn
+++ b/doc/plugins/table.mdwn
@@ -1,7 +1,7 @@
 [[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 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.
@@ -9,9 +9,10 @@ It needs the perl module [[cpan Text::CSV]] for the CSV data.
 ## examples
 
        \[[table data="""
-       Customer|Amount|
-       Fulanito|134,34|
-       Menganito|234,56|
+       Customer|Amount
+       Fulanito|134,34
+       Menganito|234,56
+       Menganito|234,56
        """]]
     
        \[[table class="book_record" format=csv file="data/books/record1"]]
@@ -22,6 +23,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 +41,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.