pandocSource codeContentsIndex
Main
Portabilityportable
Stabilityalpha
MaintainerJohn 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 :: StringSource
compileInfo :: StringSource
wrapWords :: Int -> [String] -> StringSource
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 -> PandocSource
Reader for native Pandoc format.
writers :: [(String, WriterOptions -> Pandoc -> String)]Source
Association list of formats and writers.
isNonTextOutput :: String -> BoolSource
data Opt Source
Data structure for command line options.
Constructors
Opt
optTabStop :: IntNumber of spaces per tab
optPreserveTabs :: BoolPreserve tabs instead of converting to spaces
optStandalone :: BoolInclude header, footer
optReader :: StringReader format
optWriter :: StringWriter format
optParseRaw :: BoolParse unconvertable HTML and TeX
optTableOfContents :: BoolInclude table of contents
optTransforms :: [Pandoc -> Pandoc]Doc transforms to apply
optTemplate :: StringCustom template
optVariables :: [(String, String)]Template variables to set
optOutputFile :: StringName of output file
optNumberSections :: BoolNumber sections in LaTeX
optSectionDivs :: BoolPut sections in div tags in HTML
optIncremental :: BoolUse incremental lists in Slidy/S5
optOffline :: BoolMake slideshow accessible offline
optXeTeX :: BoolFormat latex for xetex
optSmart :: BoolUse smart typography
optHTMLMathMethod :: HTMLMathMethodMethod to print HTML math
optReferenceODT :: Maybe FilePathPath of reference.odt
optEPUBStylesheet :: Maybe StringEPUB stylesheet
optEPUBMetadata :: StringEPUB metadata
optDumpArgs :: BoolOutput command-line arguments
optIgnoreArgs :: BoolIgnore command-line arguments
optStrict :: BoolUse strict markdown syntax
optReferenceLinks :: BoolUse reference links in writing markdown, rst
optWrapText :: BoolWrap text
optSanitizeHTML :: BoolSanitize HTML
optPlugins :: [Pandoc -> IO Pandoc]Plugins to apply
optEmailObfuscation :: ObfuscationMethod
optIdentifierPrefix :: String
optIndentedCodeClasses :: [String]Default classes for indented code blocks
optDataDir :: Maybe FilePath
defaultOpts :: OptSource
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)] -> StringSource
defaultReaderName :: String -> [FilePath] -> StringSource
lhsExtension :: [FilePath] -> BoolSource
defaultWriterName :: FilePath -> StringSource
main :: IO ()Source
Produced by Haddock version 2.4.2