summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/table.mdwn
blob: 87aaac7c0e9a4f7ebd6ee21e35142a8ec4d3cc6d (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
46
47
48
49
50
51
52
53
54
55
56
57
58
[[!if test="enabled(table)"
  then="In diesem Wiki ist die Direktive: table **aktiviert**."
 else="In diesem Wiki ist die Direktive: table **nicht aktiv**; falls dies gewünscht wird, den Admin benachrichtigen."]]

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

## 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` - By default, or if set to "row", the first data line is used
  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"]]