aboutsummaryrefslogtreecommitdiff
path: root/doc/markup.rst
diff options
context:
space:
mode:
authorOleg Grenrus <oleg.grenrus@iki.fi>2017-12-26 17:13:14 +0200
committerAlexander Biehl <alexbiehl@gmail.com>2018-02-01 14:58:18 +0100
commit088b1993fb6c6ed014a95e93d7c07f68218c7777 (patch)
tree47d7c1c85657bf7670ff154ad9a9bc1d1538b0d0 /doc/markup.rst
parent2e0d7aef60fbb17f29ffa1f363ffc423f31185fc (diff)
Grid Tables (#718)
* Add table examples * Add table types and adopt simple parser Simple parser is done by Giovanni Cappellotto (@potomak) in https://github.com/haskell/haddock/pull/577 It seems to support single fine full tables, so far from full RST-grid tables, but it's good start. Table type support row- and colspans, but obviously parser is lacking. Still TODO: - Latex backend. Should we use multirow package https://ctan.org/pkg/multirow?lang=en? - Hoogle backend: ? * Implement grid-tables * Refactor table parser * Add two ill-examples * Update CHANGES.md * Basic documentation for tables * Fix documentation example
Diffstat (limited to 'doc/markup.rst')
-rw-r--r--doc/markup.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/markup.rst b/doc/markup.rst
index d0b9392d..acabaa28 100644
--- a/doc/markup.rst
+++ b/doc/markup.rst
@@ -1078,6 +1078,26 @@ If the output format supports it, the mathematics will be rendered
inside the documentation. For example, the HTML backend will display
the mathematics via `MathJax <https://www.mathjax.org>`__.
+Grid Tables
+~~~~~~~~~~~
+
+Inspired by reSTs grid tables Haddock supports a complete table representation via a grid-like "ASCII art". Grid tables are described with a visual grid made up of the characters "-", "=", "|", and "+". The hyphen ("-") is used for horizontal lines (row separators). The equals sign ("=") may be used to separate optional header rows from the table body. The vertical bar ("|") is used for vertical lines (column separators). The plus sign ("+") is used for intersections of horizontal and vertical lines. ::
+
+ -- | This is a grid table:
+ --
+ -- +------------------------+------------+----------+----------+
+ -- | Header row, column 1 | Header 2 | Header 3 | Header 4 |
+ -- | (header rows optional) | | | |
+ -- +========================+============+==========+==========+
+ -- | body row 1, column 1 | column 2 | column 3 | column 4 |
+ -- +------------------------+------------+----------+----------+
+ -- | body row 2 | Cells may span columns. |
+ -- +------------------------+------------+---------------------+
+ -- | body row 3 | Cells may | \[ |
+ -- +------------------------+ span rows. | f(n) = \sum_{i=1} |
+ -- | body row 4 | | \] |
+ -- +------------------------+------------+---------------------+
+
Anchors
~~~~~~~