pandoc

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

Main

Description

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

Synopsis

- copyrightMessage :: String
- compileInfo :: String
- wrapWords :: Int -> [String] -> 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 :: Maybe FilePath
  - optVariables :: [(String, String)]
  - optOutputFile :: String
  - optNumberSections :: Bool
  - optSectionDivs :: Bool
  - optIncremental :: Bool
  - optOffline :: Bool
  - optXeTeX :: Bool
  - optSmart :: Bool
  - optHtml5 :: Bool
  - optChapters :: Bool
  - optHTMLMathMethod :: HTMLMathMethod
  - optReferenceODT :: Maybe FilePath
  - optEPUBStylesheet :: Maybe String
  - optEPUBMetadata :: String
  - optDumpArgs :: Bool
  - optIgnoreArgs :: Bool
  - optStrict :: Bool
  - optReferenceLinks :: Bool
  - optWrapText :: Bool
  - optColumns :: Int
  - optPlugins :: [Pandoc -> IO Pandoc]
  - optEmailObfuscation :: ObfuscationMethod
  - optIdentifierPrefix :: String
  - optIndentedCodeClasses :: [String]
  - optDataDir :: Maybe FilePath
  - optCiteMethod :: CiteMethod
  - optBibliography :: [String]
  - optCslFile :: FilePath
  - optListings :: Bool
  - optAscii :: Bool
  }
- 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

compileInfo :: String

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

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

isNonTextOutput :: String -> Bool

data Opt

Data structure for command line options.

Constructors

Opt |

Fields

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 :: Maybe FilePath

  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

optHtml5 :: Bool

  Produce HTML5 in HTML

optChapters :: Bool

  Use chapter for top-level sects

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

optColumns :: Int

  Line length in characters

optPlugins :: [Pandoc -> IO Pandoc]

  Plugins to apply

optEmailObfuscation :: ObfuscationMethod
optIdentifierPrefix :: String
optIndentedCodeClasses :: [String]

  Default classes for indented code blocks

optDataDir :: Maybe FilePath
optCiteMethod :: CiteMethod

  Method to output cites

optBibliography :: [String]
optCslFile :: FilePath
optListings :: Bool

  Use listings package for code blocks

optAscii :: Bool

  Avoid using nonascii characters

defaultOpts :: Opt

Defaults for command-line options.

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

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

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

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

lhsExtension :: [FilePath] -> Bool

defaultWriterName :: FilePath -> String

main :: IO ()