| Copyright | Copyright (C) 2006-2023 John MacFarlane |
|---|---|
| License | GNU GPL, version 2 or above |
| Maintainer | John MacFarlane <jgm@berkeley.edu> |
| Stability | alpha |
| Portability | portable |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Text.Pandoc.Writers
Description
This helper module exports all writers functions.
Synopsis
- data Writer m
- = TextWriter (WriterOptions -> Pandoc -> m Text)
- | ByteStringWriter (WriterOptions -> Pandoc -> m ByteString)
- writers :: PandocMonad m => [(Text, Writer m)]
- writeAsciiDoc :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeAsciiDoctor :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeBeamer :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeBibTeX :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeBibLaTeX :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeChunkedHTML :: PandocMonad m => WriterOptions -> Pandoc -> m ByteString
- writeCommonMark :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeConTeXt :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeCslJson :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeDZSlides :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeDocBook4 :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeDocBook5 :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeDocx :: PandocMonad m => WriterOptions -> Pandoc -> m ByteString
- writeDokuWiki :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeEPUB2 :: PandocMonad m => WriterOptions -> Pandoc -> m ByteString
- writeEPUB3 :: PandocMonad m => WriterOptions -> Pandoc -> m ByteString
- writeFB2 :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeIpynb :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeHaddock :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeHtml4 :: PandocMonad m => WriterOptions -> Pandoc -> m Html
- writeHtml4String :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeHtml5 :: PandocMonad m => WriterOptions -> Pandoc -> m Html
- writeHtml5String :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeICML :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeJATS :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeJatsArchiving :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeJatsArticleAuthoring :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeJatsPublishing :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeJSON :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeJira :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeLaTeX :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeMan :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeMarkdown :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeMarkua :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeMediaWiki :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeMs :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeMuse :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeNative :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeODT :: PandocMonad m => WriterOptions -> Pandoc -> m ByteString
- writeOPML :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeOpenDocument :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeOrg :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writePlain :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writePowerpoint :: PandocMonad m => WriterOptions -> Pandoc -> m ByteString
- writeRST :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeRTF :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeRevealJs :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeS5 :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeSlideous :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeSlidy :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeTEI :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeTexinfo :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeTextile :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeTypst :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeXWiki :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- writeZimWiki :: PandocMonad m => WriterOptions -> Pandoc -> m Text
- getWriter :: PandocMonad m => FlavoredFormat -> m (Writer m, Extensions)
Writers: converting from Pandoc format
Constructors
| TextWriter (WriterOptions -> Pandoc -> m Text) | |
| ByteStringWriter (WriterOptions -> Pandoc -> m ByteString) |
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.
writeCslJson :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #
writeDZSlides :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #
Convert Pandoc document to DZSlides HTML slide show.
writeDocBook4 :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #
writeDocBook5 :: PandocMonad m => WriterOptions -> Pandoc -> m Text 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.
Arguments
| :: PandocMonad m | |
| => WriterOptions | Writer options |
| -> Pandoc | Document to convert |
| -> m ByteString |
Produce an EPUB2 file from a Pandoc document.
Arguments
| :: PandocMonad m | |
| => WriterOptions | Writer options |
| -> Pandoc | Document to convert |
| -> m ByteString |
Produce an EPUB3 file from a Pandoc document.
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.
writeIpynb :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #
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 writeJatsArchivingwriteJatsArchiving
writeJatsArchiving :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #
Convert a Pandoc
writeJatsArticleAuthoring :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #
Convert a Pandoc
writeJatsPublishing :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #
Convert a Pandoc
writeJSON :: PandocMonad m => WriterOptions -> Pandoc -> m Text Source #
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.
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).
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).