aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/table.mdwn
blob: b99bb7cd5d0a9d692ce0c0830d0f0c2caee03f06 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
[[!template id=plugin name=table author="[[VictorMoral]]"]]
[[!tag type/format]]

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.

## 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.