aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--MANUAL.txt10
m---------data/templates10
-rw-r--r--pandoc.cabal6
-rw-r--r--src/Text/Pandoc.hs9
-rw-r--r--src/Text/Pandoc/Options.hs2
-rw-r--r--src/Text/Pandoc/Templates.hs15
-rw-r--r--src/Text/Pandoc/Writers/Docbook.hs62
-rw-r--r--tests/Tests/Old.hs2
-rw-r--r--tests/Tests/Writers/Docbook.hs2
-rw-r--r--tests/tables.docbook4 (renamed from tests/tables.docbook)0
-rw-r--r--tests/writer.docbook4 (renamed from tests/writer.docbook)0
11 files changed, 68 insertions, 50 deletions
diff --git a/MANUAL.txt b/MANUAL.txt
index 91f4bacc0..5d14773a5 100644
--- a/MANUAL.txt
+++ b/MANUAL.txt
@@ -278,9 +278,9 @@ General options
`man` (groff man), `mediawiki` (MediaWiki markup),
`dokuwiki` (DokuWiki markup), `zimwiki` (ZimWiki markup),
`textile` (Textile), `org` (Emacs Org mode),
- `texinfo` (GNU Texinfo), `opml` (OPML), `docbook` (DocBook 4),
- `docbook5` (DocBook 5), `opendocument` (OpenDocument), `odt`
- (OpenOffice text document), `docx` (Word docx), `haddock`
+ `texinfo` (GNU Texinfo), `opml` (OPML), `docbook` or `docbook4`
+ (DocBook 4), `docbook5` (DocBook 5), `opendocument` (OpenDocument),
+ `odt` (OpenOffice text document), `docx` (Word docx), `haddock`
(Haddock markup), `rtf` (rich text format), `epub` or `epub2` (EPUB v2
book), `epub3` (EPUB v3), `fb2` (FictionBook2 e-book),
`asciidoc` (AsciiDoc), `icml` (InDesign ICML), `tei` (TEI
@@ -569,7 +569,7 @@ General writer options
: Include an automatically generated table of contents (or, in
the case of `latex`, `context`, `docx`, and `rst`, an instruction to create
one) in the output document. This option has no effect on `man`,
- `docbook`, `docbook5`, `slidy`, `slideous`, `s5`, or `odt` output.
+ `docbook4`, `docbook5`, `slidy`, `slideous`, `s5`, or `odt` output.
`--toc-depth=`*NUMBER*
@@ -947,7 +947,7 @@ Math rendering in HTML
`--mathml`[`=`*URL*]
-: Convert TeX math to [MathML] (in `docbook`, `docbook5`,
+: Convert TeX math to [MathML] (in `docbook4`, `docbook5`,
`html4` and `html5`). In standalone HTML output, a small
JavaScript (or a link to such a script if a *URL* is
supplied) will be inserted that allows the MathML to be
diff --git a/data/templates b/data/templates
-Subproject 335360e40c5cd395b33954906144c834783b41f
+Subproject c4ba8bab6248f8999e520547f1c45f10de85db9
diff --git a/pandoc.cabal b/pandoc.cabal
index 341ab5a12..194332619 100644
--- a/pandoc.cabal
+++ b/pandoc.cabal
@@ -38,7 +38,7 @@ Data-Files:
-- templates
data/templates/default.html4
data/templates/default.html5
- data/templates/default.docbook
+ data/templates/default.docbook4
data/templates/default.docbook5
data/templates/default.tei
data/templates/default.beamer
@@ -145,7 +145,7 @@ Extra-Source-Files:
tests/s5-fragment.html
tests/s5-inserts.html
tests/tables.context
- tests/tables.docbook
+ tests/tables.docbook4
tests/tables.docbook5
tests/tables.dokuwiki
tests/tables.zimwiki
@@ -171,7 +171,7 @@ Extra-Source-Files:
tests/testsuite.txt
tests/writer.latex
tests/writer.context
- tests/writer.docbook
+ tests/writer.docbook4
tests/writer.docbook5
tests/writer.html4
tests/writer.html5
diff --git a/src/Text/Pandoc.hs b/src/Text/Pandoc.hs
index 449cab120..ea625ffa1 100644
--- a/src/Text/Pandoc.hs
+++ b/src/Text/Pandoc.hs
@@ -104,7 +104,8 @@ module Text.Pandoc
, writeHtml5
, writeHtml5String
, writeICML
- , writeDocbook
+ , writeDocbook4
+ , writeDocbook5
, writeOPML
, writeOpenDocument
, writeMan
@@ -298,9 +299,9 @@ writers = [
writeHtml5String o{ writerSlideVariant = DZSlides })
,("revealjs" , StringWriter $ \o ->
writeHtml5String o{ writerSlideVariant = RevealJsSlides })
- ,("docbook" , StringWriter writeDocbook)
- ,("docbook5" , StringWriter $ \o ->
- writeDocbook o{ writerDocbook5 = True })
+ ,("docbook" , StringWriter writeDocbook5)
+ ,("docbook4" , StringWriter writeDocbook4)
+ ,("docbook5" , StringWriter writeDocbook5)
,("opml" , StringWriter writeOPML)
,("opendocument" , StringWriter writeOpenDocument)
,("latex" , StringWriter writeLaTeX)
diff --git a/src/Text/Pandoc/Options.hs b/src/Text/Pandoc/Options.hs
index 6cb2d883a..39fee298d 100644
--- a/src/Text/Pandoc/Options.hs
+++ b/src/Text/Pandoc/Options.hs
@@ -167,7 +167,6 @@ data WriterOptions = WriterOptions
, writerSourceURL :: Maybe String -- ^ Absolute URL + directory of 1st source file
, writerUserDataDir :: Maybe FilePath -- ^ Path of user data directory
, writerCiteMethod :: CiteMethod -- ^ How to print cites
- , writerDocbook5 :: Bool -- ^ Produce DocBook5
, writerHtmlQTags :: Bool -- ^ Use @<q>@ tags for quotes in HTML
, writerBeamer :: Bool -- ^ Produce beamer LaTeX slide show
, writerSlideLevel :: Maybe Int -- ^ Force header level of slides
@@ -208,7 +207,6 @@ instance Default WriterOptions where
, writerSourceURL = Nothing
, writerUserDataDir = Nothing
, writerCiteMethod = Citeproc
- , writerDocbook5 = False
, writerHtmlQTags = False
, writerBeamer = False
, writerSlideLevel = Nothing
diff --git a/src/Text/Pandoc/Templates.hs b/src/Text/Pandoc/Templates.hs
index 38d956f1f..ddb073409 100644
--- a/src/Text/Pandoc/Templates.hs
+++ b/src/Text/Pandoc/Templates.hs
@@ -55,13 +55,14 @@ getDefaultTemplate :: (Maybe FilePath) -- ^ User data directory to search first
getDefaultTemplate user writer = do
let format = takeWhile (`notElem` ("+-" :: String)) writer -- strip off extensions
case format of
- "native" -> return $ Right ""
- "json" -> return $ Right ""
- "docx" -> return $ Right ""
- "fb2" -> return $ Right ""
- "odt" -> getDefaultTemplate user "opendocument"
- "html" -> getDefaultTemplate user "html5"
- "epub" -> getDefaultTemplate user "epub2"
+ "native" -> return $ Right ""
+ "json" -> return $ Right ""
+ "docx" -> return $ Right ""
+ "fb2" -> return $ Right ""
+ "odt" -> getDefaultTemplate user "opendocument"
+ "html" -> getDefaultTemplate user "html5"
+ "docbook" -> getDefaultTemplate user "docbook5"
+ "epub" -> getDefaultTemplate user "epub2"
"markdown_strict" -> getDefaultTemplate user "markdown"
"multimarkdown" -> getDefaultTemplate user "markdown"
"markdown_github" -> getDefaultTemplate user "markdown"
diff --git a/src/Text/Pandoc/Writers/Docbook.hs b/src/Text/Pandoc/Writers/Docbook.hs
index 32695e128..53618d173 100644
--- a/src/Text/Pandoc/Writers/Docbook.hs
+++ b/src/Text/Pandoc/Writers/Docbook.hs
@@ -28,7 +28,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Conversion of 'Pandoc' documents to Docbook XML.
-}
-module Text.Pandoc.Writers.Docbook ( writeDocbook) where
+module Text.Pandoc.Writers.Docbook ( writeDocbook4, writeDocbook5 ) where
import Text.Pandoc.Definition
import Text.Pandoc.XML
import Text.Pandoc.Shared
@@ -48,9 +48,15 @@ import Text.TeXMath
import qualified Text.XML.Light as Xml
import Data.Generics (everywhere, mkT)
import Text.Pandoc.Class (PandocMonad)
+import Control.Monad.Reader
+
+data DocBookVersion = DocBook4 | DocBook5
+ deriving (Eq, Show)
+
+type DB = ReaderT DocBookVersion
-- | Convert list of authors to a docbook <author> section
-authorToDocbook :: PandocMonad m => WriterOptions -> [Inline] -> m B.Inlines
+authorToDocbook :: PandocMonad m => WriterOptions -> [Inline] -> DB m B.Inlines
authorToDocbook opts name' = do
name <- render Nothing <$> inlinesToDocbook opts name'
let colwidth = if writerWrapText opts == WrapAuto
@@ -73,8 +79,16 @@ authorToDocbook opts name' = do
in inTagsSimple "firstname" (text $ escapeStringForXML firstname) $$
inTagsSimple "surname" (text $ escapeStringForXML lastname)
+writeDocbook4 :: PandocMonad m => WriterOptions -> Pandoc -> m String
+writeDocbook4 opts d =
+ runReaderT (writeDocbook opts d) DocBook4
+
+writeDocbook5 :: PandocMonad m => WriterOptions -> Pandoc -> m String
+writeDocbook5 opts d =
+ runReaderT (writeDocbook opts d) DocBook5
+
-- | Convert Pandoc document to string in Docbook format.
-writeDocbook :: PandocMonad m => WriterOptions -> Pandoc -> m String
+writeDocbook :: PandocMonad m => WriterOptions -> Pandoc -> DB m String
writeDocbook opts (Pandoc meta blocks) = do
let elements = hierarchicalize blocks
let colwidth = if writerWrapText opts == WrapAuto
@@ -100,7 +114,7 @@ writeDocbook opts (Pandoc meta blocks) = do
hierarchicalize))
(fmap (render colwidth) . inlinesToDocbook opts')
meta'
- main <- (render' . vcat) <$> mapM (elementToDocbook opts' startLvl) elements
+ main <- (render' . vcat) <$> (mapM (elementToDocbook opts' startLvl) elements)
let context = defField "body" main
$ defField "mathml" (case writerHTMLMathMethod opts of
MathML _ -> True
@@ -111,9 +125,10 @@ writeDocbook opts (Pandoc meta blocks) = do
Just tpl -> renderTemplate' tpl context
-- | Convert an Element to Docbook.
-elementToDocbook :: PandocMonad m => WriterOptions -> Int -> Element -> m Doc
+elementToDocbook :: PandocMonad m => WriterOptions -> Int -> Element -> DB m Doc
elementToDocbook opts _ (Blk block) = blockToDocbook opts block
elementToDocbook opts lvl (Sec _ _num (id',_,_) title elements) = do
+ version <- ask
-- Docbook doesn't allow sections with no content, so insert some if needed
let elements' = if null elements
then [Blk (Para [])]
@@ -121,15 +136,15 @@ elementToDocbook opts lvl (Sec _ _num (id',_,_) title elements) = do
tag = case lvl of
-1 -> "part"
0 -> "chapter"
- n | n >= 1 && n <= 5 -> if writerDocbook5 opts
+ n | n >= 1 && n <= 5 -> if version == DocBook5
then "section"
else "sect" ++ show n
_ -> "simplesect"
- idName = if writerDocbook5 opts
+ idName = if version == DocBook5
then "xml:id"
else "id"
idAttr = [(idName, writerIdentifierPrefix opts ++ id') | not (null id')]
- nsAttr = if writerDocbook5 opts && lvl == 0 then [("xmlns", "http://docbook.org/ns/docbook"),("xmlns:xlink", "http://www.w3.org/1999/xlink")]
+ nsAttr = if version == DocBook5 && lvl == 0 then [("xmlns", "http://docbook.org/ns/docbook"),("xmlns:xlink", "http://www.w3.org/1999/xlink")]
else []
attribs = nsAttr ++ idAttr
contents <- mapM (elementToDocbook opts (lvl + 1)) elements'
@@ -138,7 +153,7 @@ elementToDocbook opts lvl (Sec _ _num (id',_,_) title elements) = do
inTagsSimple "title" title' $$ vcat contents
-- | Convert a list of Pandoc blocks to Docbook.
-blocksToDocbook :: PandocMonad m => WriterOptions -> [Block] -> m Doc
+blocksToDocbook :: PandocMonad m => WriterOptions -> [Block] -> DB m Doc
blocksToDocbook opts = fmap vcat . mapM (blockToDocbook opts)
-- | Auxiliary function to convert Plain block to Para.
@@ -149,13 +164,13 @@ plainToPara x = x
-- | Convert a list of pairs of terms and definitions into a list of
-- Docbook varlistentrys.
deflistItemsToDocbook :: PandocMonad m
- => WriterOptions -> [([Inline],[[Block]])] -> m Doc
+ => WriterOptions -> [([Inline],[[Block]])] -> DB m Doc
deflistItemsToDocbook opts items =
vcat <$> mapM (\(term, defs) -> deflistItemToDocbook opts term defs) items
-- | Convert a term and a list of blocks into a Docbook varlistentry.
deflistItemToDocbook :: PandocMonad m
- => WriterOptions -> [Inline] -> [[Block]] -> m Doc
+ => WriterOptions -> [Inline] -> [[Block]] -> DB m Doc
deflistItemToDocbook opts term defs = do
term' <- inlinesToDocbook opts term
def' <- blocksToDocbook opts $ concatMap (map plainToPara) defs
@@ -164,11 +179,11 @@ deflistItemToDocbook opts term defs = do
inTagsIndented "listitem" def'
-- | Convert a list of lists of blocks to a list of Docbook list items.
-listItemsToDocbook :: PandocMonad m => WriterOptions -> [[Block]] -> m Doc
+listItemsToDocbook :: PandocMonad m => WriterOptions -> [[Block]] -> DB m Doc
listItemsToDocbook opts items = vcat <$> mapM (listItemToDocbook opts) items
-- | Convert a list of blocks into a Docbook list item.
-listItemToDocbook :: PandocMonad m => WriterOptions -> [Block] -> m Doc
+listItemToDocbook :: PandocMonad m => WriterOptions -> [Block] -> DB m Doc
listItemToDocbook opts item =
inTagsIndented "listitem" <$> blocksToDocbook opts (map plainToPara item)
@@ -182,7 +197,7 @@ imageToDocbook _ attr src = selfClosingTag "imagedata" $
Nothing -> []
-- | Convert a Pandoc block element to Docbook.
-blockToDocbook :: PandocMonad m => WriterOptions -> Block -> m Doc
+blockToDocbook :: PandocMonad m => WriterOptions -> Block -> DB m Doc
blockToDocbook _ Null = return empty
-- Add ids to paragraphs in divs with ids - this is needed for
-- pandoc-citeproc to get link anchors in bibliographies:
@@ -260,9 +275,11 @@ blockToDocbook opts (OrderedList (start, numstyle, _) (first:rest)) = do
blockToDocbook opts (DefinitionList lst) = do
let attribs = [("spacing", "compact") | isTightList $ concatMap snd lst]
inTags True "variablelist" attribs <$> deflistItemsToDocbook opts lst
-blockToDocbook opts (RawBlock f str)
+blockToDocbook _ (RawBlock f str)
| f == "docbook" = return $ text str -- raw XML block
- | f == "html" = if writerDocbook5 opts
+ | f == "html" = do
+ version <- ask
+ if version == DocBook5
then return empty -- No html in Docbook5
else return $ text str -- allow html for backwards compatibility
| otherwise = return empty
@@ -306,23 +323,23 @@ alignmentToString alignment = case alignment of
tableRowToDocbook :: PandocMonad m
=> WriterOptions
-> [[Block]]
- -> m Doc
+ -> DB m Doc
tableRowToDocbook opts cols =
(inTagsIndented "row" . vcat) <$> mapM (tableItemToDocbook opts) cols
tableItemToDocbook :: PandocMonad m
=> WriterOptions
-> [Block]
- -> m Doc
+ -> DB m Doc
tableItemToDocbook opts item =
(inTags True "entry" [] . vcat) <$> mapM (blockToDocbook opts) item
-- | Convert a list of inline elements to Docbook.
-inlinesToDocbook :: PandocMonad m => WriterOptions -> [Inline] -> m Doc
+inlinesToDocbook :: PandocMonad m => WriterOptions -> [Inline] -> DB m Doc
inlinesToDocbook opts lst = hcat <$> mapM (inlineToDocbook opts) lst
-- | Convert an inline element to Docbook.
-inlineToDocbook :: PandocMonad m => WriterOptions -> Inline -> m Doc
+inlineToDocbook :: PandocMonad m => WriterOptions -> Inline -> DB m Doc
inlineToDocbook _ (Str str) = return $ text $ escapeStringForXML str
inlineToDocbook opts (Emph lst) =
inTagsSimple "emphasis" <$> inlinesToDocbook opts lst
@@ -385,10 +402,11 @@ inlineToDocbook opts (Link attr txt (src, _))
_ -> do contents <- inlinesToDocbook opts txt
return $ contents <+>
char '(' <> emailLink <> char ')'
- | otherwise =
+ | otherwise = do
+ version <- ask
(if isPrefixOf "#" src
then inTags False "link" $ ("linkend", drop 1 src) : idAndRole attr
- else if writerDocbook5 opts
+ else if version == DocBook5
then inTags False "link" $ ("xlink:href", src) : idAndRole attr
else inTags False "ulink" $ ("url", src) : idAndRole attr )
<$> inlinesToDocbook opts txt
diff --git a/tests/Tests/Old.hs b/tests/Tests/Old.hs
index a46ac2260..f22636747 100644
--- a/tests/Tests/Old.hs
+++ b/tests/Tests/Old.hs
@@ -99,7 +99,7 @@ tests = [ testGroup "markdown"
"textile-reader.textile" "textile-reader.native"
]
, testGroup "docbook"
- [ testGroup "writer" $ writerTests "docbook"
+ [ testGroup "writer" $ writerTests "docbook4"
, test "reader" ["-r", "docbook", "-w", "native", "-s"]
"docbook-reader.docbook" "docbook-reader.native"
, test "reader" ["-r", "docbook", "-w", "native", "-s"]
diff --git a/tests/Tests/Writers/Docbook.hs b/tests/Tests/Writers/Docbook.hs
index adf6e9050..f34f2495c 100644
--- a/tests/Tests/Writers/Docbook.hs
+++ b/tests/Tests/Writers/Docbook.hs
@@ -11,7 +11,7 @@ docbook :: (ToPandoc a) => a -> String
docbook = docbookWithOpts def{ writerWrapText = WrapNone }
docbookWithOpts :: ToPandoc a => WriterOptions -> a -> String
-docbookWithOpts opts = purely (writeDocbook opts) . toPandoc
+docbookWithOpts opts = purely (writeDocbook4 opts) . toPandoc
{-
"my test" =: X =?> Y
diff --git a/tests/tables.docbook b/tests/tables.docbook4
index f86b1c390..f86b1c390 100644
--- a/tests/tables.docbook
+++ b/tests/tables.docbook4
diff --git a/tests/writer.docbook b/tests/writer.docbook4
index eee19cdd9..eee19cdd9 100644
--- a/tests/writer.docbook
+++ b/tests/writer.docbook4
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-12 08:45:27 +0000