Text.Pandoc.Readers

This helper module exports the readers.

Note: all of the readers assume that the input text has '\n' line endings. So if you get your input text from a web form, you should remove '\r' characters using filter (/='\r').

Readers: converting to Pandoc format

data Reader m

Constructors

TextReader (ReaderOptions -> Text -> m Pandoc)

ByteStringReader (ReaderOptions -> ByteString -> m Pandoc)

readers :: PandocMonad m => [(String, Reader m)]

Association list of formats and readers.

readDocx :: PandocMonad m => ReaderOptions -> ByteString -> m Pandoc

readOdt :: PandocMonad m => ReaderOptions -> ByteString -> m Pandoc

readMarkdown

Arguments

:: PandocMonad m

=> ReaderOptions

Reader options

-> Text

String to parse (assuming '\n' line endings)

-> m Pandoc

Read markdown from an input string and return a Pandoc document.

readCommonMark :: PandocMonad m => ReaderOptions -> Text -> m Pandoc

Parse a CommonMark formatted string into a Pandoc structure.

readCreole :: PandocMonad m => ReaderOptions -> Text -> m Pandoc

Read creole from an input string and return a Pandoc document.

readMediaWiki

Arguments

:: PandocMonad m

=> ReaderOptions

Reader options

-> Text

String to parse (assuming '\n' line endings)

-> m Pandoc

Read mediawiki from an input string and return a Pandoc document.

readVimwiki :: PandocMonad m => ReaderOptions -> Text -> m Pandoc

readRST

Arguments

:: PandocMonad m

=> ReaderOptions

Reader options

-> Text

String to parse (assuming '\n' line endings)

-> m Pandoc

Parse reStructuredText string and return Pandoc document.

readOrg

Arguments

:: PandocMonad m

=> ReaderOptions

Reader options

-> Text

String to parse (assuming '\n' line endings)

-> m Pandoc

Parse org-mode string and return a Pandoc document.

readLaTeX

Arguments

:: PandocMonad m

=> ReaderOptions

Reader options

-> Text

String to parse (assumes '\n' line endings)

-> m Pandoc

Parse LaTeX from string and return Pandoc document.

readHtml

Arguments

:: PandocMonad m

=> ReaderOptions

Reader options

-> Text

String to parse (assumes '\n' line endings)

-> m Pandoc

Convert HTML-formatted string to Pandoc document.

readTextile

Arguments

:: PandocMonad m

=> ReaderOptions

Reader options

-> Text

String to parse (assuming '\n' line endings)

-> m Pandoc

Parse a Textile text and return a Pandoc document.

readDocBook :: PandocMonad m => ReaderOptions -> Text -> m Pandoc

readOPML :: PandocMonad m => ReaderOptions -> Text -> m Pandoc

readHaddock :: PandocMonad m => ReaderOptions -> Text -> m Pandoc

Parse Haddock markup and return a Pandoc document.

readNative

Arguments

:: PandocMonad m

=> ReaderOptions

-> Text

String to parse (assuming '\n' line endings)

-> m Pandoc

Read native formatted text and return a Pandoc document. The input may be a full pandoc document, a block list, a block, an inline list, or an inline. Thus, for example,

Str "hi"

will be treated as if it were

Pandoc nullMeta [Plain [Str "hi"]]

readJSON :: ReaderOptions -> Text -> Either PandocError Pandoc

Read pandoc document from JSON format.

readTWiki :: PandocMonad m => ReaderOptions -> Text -> m Pandoc

Read twiki from an input string and return a Pandoc document.

readTikiWiki :: PandocMonad m => ReaderOptions -> Text -> m Pandoc

Read TikiWiki from an input string and return a Pandoc document.

readTxt2Tags :: PandocMonad m => ReaderOptions -> Text -> m Pandoc

Read Txt2Tags from an input string returning a Pandoc document

readEPUB :: PandocMonad m => ReaderOptions -> ByteString -> m Pandoc

readMuse :: PandocMonad m => ReaderOptions -> Text -> m Pandoc

Read Muse from an input string and return a Pandoc document.

Miscellaneous

getReader :: PandocMonad m => String -> Either String (Reader m, Extensions)

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

getDefaultExtensions :: String -> Extensions

Default extensions from format-describing string.