X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/14ed04b2e90592d3270d9ec60dd72588f00bdc07..43ad6bf96171e88a165278078d61fd221f14b1b4:/doc/plugins/table.mdwn diff --git a/doc/plugins/table.mdwn b/doc/plugins/table.mdwn index 6920c8f80..fe66f90a8 100644 --- a/doc/plugins/table.mdwn +++ b/doc/plugins/table.mdwn @@ -1,45 +1,8 @@ -[[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. - -## examples - - \[[table data=""" - Customer|Amount - Fulanito|134,34 - Menganito|234,56 - 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" - -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. -* `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 "no" to make a table without a header. By default, - the first data line is used as the table header. +It needs the perl module [[!cpan Text::CSV]] for the CSV data.