escape directive properly; add paragraph breaks

[git.ikiwiki.info.git] / doc / ikiwiki / directive / table.mdwn

diff --git a/doc/ikiwiki/directive/table.mdwn b/doc/ikiwiki/directive/table.mdwn
index 0d1af124953bc564d4d830bc49c188dd31c0f6d5..3e791778978e42b87d20d55eeee813555c338408 100644 (file)
--- a/doc/ikiwiki/directive/table.mdwn
+++ b/doc/ikiwiki/directive/table.mdwn
@@ -1,4 +1,4 @@
-The `table` directive is supplied by the [[!iki plugins/table]] plugin.
+The `table` directive is supplied by the [[!iki plugins/table desc=table]] plugin.
 
 This directive can build HTML tables from data in CSV (comma-separated values)
 or DSV (delimiter-separated values) format.
@@ -6,8 +6,8 @@ or DSV (delimiter-separated values) format.
 ## examples
 
        \[[!table data="""
-       Customer|Amount
-       Fulanito|134,34
+       Customer |Amount
+       Fulanito |134,34
        Menganito|234,56
        Menganito|234,56
        """]]
@@ -26,7 +26,7 @@ cells. For example:
        \[[!table data="""
        left||right|
        a|b|c|d
-       this cell spans 4 columns|||
+       this cell spans **4** columns|||
        """]]
 
 ## usage
@@ -42,4 +42,12 @@ cells. For example:
   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.
 
+For tab-delimited tables (often obtained by copying and pasting from HTML
+or a spreadsheet), `delimiter` must be set to a literal tab character. These
+are difficult to type in most web browsers - copying and pasting one from
+the table data is likely to be the easiest way.
+
+Note that the contents of table cells can contain arbitrary ikiwiki and
+markdown markup.
+
 [[!meta robots="noindex, follow"]]