pandoc-3.1.2: Conversion between markup formats
CopyrightCopyright (C) 2006-2023 John MacFarlane
LicenseGNU GPL, version 2 or above
MaintainerJohn MacFarlane <jgm@berkeley.edu>
Stabilityalpha
Portabilityportable
Safe HaskellSafe-Inferred
LanguageHaskell2010

Text.Pandoc.Writers

Description

This helper module exports all writers functions.

Synopsis

Writers: converting from Pandoc format

data Writer m Source #

Constructors

TextWriter (WriterOptions -> Pandoc -> m Text) 
ByteStringWriter (WriterOptions -> Pandoc -> m ByteString) 

writers :: PandocMonad m => [(Text, Writer m)] Source #

Association list of formats and writers.

writeAsciiDoc :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to AsciiDoc.

writeAsciiDoctor :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to AsciiDoctor compatible AsciiDoc.

writeBeamer :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to LaTeX Beamer.

writeBibTeX :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Write BibTeX based on the references metadata from a Pandoc document.

writeBibLaTeX :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Write BibLaTeX based on the references metadata from a Pandoc document.

writeChunkedHTML :: PandocMonad m => WriterOptions -> Pandoc -> m ByteString Source #

Splits document into HTML chunks, dividing them by section, and returns a zip archive of a folder of files.

writeCommonMark :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to Commonmark.

writeConTeXt :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to ConTeXt.

writeDZSlides :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc document to DZSlides HTML slide show.

writeDocx Source #

Arguments

:: PandocMonad m 
=> WriterOptions

Writer options

-> Pandoc

Document to convert

-> m ByteString 

writeDokuWiki :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to DokuWiki.

writeEPUB2 Source #

Arguments

:: PandocMonad m 
=> WriterOptions

Writer options

-> Pandoc

Document to convert

-> m ByteString 

Produce an EPUB2 file from a Pandoc document.

writeEPUB3 Source #

Arguments

:: PandocMonad m 
=> WriterOptions

Writer options

-> Pandoc

Document to convert

-> m ByteString 

Produce an EPUB3 file from a Pandoc document.

writeFB2 Source #

Arguments

:: PandocMonad m 
=> WriterOptions

conversion options

-> Pandoc

document to convert

-> m Text

FictionBook2 document (not encoded yet)

Produce an FB2 document from a Pandoc document.

writeHaddock :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to Haddock.

writeHtml4 :: PandocMonad m => WriterOptions -> Pandoc -> m Html Source #

Convert Pandoc document to Html 4 structure.

writeHtml4String :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc document to Html 4 string.

writeHtml5 :: PandocMonad m => WriterOptions -> Pandoc -> m Html Source #

Convert Pandoc document to Html 5 structure.

writeHtml5String :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc document to Html 5 string.

writeICML :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc document to string in ICML format.

writeJATS :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Deprecated: Use writeJatsArchiving instead

Alias for writeJatsArchiving. This function exists for backwards compatibility, but will be deprecated in the future. Use writeJatsArchiving instead.

writeJatsArchiving :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert a Pandoc document to JATS (Archiving and Interchange Tag Set.)

writeJatsArticleAuthoring :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert a Pandoc document to JATS (Archiving and Interchange Tag Set.)

writeJatsPublishing :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert a Pandoc document to JATS (Journal Publishing Tag Set.)

writeJira :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to Jira.

writeLaTeX :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to LaTeX.

writeMan :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to Man.

writeMarkdown :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to Markdown.

writeMarkua :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to Markua.

writeMediaWiki :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to MediaWiki.

writeMs :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to Ms.

writeMuse :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to Muse.

writeNative :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Prettyprint Pandoc document.

writeODT Source #

Arguments

:: PandocMonad m 
=> WriterOptions

Writer options

-> Pandoc

Document to convert

-> m ByteString 

Produce an ODT file from a Pandoc document.

writeOPML :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc document to string in OPML format.

writeOpenDocument :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc document to string in OpenDocument format.

writeOrg :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to Org.

writePlain :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to plain text (like markdown, but without links, pictures, or inline formatting).

writePowerpoint Source #

Arguments

:: PandocMonad m 
=> WriterOptions

Writer options

-> Pandoc

Document to convert

-> m ByteString 

writeRST :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to RST.

writeRTF :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to a string in rich text format.

writeRevealJs :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc document to Reveal JS HTML slide show.

writeS5 :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc document to S5 HTML slide show.

writeSlideous :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc document to Slideous HTML slide show.

writeSlidy :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc document to Slidy HTML slide show.

writeTEI :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc document to string in Docbook format.

writeTexinfo :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to Texinfo.

writeTextile :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to Textile.

writeTypst :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to Typst.

writeXWiki :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to XWiki.

writeZimWiki :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #

Convert Pandoc to ZimWiki.

getWriter :: PandocMonad m => FlavoredFormat -> m (Writer m, Extensions) Source #

Retrieve writer, extensions based on formatSpec (format+extensions).