Text.Pandoc

This helper module exports the main writers, readers, and data structure definitions from the Pandoc libraries.

A typical application will chain together a reader and a writer to convert strings from one format to another. For example, the following simple program will act as a filter converting markdown fragments to reStructuredText, using reference-style links instead of inline links:

 module Main where
 import Text.Pandoc
 -- include the following two lines only if you're using ghc < 6.12:
 import Prelude hiding (getContents, putStrLn)
 import System.IO.UTF8

 markdownToRST :: String -> String
 markdownToRST =
   (writeRST defaultWriterOptions {writerReferenceLinks = True}) .
   readMarkdown defaultParserState
 
 main = getContents >>= putStrLn . markdownToRST

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').

Definitions

module Text.Pandoc.Definition

Readers: converting to Pandoc format

readMarkdown

Arguments

:: ParserState

Parser state, including options for parser

-> String

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

-> Pandoc

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

readRST

Arguments

:: ParserState

Parser state, including options for parser

-> String

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

-> Pandoc

Parse reStructuredText string and return Pandoc document.

readLaTeX

Arguments

:: ParserState

Parser state, including options for parser

-> String

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

-> Pandoc

Parse LaTeX from string and return Pandoc document.

readHtml

Arguments

:: ParserState

Parser state

-> String

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

-> Pandoc

Convert HTML-formatted string to Pandoc document.

Parser state used in readers

data ParserState

Parsing options.

Constructors

ParserState

Fields

stateParseRaw :: Bool

Parse raw HTML and LaTeX?

stateParserContext :: ParserContext

Inside list?

stateQuoteContext :: QuoteContext

Inside quoted environment?

stateSanitizeHTML :: Bool

Sanitize HTML?

stateKeys :: KeyTable

List of reference keys

stateNotes :: NoteTable

List of notes

stateTabStop :: Int

Tab stop

stateStandalone :: Bool

Parse bibliographic info?

stateTitle :: [Inline]

Title of document

stateAuthors :: [[Inline]]

Authors of document

stateDate :: [Inline]

Date of document

stateStrict :: Bool

Use strict markdown syntax?

stateSmart :: Bool

Use smart typography?

stateLiterateHaskell :: Bool

Treat input as literate haskell

stateColumns :: Int

Number of columns in terminal

stateHeaderTable :: [HeaderType]

Ordered list of header types used

stateIndentedCodeClasses :: [String]

Classes to use for indented code blocks

Instances

Show ParserState

defaultParserState :: ParserState

data ParserContext

Constructors

ListItemState

Used when running parser on list item contents

NullState

Default state

Instances

Eq ParserContext

Show ParserContext

data QuoteContext

Constructors

InSingleQuote

Used when parsing inside single quotes

InDoubleQuote

Used when parsing inside double quotes

NoQuote

Used when not parsing inside quotes

Instances

Eq QuoteContext

Show QuoteContext

type KeyTable = [([Inline], Target)]

type NoteTable = [(String, String)]

data HeaderType

Constructors

SingleHeader Char

Single line of characters underneath

DoubleHeader Char

Lines of characters above and below

Instances

Eq HeaderType

Show HeaderType

Writers: converting from Pandoc format

writeMarkdown :: WriterOptions -> Pandoc -> String

Convert Pandoc to Markdown.

writePlain :: WriterOptions -> Pandoc -> String

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

writeRST :: WriterOptions -> Pandoc -> String

Convert Pandoc to RST.

writeLaTeX :: WriterOptions -> Pandoc -> String

Convert Pandoc to LaTeX.

writeConTeXt :: WriterOptions -> Pandoc -> String

Convert Pandoc to ConTeXt.

writeTexinfo :: WriterOptions -> Pandoc -> String

Convert Pandoc to Texinfo.

writeHtml :: WriterOptions -> Pandoc -> Html

Convert Pandoc document to Html structure.

writeHtmlString :: WriterOptions -> Pandoc -> String

Convert Pandoc document to Html string.

writeS5 :: WriterOptions -> Pandoc -> Html

Converts Pandoc document to an S5 HTML presentation (Html structure).

writeS5String :: WriterOptions -> Pandoc -> String

Converts Pandoc document to an S5 HTML presentation (string).

writeDocbook :: WriterOptions -> Pandoc -> String

Convert Pandoc document to string in Docbook format.

writeOpenDocument :: WriterOptions -> Pandoc -> String

Convert Pandoc document to string in OpenDocument format.

writeMan :: WriterOptions -> Pandoc -> String

Convert Pandoc to Man.

writeMediaWiki :: WriterOptions -> Pandoc -> String

Convert Pandoc to MediaWiki.

writeRTF :: WriterOptions -> Pandoc -> String

Convert Pandoc to a string in rich text format.

prettyPandoc :: Pandoc -> String

Prettyprint Pandoc document.

Writer options used in writers

data WriterOptions

Options for writers

Constructors

WriterOptions

Fields

writerStandalone :: Bool

Include header and footer

writerTemplate :: String

Template to use in standalone mode

writerVariables :: [(String, String)]

Variables to set in template

writerIncludeBefore :: String

Text to include before the body

writerIncludeAfter :: String

Text to include after the body

writerTabStop :: Int

Tabstop for conversion btw spaces and tabs

writerTableOfContents :: Bool

Include table of contents

writerS5 :: Bool

We're writing S5

writerXeTeX :: Bool

Create latex suitable for use by xetex

writerHTMLMathMethod :: HTMLMathMethod

How to print math in HTML

writerIgnoreNotes :: Bool

Ignore footnotes (used in making toc)

writerIncremental :: Bool

Incremental S5 lists

writerNumberSections :: Bool

Number sections in LaTeX

writerStrictMarkdown :: Bool

Use strict markdown syntax

writerReferenceLinks :: Bool

Use reference links in writing markdown, rst

writerWrapText :: Bool

Wrap text to line length

writerLiterateHaskell :: Bool

Write as literate haskell

writerEmailObfuscation :: ObfuscationMethod

How to obfuscate emails

writerIdentifierPrefix :: String

Prefix for section & note ids in HTML

Instances

Show WriterOptions

data HTMLMathMethod

Constructors

PlainMath

LaTeXMathML (Maybe String)

JsMath (Maybe String)

GladTeX

MimeTeX String

MathML (Maybe String)

Instances

Eq HTMLMathMethod

Read HTMLMathMethod

Show HTMLMathMethod

defaultWriterOptions :: WriterOptions

Default writer options.

Rendering templates and default templates

module Text.Pandoc.Templates

Version

pandocVersion :: String

Version number of pandoc library.