aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2009-12-05 21:34:46 +0000
committerfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2009-12-05 21:34:46 +0000
commitad5450266ce29ff6ed9e238ca0cc14f08da862f7 (patch)
treef1e5ac57d7e655544803209ad7ba978c88662887 /README
parentde38adc7f3d63038b7c72856d25d6e03b2930f8d (diff)
downloadpandoc-ad5450266ce29ff6ed9e238ca0cc14f08da862f7.tar.gz
Allow markdown tables without headers.
Resolves Issue #50. The new syntax is described in README. Also allow optional line of dashes at bottom of simple tables. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1652 788f1e2b-df1e-0410-8736-df70ead52e1b
Diffstat (limited to 'README')
-rw-r--r--README40
1 files changed, 36 insertions, 4 deletions
diff --git a/README b/README
index 86a128b8f..bc40566fc 100644
--- a/README
+++ b/README
@@ -705,9 +705,23 @@ to the dashed line below it:[^3]
[^3]: This scheme is due to Michel Fortin, who proposed it on the
[Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).
-The table must end with a blank line. Optionally, a caption may be
-provided (as illustrated in the example above). A caption is a paragraph
-beginning with the string `Table:`, which will be stripped off.
+The table must end with a blank line, or a line of dashes followed by
+a blank line. A caption may optionally be provided (as illustrated in
+the example above). A caption is a paragraph beginning with the string
+`Table:`, which will be stripped off.
+
+The column headers may be omitted, provided a dashed line is used
+to end the table. For example:
+
+ ------- ------ ---------- -------
+ 12 12 12 12
+ 123 123 123 123
+ 1 1 1 1
+ ------- ------ ---------- -------
+
+When headers are omitted, column alignments are determined on the basis
+of the first line of the table body. So, in the tables above, the columns
+would be right, left, center, and right aligned, respectively.
Multiline tables allow headers and table rows to span multiple lines
of text. Here is an example:
@@ -729,7 +743,8 @@ of text. Here is an example:
These work like simple tables, but with the following differences:
- - They must begin with a row of dashes, before the header text.
+ - They must begin with a row of dashes, before the header text
+ (unless the headers are omitted).
- They must end with a row of dashes, then a blank line.
- The rows must be separated by blank lines.
@@ -738,6 +753,23 @@ the columns, and the writers try to reproduce these relative widths in
the output. So, if you find that one of the columns is too narrow in the
output, try widening it in the markdown source.
+Headers may be omitted in multiline tables as well as simple tables:
+
+ ----------- ------- --------------- -------------------------
+ First row 12.0 Example of a row that
+ spans multiple lines.
+
+ Second row 5.0 Here's another one. Note
+ the blank line between
+ rows.
+ -------------------------------------------------------------
+
+ Table: Here's a multiline table without headers.
+
+It is possible for a multiline table to have just one row, but the row
+should be followed by a blank line (and then the row of dashes that ends
+the table), or the table may be interpreted as a simple table.
+
Delimited Code blocks
---------------------