scholdoc-0.1.3: Converts ScholarlyMarkdown documents to HTML5/LaTeX/Docx format

CopyrightCopyright (C) 2006-2014 John MacFarlane
LicenseGNU GPL, version 2 or above
MaintainerJohn MacFarlane <jgm@berkeley.edu>
Stabilityalpha
Portabilityportable
Safe HaskellNone
LanguageHaskell98

Text.Pandoc

Contents

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

markdownToRST :: String -> String
markdownToRST =
  (writeRST def {writerReferenceLinks = True}) . readMarkdown def

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

Synopsis

Definitions

Generics

Options

Lists of readers and writers

readers :: [(String, Reader)] Source

Association list of formats and readers.

writers :: [(String, Writer)] Source

Association list of formats and writers.

Readers: converting to Pandoc format

readMarkdown Source

Arguments

:: ReaderOptions

Reader options

-> String

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

-> Pandoc 

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

readLaTeX Source

Arguments

:: ReaderOptions

Reader options

-> String

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

-> Pandoc 

Parse LaTeX from string and return Pandoc document.

readHtml Source

Arguments

:: ReaderOptions

Reader options

-> String

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

-> Pandoc 

Convert HTML-formatted string to Pandoc document.

readNative Source

Arguments

:: String

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

-> 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"]]

Writers: converting from Pandoc format

writeNative :: WriterOptions -> Pandoc -> String Source

Prettyprint Pandoc document.

writeMarkdown :: WriterOptions -> Pandoc -> String Source

Convert Pandoc to Markdown.

writePlain :: WriterOptions -> Pandoc -> String Source

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

writeLaTeX :: WriterOptions -> Pandoc -> String Source

Convert Pandoc to LaTeX.

writeHtml :: WriterOptions -> Pandoc -> Html Source

Convert Pandoc document to Html structure.

writeHtmlString :: WriterOptions -> Pandoc -> String Source

Convert Pandoc document to Html string.

writeMan :: WriterOptions -> Pandoc -> String Source

Convert Pandoc to Man.

writeDocx Source

Arguments

:: WriterOptions

Writer options

-> Pandoc

Document to convert

-> IO ByteString 

Produce an Docx file from a Pandoc document.

writeHaddock :: WriterOptions -> Pandoc -> String Source

Convert Pandoc to Haddock.

writeCustom :: FilePath -> WriterOptions -> Pandoc -> IO String Source

Convert Pandoc to custom markup.

Rendering templates and default templates

Version

pandocVersion :: String Source

Version number of pandoc library.

Miscellaneous

getReader :: String -> Either String Reader Source

Retrieve reader based on formatSpec (format+extensions).

getWriter :: String -> Either String Writer Source

Retrieve writer based on formatSpec (format+extensions).

class ToJSONFilter a => ToJsonFilter a where Source

Deprecated. Use toJSONFilter from Text.Pandoc.JSON instead.

Minimal complete definition

Nothing

Methods

toJsonFilter :: a -> IO () Source

Deprecated: Use toJSONFilter from JSON instead