aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2007-01-15 19:52:42 +0000
committerfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2007-01-15 19:52:42 +0000
commit60989d0637780787fb337b94af212f1ee9e1ae22 (patch)
tree95b5caa1e7e304a47739532a9c4d3767ce54435c /README
parent4224d913880e4f77a358cda868c9d1ca75820506 (diff)
downloadpandoc-60989d0637780787fb337b94af212f1ee9e1ae22.tar.gz
Added support for tables in markdown reader and in LaTeX,
DocBook, and HTML writers. The syntax is documented in README. Tests have been added to the test suite. git-svn-id: https://pandoc.googlecode.com/svn/trunk@493 788f1e2b-df1e-0410-8736-df70ead52e1b
Diffstat (limited to 'README')
-rw-r--r--README65
1 files changed, 65 insertions, 0 deletions
diff --git a/README b/README
index 23290fadd..8abdad6a9 100644
--- a/README
+++ b/README
@@ -471,6 +471,71 @@ they cannot contain multiple paragraphs). The syntax is as follows:
Inline and regular footnotes may be mixed freely.
+Tables
+------
+
+Two kinds of tables may be used. Both kinds presuppose the use of
+a fixed-width font, such as Courier. Currently only the HTML,
+Docbook, and LaTeX writers support tables.
+
+Simple tables look like this:
+
+ Right Left Center Default
+ ------- ------ ---------- -------
+ 12 12 12 12
+ 123 123 123 123
+ 1 1 1 1
+
+ Table: Demonstration of simple table syntax.
+
+The headers and table rows must each fit on one line. Column
+alignments are determined by the position of the header text relative
+to the dashed line below it:[^2]
+
+ - If the dashed line is flush with the header text on the right side
+ but extends beyond it on the left, the column is right-aligned.
+ - If the dashed line is flush with the header text on the left side
+ but extends beyond it on the right, the column is left-aligned.
+ - If the dashed line extends beyond the header text on both sides,
+ the column is centered.
+ - If the dashed line is flush with the header text on both sides,
+ the default alignment is used (in most cases, this will be left).
+
+[^2]: 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 parser pays attention to the widths of 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.
+
+Multiline tables allow headers and table rows to span multiple lines
+of text. Here is an example:
+
+ ---------------------------------------------------------------
+ Centered Left Right
+ Header Aligned Aligned Default aligned
+ ---------- --------- ----------- ---------------------------
+ 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: Optional caption. This, too, may span multiple
+ lines.
+
+These work like simple tables, but with the following differences:
+
+ - They must begin with a row of dashes, before the header text.
+ - They must end with a row of dashes, then a blank line.
+ - The rows must be separated by blank lines.
+
Embedded HTML
-------------