Tissevert/pandoc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

DokuWiki writer: Make tables prettier by aligning columns.

Browse source 
Also cleaned up crufty code and added tests.
This commit is contained in:
John MacFarlane 2014-08-30 21:24:33 -07:00
parent d97aed3903
commit 374bb3c147
4 changed files with 50 additions and 66 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
changelog
View file

@ -60,6 +60,8 @@ pandoc (1.13.1)
+ Refactor to use Reader monad (Matthew Pickering).
+ Avoid using raw HTML in table cells; instead, use `\\`
instead of newlines (Jesse Rosenthal).
+ Properly handle HTML table cell alignments, and use spacing
to make the tables look prettier (#1566).
* Docx writer:

62
src/Text/Pandoc/Writers/DokuWiki.hs
View file

@ -48,7 +48,7 @@ import Text.Pandoc.Shared ( escapeURI, removeFormatting, camelCaseToHyphenated
, trimr, normalize, substitute )
import Text.Pandoc.Writers.Shared ( defField, metaToJSON )
import Text.Pandoc.Templates ( renderTemplate' )
import Data.List ( intersect, intercalate, isPrefixOf )
import Data.List ( intersect, intercalate, isPrefixOf, transpose )
import Data.Default (Default(..))
import Network.URI ( isURI )
import Control.Monad ( zipWithM )
@ -181,20 +181,32 @@ blockToDokuWiki opts (BlockQuote blocks) = do
then return $ "> " ++ contents
else return $ "<HTML><blockquote>\n" ++ contents ++ "</blockquote></HTML>"
blockToDokuWiki opts (Table capt aligns _ headers rows') = do
blockToDokuWiki opts (Table capt aligns _ headers rows) = do
captionDoc <- if null capt
then return ""
else do
c <- inlineListToDokuWiki opts capt
return $ "" ++ c ++ "\n"
head' <- if all null headers
then return ""
else do
hs <- tableHeaderToDokuWiki opts aligns headers
return $ hs ++ "\n"
body' <- mapM (tableRowToDokuWiki opts aligns) rows'
return $ captionDoc ++ head' ++
unlines body'
headers' <- if all null headers
then return []
else zipWithM (tableItemToDokuWiki opts) aligns headers
rows' <- mapM (zipWithM (tableItemToDokuWiki opts) aligns) rows
let widths = map (maximum . map length) $ transpose (headers':rows')
let padTo (width, al) s =
case (width - length s) of
x | x > 0 ->
if al == AlignLeft || al == AlignDefault
then s ++ replicate x ' '
else if al == AlignRight
then replicate x ' ' ++ s
else replicate (x `div` 2) ' ' ++
s ++ replicate (x - x `div` 2) ' '
| otherwise -> s
let renderRow sep cells = sep ++
intercalate sep (zipWith padTo (zip widths aligns) cells) ++ sep
return $ captionDoc ++
(if null headers' then "" else renderRow "^" headers' ++ "\n") ++
unlines (map (renderRow "|") rows')
blockToDokuWiki opts x@(BulletList items) = do
oldUseTags <- stUseTags <$> ask
@ -357,32 +369,10 @@ backSlashLineBreaks cs = reverse $ g $ reverse $ concatMap f cs
-- Auxiliary functions for tables:
-- TODO Eliminate copy-and-pasted code in tableHeaderToDokuWiki and tableRowToDokuWiki
tableHeaderToDokuWiki :: WriterOptions
-> [Alignment]
-> [[Block]]
-> DokuWiki String
tableHeaderToDokuWiki opts aligns cols' = do
cols'' <- zipWithM
(tableItemToDokuWiki opts)
aligns cols'
return $ "^ " ++ joinHeaders cols'' ++ " ^"
tableRowToDokuWiki :: WriterOptions
-> [Alignment]
-> [[Block]]
-> DokuWiki String
tableRowToDokuWiki opts alignStrings cols' = do
cols'' <- zipWithM
(tableItemToDokuWiki opts)
alignStrings cols'
return $ "| " ++ "" ++ joinColumns cols'' ++ " |"
tableItemToDokuWiki :: WriterOptions
-> Alignment
-> [Block]
-> DokuWiki String
-- TODO Fix celltype and align' defined but not used
tableItemToDokuWiki opts align' item = do
let mkcell x = (if align' == AlignRight || align' == AlignCenter
then " "
@ -394,14 +384,6 @@ tableItemToDokuWiki opts align' item = do
blockListToDokuWiki opts item
return $ mkcell contents
-- | Concatenates columns together.
joinColumns :: [String] -> String
joinColumns = intercalate " | "
-- | Concatenates headers together.
joinHeaders :: [String] -> String
joinHeaders = intercalate " ^ "
-- | Convert list of Pandoc block elements to DokuWiki.
blockListToDokuWiki :: WriterOptions -- ^ Options
-> [Block] -- ^ List of block elements

6
tests/dokuwiki_multiblock_table.dokuwiki
View file

@ -1,4 +1,4 @@
Sample grid table.
^ Fruit ^ Price ^ Advantages ^
| Bananas | $1.34 | built-in wrapper\\ \\ potassium |
| Oranges | $2.10 | * cures scurvy\\ * tasty |
^Fruit ^Price^Advantages ^
|Bananas|$1.34|built-in wrapper\\ \\ potassium|
|Oranges|$2.10|* cures scurvy\\ * tasty |

46
tests/tables.dokuwiki
View file

@ -1,47 +1,47 @@
Simple table with caption:
Demonstration of simple table syntax.
^ Right ^ Left ^ Center ^ Default ^
| 12 | 12 | 12 | 12 |
| 123 | 123 | 123 | 123 |
| 1 | 1 | 1 | 1 |
^ Right^Left ^ Center ^Default^
| 12|12 | 12 |12 |
| 123|123 | 123 |123 |
| 1|1 | 1 |1 |
Simple table without caption:
^ Right ^ Left ^ Center ^ Default ^
| 12 | 12 | 12 | 12 |
| 123 | 123 | 123 | 123 |
| 1 | 1 | 1 | 1 |
^ Right^Left ^ Center ^Default^
| 12|12 | 12 |12 |
| 123|123 | 123 |123 |
| 1|1 | 1 |1 |
Simple table indented two spaces:
Demonstration of simple table syntax.
^ Right ^ Left ^ Center ^ Default ^
| 12 | 12 | 12 | 12 |
| 123 | 123 | 123 | 123 |
| 1 | 1 | 1 | 1 |
^ Right^Left ^ Center ^Default^
| 12|12 | 12 |12 |
| 123|123 | 123 |123 |
| 1|1 | 1 |1 |
Multiline table with caption:
Here's the caption. It may span multiple lines.
^ Centered Header ^ Left Aligned ^ Right 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. |
^ Centered Header ^Left Aligned ^ Right 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. |
Multiline table without caption:
^ Centered Header ^ Left Aligned ^ Right 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. |
^ Centered Header ^Left Aligned ^ Right 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 without column headers:
| 12 | 12 | 12 | 12 |
| 123 | 123 | 123 | 123 |
| 1 | 1 | 1 | 1 |
| 12|12 | 12 | 12|
| 123|123 | 123 | 123|
| 1|1 | 1 | 1|
Multiline table without column headers:
| 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. |
| 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.|