further refinement
[ikiwiki.git] / doc / plugins / table.mdwn
1 [[template id=plugin name=table author="[[VictorMoral]]"]]
2 [[tag type/format]]
3
4 This plugin can build HTML tables from data in CSV (comma-separated values)
5 or DSV (delimiter-separated values) format.
6
7 It needs the perl module [[cpan Text::CSV]] for the CSV data.
8
9 ## examples
10
11         \[[table data="""
12         Customer|Amount
13         Fulanito|134,34
14         Menganito|234,56
15         """]]
16     
17         \[[table class="book_record" format=csv file="data/books/record1"]]
18
19 In this second example the `record1` page should be similar to:
20
21         "Title","Perl Best Practices"
22         "Author","Damian Conway"
23         "Publisher","O‚ÄôReilly"
24
25 ## usage
26
27 * `data` - Values for the table.
28 * `file` - A file in the wiki containing the data.
29 * `format` - The format of the data, either "csv", "dsv", or "auto"
30   (the default).
31 * `delimiter` - The character used to separate fields. By default,
32    DSV format uses a pipe (`|`), and CSV uses a comma (`,`).
33 * `class` - A CSS class for the table html element.
34 * `header` - Set to 0 to make a table without a header. By default,
35   the first data line is used as the table header.