git.iko.soy/typeable/pandoc
on master help sign in
Added README description of pipe tables.
ed4039cJohn MacFarlane
README+44−5
@@ -1335,10 +1335,13 @@ Tables
1335
1335
1336*Pandoc extension*.
1336*Pandoc extension*.
1337
1337
1338−Three kinds of tables may be used. All three kinds presuppose the use of
1338+Four kinds of tables may be used. The first three kinds presuppose the use of
1339−a fixed-width font, such as Courier.
1339+a fixed-width font, such as Courier. The fourth kind can be used with
1340+proportionally spaced fonts, as it does not require lining up columns.
1340
1341
1342+### Simple tables
1343+
1341−**Simple tables** look like this:
1344+Simple tables look like this:
1342
1345
1343 Right Left Center Default
1346 Right Left Center Default
1344 ------- ------ ---------- -------
1347 ------- ------ ---------- -------
@@ -1383,7 +1386,9 @@ When headers are omitted, column alignments are determined on the basis
1383of the first line of the table body. So, in the tables above, the columns
1386of the first line of the table body. So, in the tables above, the columns
1384would be right, left, center, and right aligned, respectively.
1387would be right, left, center, and right aligned, respectively.
1385
1388
1389+### Multiline tables
1390+
1386−**Multiline tables** allow headers and table rows to span multiple lines
1391+Multiline tables allow headers and table rows to span multiple lines
1387of text (but cells that span multiple columns or rows of the table are
1392of text (but cells that span multiple columns or rows of the table are
1388not supported). Here is an example:
1393not supported). Here is an example:
1389
1394
@@ -1431,7 +1436,9 @@ It is possible for a multiline table to have just one row, but the row
1431should be followed by a blank line (and then the row of dashes that ends
1436should be followed by a blank line (and then the row of dashes that ends
1432the table), or the table may be interpreted as a simple table.
1437the table), or the table may be interpreted as a simple table.
1433
1438
1439+### Grid tables
1440+
1434−**Grid tables** look like this:
1441+Grid tables look like this:
1435
1442
1436 : Sample grid table.
1443 : Sample grid table.
1437
1444
@@ -1453,6 +1460,38 @@ columns or rows. Grid tables can be created easily using [Emacs table mode].
1453
1460
1454 [Emacs table mode]: http://table.sourceforge.net/
1461 [Emacs table mode]: http://table.sourceforge.net/
1455
1462
1463+### Pipe tables
1464+
1465+Pipe tables look like this:
1466+
1467+ | Right | Left | Default | Center |
1468+ |------:|:-----|---------|:------:|
1469+ | 12 | 12 | 12 | 12 |
1470+ | 123 | 123 | 123 | 123 |
1471+ | 1 | 1 | 1 | 1 |
1472+
1473+ : Demonstration of simple table syntax.
1474+
1475+The syntax is the same as in [PHP markdown extra]. The beginning and
1476+ending pipe characters are optional, but pipes are required between all
1477+columns. The colons indicate column alignment as shown. The header
1478+can be omitted, but the horizontal line must still be included, as
1479+it defines column alignments.
1480+
1481+Since the pipes indicate column boundaries, columns need not be vertically
1482+aligned, as they are in the above example. So, this is a perfectly
1483+legal (though ugly) pipe table:
1484+
1485+ fruit| price
1486+ -----|-----:
1487+ apple|2.05
1488+ pear|1.37
1489+ orange|3.09
1490+
1491+The cells of pipe tables cannot contain block elements like paragraphs
1492+and lists, and cannot span multiple lines.
1493+
1494+ [PHP markdown extra]: http://michelf.ca/projects/php-markdown/extra/#table
1456
1495
1457Title block
1496Title block
1458-----------
1497-----------