related ideas

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

diff --git a/doc/plugins/table.mdwn b/doc/plugins/table.mdwn
index 569e5698250130576b5318e6346a66a4b6314191..d16bcc7265dd232d3f7c0bda7ae51df9768c362b 100644 (file)
--- a/doc/plugins/table.mdwn
+++ b/doc/plugins/table.mdwn
@@ -1,35 +1,12 @@
-[[template id=plugin name=table author="[[VictorMoral]]"]]
-[[tag type/format]]
+[[!template id=plugin name=table author="[[VictorMoral]]"]]
+[[!tag type/widget]]

 
 

-This plugin can build HTML tables from data in CSV (comma-separated values)
-or DSV (delimiter-separated values) format.
+This plugin provides the [[ikiwiki/directive/table]] [[ikiwiki/directive]].
+It can build HTML tables from data in CSV (comma-separated values)
+or DSV ([delimiter-separated values](http://en.wikipedia.org/wiki/Delimiter-separated_values)) format.

 
 

-It needs the perl module [[cpan Text::CSV]] for the CSV data.
+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.
+Note that you can also build tables in [[ikiwiki/Markdown]] pages
+without using this plugin, by enabling the `multimarkdown` option
+and installing the [[!cpan Text::MultiMarkdown]] Perl module or simply by using the `<table>` HTML tag.