Text.Pandoc.App

Does a pandoc conversion based on command-line options.

Documentation

convertWithOpts :: Opt -> IO ()

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

  Reader format

• optWriter :: Maybe String

  Writer format

• optTableOfContents :: Bool

  Include table of contents

• optBaseHeaderLevel :: Int

  Base header level

• optTemplate :: Maybe FilePath

  Custom template

• optVariables :: [(String, String)]

  Template variables to set

• optMetadata :: [(String, String)]

  Metadata fields to set

• optOutputFile :: Maybe FilePath

  Name of output file

• optInputFiles :: [FilePath]

  Names of input files

• optNumberSections :: Bool

  Number sections in LaTeX

• optNumberOffset :: [Int]

  Starting number for sections

• optSectionDivs :: Bool

  Put sections in div tags in HTML

• optIncremental :: Bool

  Use incremental lists in SlidySlideousS5

• optSelfContained :: Bool

  Make HTML accessible offline

• optHtmlQTags :: Bool

  Use q tags in HTML

• optHighlightStyle :: Maybe String

  Style to use for highlighted code

• optSyntaxDefinitions :: [FilePath]

  xml syntax defs to load

• optTopLevelDivision :: TopLevelDivision

  Type of the top-level divisions

• optHTMLMathMethod :: HTMLMathMethod

  Method to print HTML math

• optAbbreviations :: Maybe FilePath

  Path to abbrevs file

• optReferenceDoc :: Maybe FilePath

  Path of reference doc

• optEpubSubdirectory :: String

  EPUB subdir in OCF container

• optEpubMetadata :: Maybe FilePath

  EPUB metadata

• optEpubFonts :: [FilePath]

  EPUB fonts to embed

• optEpubChapterLevel :: Int

  Header level at which to split chapters

• optEpubCoverImage :: Maybe FilePath

  Cover image for epub

• optTOCDepth :: Int

  Number of levels to include in TOC

• optDumpArgs :: Bool

  Output command-line arguments

• optIgnoreArgs :: Bool

  Ignore command-line arguments

• optVerbosity :: Verbosity

  Verbosity of diagnostic output

• optTrace :: Bool

  Enable tracing

• optLogFile :: Maybe FilePath

  File to write JSON log output

• optFailIfWarnings :: Bool

  Fail on warnings

• optReferenceLinks :: Bool

  Use reference links in writing markdown, rst

• optReferenceLocation :: ReferenceLocation

  location for footnotes and link references in markdown output

• optDpi :: Int

  Dpi

• optWrapText :: WrapOption

  Options for wrapping text

• optColumns :: Int

  Line length in characters

• optFilters :: [FilePath]

  Filters to apply

• optLuaFilters :: [FilePath]

  Lua filters to apply

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

  Default classes for indented code blocks

• optDataDir :: Maybe FilePath
• optCiteMethod :: CiteMethod

  Method to output cites

• optListings :: Bool

  Use listings package for code blocks

• optPdfEngine :: Maybe String

  Program to use for latex/html -> pdf

• optPdfEngineArgs :: [String]

  Flags to pass to the engine

• optSlideLevel :: Maybe Int

  Header level that creates slides

• optSetextHeaders :: Bool

  Use atx headers for markdown level 1-2

• optAscii :: Bool

  Use ascii characters only in html

• optDefaultImageExtension :: String

  Default image extension

• optExtractMedia :: Maybe FilePath

  Path to extract embedded media

• optTrackChanges :: TrackChanges

  Accept or reject MS Word track-changes.

• optFileScope :: Bool

  Parse input files before combining

• optTitlePrefix :: Maybe String

  Prefix for title

• optCss :: [FilePath]

  CSS files to link to

• optIncludeBeforeBody :: [FilePath]

  Files to include before

• optIncludeAfterBody :: [FilePath]

  Files to include after body

• optIncludeInHeader :: [FilePath]

  Files to include in header

• optResourcePath :: [FilePath]

  Path to search for images etc

• optRequestHeaders :: [(String, String)]

  Headers for HTTP requests

• optEol :: LineEnding

  Style of line-endings to use

• optStripComments :: Bool

  Skip HTML comments

Instances

Show Opt

Methods

showsPrec :: Int -> Opt -> ShowS

show :: Opt -> String

showList :: [Opt] -> ShowS

Generic Opt

Associated Types

type Rep Opt :: * -> *

Methods

from :: Opt -> Rep Opt x

to :: Rep Opt x -> Opt

FromJSON Opt

Methods

parseJSON :: Value -> Parser Opt

parseJSONList :: Value -> Parser [Opt]

ToJSON Opt

Methods

toJSON :: Opt -> Value

toEncoding :: Opt -> Encoding

toJSONList :: [Opt] -> Value

toEncodingList :: [Opt] -> Encoding

type Rep Opt

type Rep Opt

defaultOpts :: Opt

Defaults for command-line options.

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

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

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

applyFilters :: MonadIO m => ReaderOptions -> Maybe FilePath -> [FilePath] -> [String] -> Pandoc -> m Pandoc

applyLuaFilters :: Maybe FilePath -> [FilePath] -> String -> Pandoc -> PandocIO Pandoc