Text.Pandoc

pandoc-1.0: Conversion between markup formats

Text.Pandoc

Portability	portable
Stability	alpha
Maintainer	John MacFarlane <jgm@berkeley.edu>

Contents

Definitions
Readers: converting to Pandoc format
Parser state used in readers
Writers: converting from Pandoc format
Writer options used in writers
Default headers for various output formats
Version

Description

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
 import qualified System.IO.UTF8 as U

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

Synopsis

module Text.Pandoc.Definition

readMarkdown :: ParserState -> String -> Pandoc

readRST :: ParserState -> String -> Pandoc

readLaTeX :: ParserState -> String -> Pandoc

readHtml :: ParserState -> String -> Pandoc

data ParserState = ParserState {

stateParseRaw :: Bool

stateParserContext :: ParserContext

stateQuoteContext :: QuoteContext

stateSanitizeHTML :: Bool

stateKeys :: KeyTable

stateNotes :: NoteTable

stateTabStop :: Int

stateStandalone :: Bool

stateTitle :: [Inline]

stateAuthors :: [String]

stateDate :: String

stateStrict :: Bool

stateSmart :: Bool

stateColumns :: Int

stateHeaderTable :: [HeaderType]

}

defaultParserState :: ParserState

data ParserContext

data QuoteContext

| NoQuote

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

type NoteTable = [(String, [Block])]

data HeaderType

= SingleHeader Char

| DoubleHeader Char

writeMarkdown :: WriterOptions -> Pandoc -> String

writeRST :: WriterOptions -> Pandoc -> String

writeLaTeX :: WriterOptions -> Pandoc -> String

writeConTeXt :: WriterOptions -> Pandoc -> String

writeTexinfo :: WriterOptions -> Pandoc -> String

writeHtml :: WriterOptions -> Pandoc -> Html

writeHtmlString :: WriterOptions -> Pandoc -> String

writeS5 :: WriterOptions -> Pandoc -> Html

writeS5String :: WriterOptions -> Pandoc -> String

writeDocbook :: WriterOptions -> Pandoc -> String

writeOpenDocument :: WriterOptions -> Pandoc -> String

writeMan :: WriterOptions -> Pandoc -> String

writeMediaWiki :: WriterOptions -> Pandoc -> String

writeRTF :: WriterOptions -> Pandoc -> String

prettyPandoc :: Pandoc -> String

data WriterOptions = WriterOptions {}

defaultWriterOptions :: WriterOptions

module Text.Pandoc.DefaultHeaders

pandocVersion :: String

Definitions

module Text.Pandoc.Definition

Readers: converting to Pandoc format

readMarkdown :: ParserState -> String -> Pandoc

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

readRST :: ParserState -> String -> Pandoc

Parse reStructuredText string and return Pandoc document.

readLaTeX

:: ParserState	Parser state, including options for parser
-> String	String to parse
-> Pandoc
Parse LaTeX from string and return `Pandoc` document.

readHtml

:: ParserState	Parser state
-> String	String to parse
-> Pandoc
Convert HTML-formatted string to `Pandoc` document.

Parser state used in readers

data ParserState

Parsing options.

Constructors

ParserState

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 :: [String]	Authors of document
stateDate :: String	Date of document
stateStrict :: Bool	Use strict markdown syntax?
stateSmart :: Bool	Use smart typography?
stateColumns :: Int	Number of columns in terminal
stateHeaderTable :: [HeaderType]	Ordered list of header types used

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, [Block])]

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.

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

writerStandalone :: Bool	Include header and footer
writerHeader :: String	Header for the document
writerTitlePrefix :: String	Prefix for HTML titles
writerTabStop :: Int	Tabstop for conversion btw spaces and tabs
writerTableOfContents :: Bool	Include table of contents
writerS5 :: Bool	We're writing S5
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
writerIncludeBefore :: String	String to include before the body
writerIncludeAfter :: String	String to include after the body
writerStrictMarkdown :: Bool	Use strict markdown syntax
writerReferenceLinks :: Bool	Use reference links in writing markdown, rst
writerWrapText :: Bool	Wrap text to line length

Instances

Show WriterOptions

defaultWriterOptions :: WriterOptions

Default writer options.

Default headers for various output formats

module Text.Pandoc.DefaultHeaders

Version

pandocVersion :: String

Version number of pandoc library.

Produced by Haddock version 0.8