| pandoc | Source code | Contents | Index

Main

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

Description
Parses command-line options and calls the appropriate readers and writers.
Synopsis

copyrightMessage :: String
compileInfo :: String
wrapWords :: Int -> [String] -> String
readers :: [(String, ParserState -> String -> Pandoc)]
readPandoc :: ParserState -> String -> Pandoc
writers :: [(String, WriterOptions -> Pandoc -> String)]
isNonTextOutput :: String -> Bool

data Opt = Opt {

optTabStop :: Int
optPreserveTabs :: Bool
optStandalone :: Bool
optReader :: String
optWriter :: String
optParseRaw :: Bool
optTableOfContents :: Bool
optTransforms :: [Pandoc -> Pandoc]
optTemplate :: String
optVariables :: [(String, String)]
optOutputFile :: String
optNumberSections :: Bool
optSectionDivs :: Bool
optIncremental :: Bool
optOffline :: Bool
optXeTeX :: Bool
optSmart :: Bool
optHTMLMathMethod :: HTMLMathMethod
optReferenceODT :: Maybe FilePath
optEPUBStylesheet :: Maybe String
optEPUBMetadata :: String
optDumpArgs :: Bool
optIgnoreArgs :: Bool
optStrict :: Bool
optReferenceLinks :: Bool
optWrapText :: Bool
optSanitizeHTML :: Bool
optPlugins :: [Pandoc -> IO Pandoc]
optEmailObfuscation :: ObfuscationMethod
optIdentifierPrefix :: String
optIndentedCodeClasses :: [String]
optDataDir :: Maybe FilePath

}

defaultOpts :: Opt
options :: [OptDescr (Opt -> IO Opt)]
usageMessage :: String -> [OptDescr (Opt -> IO Opt)] -> String
defaultReaderName :: String -> [FilePath] -> String
lhsExtension :: [FilePath] -> Bool
defaultWriterName :: FilePath -> String
main :: IO ()

Documentation

copyrightMessage :: String | Source

compileInfo :: String | Source

wrapWords :: Int -> [String] -> String | Source

Converts a list of strings into a single string with the items printed as comma separated words in lines with a maximum line length.

readers :: [(String, ParserState -> String -> Pandoc)] | Source

Association list of formats and readers.

readPandoc :: ParserState -> String -> Pandoc | Source

Reader for native Pandoc format.

writers :: [(String, WriterOptions -> Pandoc -> String)] | Source

Association list of formats and writers.

isNonTextOutput :: String -> Bool | Source

data Opt | Source

Data structure for command line options.
Constructors

Opt |

optTabStop :: Int | Number of spaces per tab
optPreserveTabs :: Bool | Preserve tabs instead of converting to spaces
optStandalone :: Bool | Include header, footer
optReader :: String | Reader format
optWriter :: String | Writer format
optParseRaw :: Bool | Parse unconvertable HTML and TeX
optTableOfContents :: Bool | Include table of contents
optTransforms :: [Pandoc -> Pandoc] | Doc transforms to apply
optTemplate :: String | Custom template
optVariables :: [(String, String)] | Template variables to set
optOutputFile :: String | Name of output file
optNumberSections :: Bool | Number sections in LaTeX
optSectionDivs :: Bool | Put sections in div tags in HTML
optIncremental :: Bool | Use incremental lists in Slidy/S5
optOffline :: Bool | Make slideshow accessible offline
optXeTeX :: Bool | Format latex for xetex
optSmart :: Bool | Use smart typography
optHTMLMathMethod :: HTMLMathMethod | Method to print HTML math
optReferenceODT :: Maybe FilePath | Path of reference.odt
optEPUBStylesheet :: Maybe String | EPUB stylesheet
optEPUBMetadata :: String | EPUB metadata
optDumpArgs :: Bool | Output command-line arguments
optIgnoreArgs :: Bool | Ignore command-line arguments
optStrict :: Bool | Use strict markdown syntax
optReferenceLinks :: Bool | Use reference links in writing markdown, rst
optWrapText :: Bool | Wrap text
optSanitizeHTML :: Bool | Sanitize HTML
optPlugins :: [Pandoc -> IO Pandoc] | Plugins to apply
optEmailObfuscation :: ObfuscationMethod |
optIdentifierPrefix :: String |
optIndentedCodeClasses :: [String] | Default classes for indented code blocks
optDataDir :: Maybe FilePath |

defaultOpts :: Opt | Source

Defaults for command-line options.

options :: [OptDescr (Opt -> IO Opt)] | Source

A list of functions, each transforming the options data structure in response to a command-line option.

usageMessage :: String -> [OptDescr (Opt -> IO Opt)] -> String | Source

defaultReaderName :: String -> [FilePath] -> String | Source

lhsExtension :: [FilePath] -> Bool | Source

defaultWriterName :: FilePath -> String | Source

main :: IO () | Source

Produced by Haddock version 2.4.2