From a6b469c02b3c21cfc1b5169ea3e75b7388f55691 Mon Sep 17 00:00:00 2001
From: Hubert Plociniczak <hubert.plociniczak@gmail.com>
Date: Fri, 11 Nov 2016 13:09:49 +0100
Subject: Adds support for pagebreaks (when it makes sense)

Update all writers to take into account page breaks.
A straightforwad, far from complete, implementation of page
breaks in selected writers.
Readers will have to follow in the future as well.
---
 src/Text/Pandoc/Writers/AsciiDoc.hs   | 3 ++-
 src/Text/Pandoc/Writers/CommonMark.hs | 1 +
 src/Text/Pandoc/Writers/ConTeXt.hs    | 1 +
 src/Text/Pandoc/Writers/Custom.hs     | 2 ++
 src/Text/Pandoc/Writers/Docbook.hs    | 3 +++
 src/Text/Pandoc/Writers/Docx.hs       | 9 ++++++++-
 src/Text/Pandoc/Writers/DokuWiki.hs   | 4 +++-
 src/Text/Pandoc/Writers/FB2.hs        | 2 ++
 src/Text/Pandoc/Writers/HTML.hs       | 1 +
 src/Text/Pandoc/Writers/Haddock.hs    | 3 ++-
 src/Text/Pandoc/Writers/ICML.hs       | 1 +
 src/Text/Pandoc/Writers/LaTeX.hs      | 1 +
 src/Text/Pandoc/Writers/Man.hs        | 3 ++-
 src/Text/Pandoc/Writers/Markdown.hs   | 3 ++-
 src/Text/Pandoc/Writers/MediaWiki.hs  | 4 +++-
 src/Text/Pandoc/Writers/Org.hs        | 3 ++-
 src/Text/Pandoc/Writers/RST.hs        | 1 +
 src/Text/Pandoc/Writers/RTF.hs        | 3 ++-
 src/Text/Pandoc/Writers/TEI.hs        | 1 +
 src/Text/Pandoc/Writers/Texinfo.hs    | 2 ++
 src/Text/Pandoc/Writers/Textile.hs    | 4 +++-
 src/Text/Pandoc/Writers/ZimWiki.hs    | 4 +++-
 22 files changed, 48 insertions(+), 11 deletions(-)

(limited to 'src/Text')

diff --git a/src/Text/Pandoc/Writers/AsciiDoc.hs b/src/Text/Pandoc/Writers/AsciiDoc.hs
index e9d3dccf1..88fab171f 100644
--- a/src/Text/Pandoc/Writers/AsciiDoc.hs
+++ b/src/Text/Pandoc/Writers/AsciiDoc.hs
@@ -411,7 +411,8 @@ inlineToAsciiDoc _ (Math DisplayMath str) =
 inlineToAsciiDoc _ (RawInline f s)
   | f == "asciidoc" = return $ text s
   | otherwise       = return empty
-inlineToAsciiDoc _ (LineBreak) = return $ " +" <> cr
+inlineToAsciiDoc _ LineBreak = return $ " +" <> cr
+inlineToAsciiDoc _ PageBreak = return empty
 inlineToAsciiDoc _ Space = return space
 inlineToAsciiDoc opts SoftBreak =
   case writerWrapText opts of
diff --git a/src/Text/Pandoc/Writers/CommonMark.hs b/src/Text/Pandoc/Writers/CommonMark.hs
index 88a92eb47..e0591de83 100644
--- a/src/Text/Pandoc/Writers/CommonMark.hs
+++ b/src/Text/Pandoc/Writers/CommonMark.hs
@@ -139,6 +139,7 @@ inlineToNodes :: Inline -> [Node] -> [Node]
 inlineToNodes (Str s) = (node (TEXT (T.pack s)) [] :)
 inlineToNodes Space   = (node (TEXT (T.pack " ")) [] :)
 inlineToNodes LineBreak = (node LINEBREAK [] :)
+inlineToNodes PageBreak = id
 inlineToNodes SoftBreak = (node SOFTBREAK [] :)
 inlineToNodes (Emph xs) = (node EMPH (inlinesToNodes xs) :)
 inlineToNodes (Strong xs) = (node STRONG (inlinesToNodes xs) :)
diff --git a/src/Text/Pandoc/Writers/ConTeXt.hs b/src/Text/Pandoc/Writers/ConTeXt.hs
index c663c75ce..ee2cc3f34 100644
--- a/src/Text/Pandoc/Writers/ConTeXt.hs
+++ b/src/Text/Pandoc/Writers/ConTeXt.hs
@@ -346,6 +346,7 @@ inlineToConTeXt SoftBreak = do
                WrapAuto     -> space
                WrapNone     -> space
                WrapPreserve -> cr
+inlineToConTeXt PageBreak = return empty
 inlineToConTeXt Space = return space
 -- Handle HTML-like internal document references to sections
 inlineToConTeXt (Link _ txt (('#' : ref), _)) = do
diff --git a/src/Text/Pandoc/Writers/Custom.hs b/src/Text/Pandoc/Writers/Custom.hs
index cf641dcd6..371dd21c3 100644
--- a/src/Text/Pandoc/Writers/Custom.hs
+++ b/src/Text/Pandoc/Writers/Custom.hs
@@ -310,6 +310,8 @@ inlineToCustom lua (RawInline format str) =
 
 inlineToCustom lua (LineBreak) = callfunc lua "LineBreak"
 
+inlineToCustom lua (PageBreak) = callfunc lua "PageBreak"
+
 inlineToCustom lua (Link attr txt (src,tit)) =
   callfunc lua "Link" txt src tit (attrToMap attr)
 
diff --git a/src/Text/Pandoc/Writers/Docbook.hs b/src/Text/Pandoc/Writers/Docbook.hs
index 44f96d700..5c03d449d 100644
--- a/src/Text/Pandoc/Writers/Docbook.hs
+++ b/src/Text/Pandoc/Writers/Docbook.hs
@@ -356,6 +356,9 @@ inlineToDocbook opts (Math t str)
 inlineToDocbook _ (RawInline f x) | f == "html" || f == "docbook" = text x
                                   | otherwise                     = empty
 inlineToDocbook _ LineBreak = text "\n"
+-- currently ignore, would require the option to add custom
+-- styles to the document
+inlineToDocbook _ PageBreak = empty
 inlineToDocbook _ Space = space
 -- because we use \n for LineBreak, we can't do soft breaks:
 inlineToDocbook _ SoftBreak = space
diff --git a/src/Text/Pandoc/Writers/Docx.hs b/src/Text/Pandoc/Writers/Docx.hs
index 3fc5d22a2..d425bbbca 100644
--- a/src/Text/Pandoc/Writers/Docx.hs
+++ b/src/Text/Pandoc/Writers/Docx.hs
@@ -1100,6 +1100,7 @@ inlineToOpenXML' opts (Strikeout lst) =
   withTextProp (mknode "w:strike" [] ())
   $ inlinesToOpenXML opts lst
 inlineToOpenXML' _ LineBreak = return [br]
+inlineToOpenXML' _ PageBreak = return [pageBreak]
 inlineToOpenXML' _ (RawInline f str)
   | f == Format "openxml" = return [ x | Elem x <- parseXML str ]
   | otherwise            = return []
@@ -1247,7 +1248,13 @@ inlineToOpenXML' opts (Image attr alt (src, title)) = do
                return [imgElt]
 
 br :: Element
-br = mknode "w:r" [] [mknode "w:br" [("w:type","textWrapping")] () ]
+br = breakElement "textWrapping"
+
+pageBreak :: Element
+pageBreak = breakElement "page"
+
+breakElement :: String -> Element
+breakElement kind = mknode "w:r" [] [mknode "w:br" [("w:type",kind)] () ]
 
 -- Word will insert these footnotes into the settings.xml file
 -- (whether or not they're visible in the document). If they're in the
diff --git a/src/Text/Pandoc/Writers/DokuWiki.hs b/src/Text/Pandoc/Writers/DokuWiki.hs
index 7459f1b42..c90dc9078 100644
--- a/src/Text/Pandoc/Writers/DokuWiki.hs
+++ b/src/Text/Pandoc/Writers/DokuWiki.hs
@@ -465,7 +465,9 @@ inlineToDokuWiki _ (RawInline f str)
   | f == Format "html"     = return $ "<html>" ++ str ++ "</html>"
   | otherwise              = return ""
 
-inlineToDokuWiki _ (LineBreak) = return "\\\\\n"
+inlineToDokuWiki _ LineBreak = return "\\\\\n"
+
+inlineToDokuWiki _ PageBreak = return mempty
 
 inlineToDokuWiki opts SoftBreak =
   case writerWrapText opts of
diff --git a/src/Text/Pandoc/Writers/FB2.hs b/src/Text/Pandoc/Writers/FB2.hs
index 5538ca061..8c4817ac6 100644
--- a/src/Text/Pandoc/Writers/FB2.hs
+++ b/src/Text/Pandoc/Writers/FB2.hs
@@ -443,6 +443,7 @@ toXml (Code _ s) = return [el "code" s]
 toXml Space = return [txt " "]
 toXml SoftBreak = return [txt " "]
 toXml LineBreak = return [el "empty-line" ()]
+toXml PageBreak = return []
 toXml (Math _ formula) = insertMath InlineImage formula
 toXml (RawInline _ _) = return []  -- raw TeX and raw HTML are suppressed
 toXml (Link _ text (url,ttl)) = do
@@ -574,6 +575,7 @@ plain (Code _ s) = s
 plain Space = " "
 plain SoftBreak = " "
 plain LineBreak = "\n"
+plain PageBreak = "\n"
 plain (Math _ s) = s
 plain (RawInline _ s) = s
 plain (Link _ text (url,_)) = concat (map plain text ++ [" <", url, ">"])
diff --git a/src/Text/Pandoc/Writers/HTML.hs b/src/Text/Pandoc/Writers/HTML.hs
index 3c8c264d2..e0b0234fb 100644
--- a/src/Text/Pandoc/Writers/HTML.hs
+++ b/src/Text/Pandoc/Writers/HTML.hs
@@ -705,6 +705,7 @@ inlineToHtml opts inline =
                                        WrapPreserve -> preEscapedString "\n"
     (LineBreak)      -> return $ (if writerHtml5 opts then H5.br else H.br)
                                  <> strToHtml "\n"
+    (PageBreak)      -> return mempty
     (Span (id',classes,kvs) ils)
                      -> inlineListToHtml opts ils >>=
                            return . addAttrs opts attr' . H.span
diff --git a/src/Text/Pandoc/Writers/Haddock.hs b/src/Text/Pandoc/Writers/Haddock.hs
index 29fdafe15..4e93cc4e4 100644
--- a/src/Text/Pandoc/Writers/Haddock.hs
+++ b/src/Text/Pandoc/Writers/Haddock.hs
@@ -326,7 +326,8 @@ inlineToHaddock _ (RawInline f str)
   | f == "haddock" = return $ text str
   | otherwise = return empty
 -- no line break in haddock (see above on CodeBlock)
-inlineToHaddock _ (LineBreak) = return cr
+inlineToHaddock _ LineBreak = return cr
+inlineToHaddock _ PageBreak = return empty
 inlineToHaddock opts SoftBreak =
   case writerWrapText opts of
        WrapAuto     -> return space
diff --git a/src/Text/Pandoc/Writers/ICML.hs b/src/Text/Pandoc/Writers/ICML.hs
index 8f0d21cf5..e2c123fc2 100644
--- a/src/Text/Pandoc/Writers/ICML.hs
+++ b/src/Text/Pandoc/Writers/ICML.hs
@@ -432,6 +432,7 @@ inlineToICML opts style SoftBreak =
        WrapNone     -> charStyle style space
        WrapPreserve -> charStyle style cr
 inlineToICML _ style LineBreak = charStyle style $ text lineSeparator
+inlineToICML _ _ PageBreak = return empty
 inlineToICML opts style (Math mt str) =
   cat <$> mapM (inlineToICML opts style) (texMathToInlines mt str)
 inlineToICML _ _ (RawInline f str)
diff --git a/src/Text/Pandoc/Writers/LaTeX.hs b/src/Text/Pandoc/Writers/LaTeX.hs
index 88934eb44..50e99fe15 100644
--- a/src/Text/Pandoc/Writers/LaTeX.hs
+++ b/src/Text/Pandoc/Writers/LaTeX.hs
@@ -960,6 +960,7 @@ inlineToLaTeX SoftBreak = do
        WrapAuto     -> return space
        WrapNone     -> return space
        WrapPreserve -> return cr
+inlineToLaTeX PageBreak = return $ "\\clearpage{}"
 inlineToLaTeX Space = return space
 inlineToLaTeX (Link _ txt ('#':ident, _)) = do
   contents <- inlineListToLaTeX txt
diff --git a/src/Text/Pandoc/Writers/Man.hs b/src/Text/Pandoc/Writers/Man.hs
index 98b08b08b..304995ec8 100644
--- a/src/Text/Pandoc/Writers/Man.hs
+++ b/src/Text/Pandoc/Writers/Man.hs
@@ -342,8 +342,9 @@ inlineToMan opts (Math DisplayMath str) = do
 inlineToMan _ (RawInline f str)
   | f == Format "man" = return $ text str
   | otherwise         = return empty
-inlineToMan _ (LineBreak) = return $
+inlineToMan _ LineBreak = return $
   cr <> text ".PD 0" $$ text ".P" $$ text ".PD" <> cr
+inlineToMan _ PageBreak = return empty
 inlineToMan _ SoftBreak = return space
 inlineToMan _ Space = return space
 inlineToMan opts (Link _ txt (src, _)) = do
diff --git a/src/Text/Pandoc/Writers/Markdown.hs b/src/Text/Pandoc/Writers/Markdown.hs
index e3bb3eea0..f9c7c326e 100644
--- a/src/Text/Pandoc/Writers/Markdown.hs
+++ b/src/Text/Pandoc/Writers/Markdown.hs
@@ -345,7 +345,7 @@ notesAndRefs opts = do
         if | writerReferenceLocation opts == EndOfDocument -> empty
            | isEmpty notes' && isEmpty refs' -> empty
            | otherwise -> blankline
-  
+
   return $
     (if isEmpty notes' then empty else blankline <> notes') <>
     (if isEmpty refs' then empty else blankline <> refs') <>
@@ -1018,6 +1018,7 @@ inlineToMarkdown opts SoftBreak = do
                 WrapNone     -> space'
                 WrapAuto     -> space'
                 WrapPreserve -> cr
+inlineToMarkdown _ PageBreak = return empty
 inlineToMarkdown opts (Cite [] lst) = inlineListToMarkdown opts lst
 inlineToMarkdown opts (Cite (c:cs) lst)
   | not (isEnabled Ext_citations opts) = inlineListToMarkdown opts lst
diff --git a/src/Text/Pandoc/Writers/MediaWiki.hs b/src/Text/Pandoc/Writers/MediaWiki.hs
index 78d4651e7..95b649dd2 100644
--- a/src/Text/Pandoc/Writers/MediaWiki.hs
+++ b/src/Text/Pandoc/Writers/MediaWiki.hs
@@ -402,7 +402,9 @@ inlineToMediaWiki (RawInline f str)
   | f == Format "html"      = return str
   | otherwise               = return ""
 
-inlineToMediaWiki (LineBreak) = return "<br />\n"
+inlineToMediaWiki LineBreak = return "<br />\n"
+
+inlineToMediaWiki PageBreak = return mempty
 
 inlineToMediaWiki SoftBreak = do
   wrapText <- gets (writerWrapText . stOptions)
diff --git a/src/Text/Pandoc/Writers/Org.hs b/src/Text/Pandoc/Writers/Org.hs
index 4302459cc..330f24b0b 100644
--- a/src/Text/Pandoc/Writers/Org.hs
+++ b/src/Text/Pandoc/Writers/Org.hs
@@ -349,7 +349,8 @@ inlineToOrg (RawInline f@(Format f') str) =
   return $ if isRawFormat f
            then text str
            else "@@" <> text f' <> ":" <> text str <> "@@"
-inlineToOrg (LineBreak) = return (text "\\\\" <> cr)
+inlineToOrg LineBreak = return (text "\\\\" <> cr)
+inlineToOrg PageBreak = return empty
 inlineToOrg Space = return space
 inlineToOrg SoftBreak = do
   wrapText <- gets (writerWrapText . stOptions)
diff --git a/src/Text/Pandoc/Writers/RST.hs b/src/Text/Pandoc/Writers/RST.hs
index 064434483..c170889cc 100644
--- a/src/Text/Pandoc/Writers/RST.hs
+++ b/src/Text/Pandoc/Writers/RST.hs
@@ -461,6 +461,7 @@ inlineToRST SoftBreak = do
         WrapPreserve  -> return cr
         WrapAuto      -> return space
         WrapNone      -> return space
+inlineToRST PageBreak = return $ ".. pagebreak::"
 -- autolink
 inlineToRST (Link _ [Str str] (src, _))
   | isURI src &&
diff --git a/src/Text/Pandoc/Writers/RTF.hs b/src/Text/Pandoc/Writers/RTF.hs
index 8f942b4d0..6ca749a10 100644
--- a/src/Text/Pandoc/Writers/RTF.hs
+++ b/src/Text/Pandoc/Writers/RTF.hs
@@ -350,8 +350,9 @@ inlineToRTF (Cite _ lst) = inlineListToRTF lst
 inlineToRTF (RawInline f str)
   | f == Format "rtf" = str
   | otherwise         = ""
-inlineToRTF (LineBreak) = "\\line "
+inlineToRTF LineBreak = "\\line "
 inlineToRTF SoftBreak = " "
+inlineToRTF PageBreak = "\\page "
 inlineToRTF Space = " "
 inlineToRTF (Link _ text (src, _)) =
   "{\\field{\\*\\fldinst{HYPERLINK \"" ++ (codeStringToRTF src) ++
diff --git a/src/Text/Pandoc/Writers/TEI.hs b/src/Text/Pandoc/Writers/TEI.hs
index 9bd23ac3b..27a2819a0 100644
--- a/src/Text/Pandoc/Writers/TEI.hs
+++ b/src/Text/Pandoc/Writers/TEI.hs
@@ -284,6 +284,7 @@ inlineToTEI _ (Math t str) =
 inlineToTEI _ (RawInline f x) | f == "tei"     = text x
                               | otherwise      = empty
 inlineToTEI _ LineBreak = selfClosingTag "lb" []
+inlineToTEI _ PageBreak = selfClosingTag "pb" []
 inlineToTEI _ Space = space
 -- because we use \n for LineBreak, we can't do soft breaks:
 inlineToTEI _ SoftBreak = space
diff --git a/src/Text/Pandoc/Writers/Texinfo.hs b/src/Text/Pandoc/Writers/Texinfo.hs
index f2b9aa15f..993e6fbfd 100644
--- a/src/Text/Pandoc/Writers/Texinfo.hs
+++ b/src/Text/Pandoc/Writers/Texinfo.hs
@@ -437,6 +437,8 @@ inlineToTexinfo SoftBreak = do
       WrapPreserve -> return cr
 inlineToTexinfo Space = return space
 
+inlineToTexinfo PageBreak = return $ text "@page"
+
 inlineToTexinfo (Link _ txt (src@('#':_), _)) = do
   contents <- escapeCommas $ inlineListToTexinfo txt
   return $ text "@ref" <>
diff --git a/src/Text/Pandoc/Writers/Textile.hs b/src/Text/Pandoc/Writers/Textile.hs
index f73876fd2..4283e29cc 100644
--- a/src/Text/Pandoc/Writers/Textile.hs
+++ b/src/Text/Pandoc/Writers/Textile.hs
@@ -435,7 +435,9 @@ inlineToTextile opts (RawInline f str)
      isEnabled Ext_raw_tex opts                 = return str
   | otherwise                                   = return ""
 
-inlineToTextile _ (LineBreak) = return "\n"
+inlineToTextile _ LineBreak = return "\n"
+
+inlineToTextile _ PageBreak = return mempty
 
 inlineToTextile _ SoftBreak = return " "
 
diff --git a/src/Text/Pandoc/Writers/ZimWiki.hs b/src/Text/Pandoc/Writers/ZimWiki.hs
index 423928c8a..56a5d5455 100644
--- a/src/Text/Pandoc/Writers/ZimWiki.hs
+++ b/src/Text/Pandoc/Writers/ZimWiki.hs
@@ -317,7 +317,9 @@ inlineToZimWiki opts (RawInline f str)
   | f == Format "html"     = do cont <- indentFromHTML opts str; return cont
   | otherwise              = return ""
 
-inlineToZimWiki _ (LineBreak) = return "\n" -- was \\\\
+inlineToZimWiki _ LineBreak = return "\n" -- was \\\\
+
+inlineToZimWiki _ PageBreak = return mempty
 
 inlineToZimWiki opts SoftBreak =
   case writerWrapText opts of
-- 
cgit v1.2.3