Copyright	Copyright (C) 2006-2019 John MacFarlane
License	GNU GPL, version 2 or above
Maintainer	John MacFarlane <jgm@berkeley@edu>
Stability	alpha
Portability	portable
Safe Haskell	None
Language	Haskell2010

Text.Pandoc.App

Description

Does a pandoc conversion based on command-line options.

Synopsis

convertWithOpts :: Opt -> IO ()
data Opt = Opt {
- optTabStop :: Int
- optPreserveTabs :: Bool
- optStandalone :: Bool
- optReader :: Maybe String
- optWriter :: Maybe String
- optTableOfContents :: Bool
- optBaseHeaderLevel :: Int
- optTemplate :: Maybe FilePath
- optVariables :: [(String, String)]
- optMetadata :: [(String, String)]
- optMetadataFile :: Maybe FilePath
- optOutputFile :: Maybe FilePath
- optInputFiles :: [FilePath]
- optNumberSections :: Bool
- optNumberOffset :: [Int]
- optSectionDivs :: Bool
- optIncremental :: Bool
- optSelfContained :: Bool
- optHtmlQTags :: Bool
- optHighlightStyle :: Maybe Style
- optSyntaxDefinitions :: [FilePath]
- optTopLevelDivision :: TopLevelDivision
- optHTMLMathMethod :: HTMLMathMethod
- optAbbreviations :: Maybe FilePath
- optReferenceDoc :: Maybe FilePath
- optEpubSubdirectory :: String
- optEpubMetadata :: Maybe FilePath
- optEpubFonts :: [FilePath]
- optEpubChapterLevel :: Int
- optEpubCoverImage :: Maybe FilePath
- optTOCDepth :: Int
- optDumpArgs :: Bool
- optIgnoreArgs :: Bool
- optVerbosity :: Verbosity
- optTrace :: Bool
- optLogFile :: Maybe FilePath
- optFailIfWarnings :: Bool
- optReferenceLinks :: Bool
- optReferenceLocation :: ReferenceLocation
- optDpi :: Int
- optWrapText :: WrapOption
- optColumns :: Int
- optFilters :: [Filter]
- optEmailObfuscation :: ObfuscationMethod
- optIdentifierPrefix :: String
- optStripEmptyParagraphs :: Bool
- optIndentedCodeClasses :: [String]
- optDataDir :: Maybe FilePath
- optCiteMethod :: CiteMethod
- optListings :: Bool
- optPdfEngine :: Maybe String
- optPdfEngineArgs :: [String]
- optSlideLevel :: Maybe Int
- optSetextHeaders :: Bool
- optAscii :: Bool
- optDefaultImageExtension :: String
- optExtractMedia :: Maybe FilePath
- optTrackChanges :: TrackChanges
- optFileScope :: Bool
- optTitlePrefix :: Maybe String
- optCss :: [FilePath]
- optIpynbOutput :: String
- optIncludeBeforeBody :: [FilePath]
- optIncludeAfterBody :: [FilePath]
- optIncludeInHeader :: [FilePath]
- optResourcePath :: [FilePath]
- optRequestHeaders :: [(String, String)]
- optEol :: LineEnding
- optStripComments :: Bool
}
data LineEnding
- = LF
- | CRLF
- | Native
data Filter
- = LuaFilter FilePath
- | JSONFilter FilePath
defaultOpts :: Opt
parseOptions :: [OptDescr (Opt -> IO Opt)] -> Opt -> IO Opt
options :: [OptDescr (Opt -> IO Opt)]
applyFilters :: ReaderOptions -> [Filter] -> [String] -> Pandoc -> PandocIO Pandoc

Documentation

convertWithOpts :: Opt -> IO () Source #

data Opt Source #

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
optMetadataFile :: Maybe FilePath
Name of YAML metadata file
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 Style
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 :: [Filter]
Filters to apply
optEmailObfuscation :: ObfuscationMethod
optIdentifierPrefix :: String
optStripEmptyParagraphs :: Bool
Strip empty paragraphs
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
Prefer ascii output
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
optIpynbOutput :: String
Maybe f to use best data; Nothing to omit
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 Source #
Instance details Defined in Text.Pandoc.App.Opt Methods showsPrec :: Int -> Opt -> ShowS show :: Opt -> String showList :: [Opt] -> ShowS
Generic Opt Source #
Instance details Defined in Text.Pandoc.App.Opt Associated Types type Rep Opt :: Type -> Type Methods from :: Opt -> Rep Opt x to :: Rep Opt x -> Opt
FromJSON Opt Source #
Instance details Defined in Text.Pandoc.App.Opt Methods parseJSON :: Value -> Parser Opt parseJSONList :: Value -> Parser [Opt]
ToJSON Opt Source #
Instance details Defined in Text.Pandoc.App.Opt Methods toJSON :: Opt -> Value toEncoding :: Opt -> Encoding toJSONList :: [Opt] -> Value toEncodingList :: [Opt] -> Encoding
type Rep Opt Source #
Instance details Defined in Text.Pandoc.App.Opt type Rep Opt = D1 (MetaData "Opt" "Text.Pandoc.App.Opt" "pandoc-2.7.3-DE15ah6TH0t2xzy9qLA0Fv" False) (C1 (MetaCons "Opt" PrefixI True) ((((((S1 (MetaSel (Just "optTabStop") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :: S1 (MetaSel (Just "optPreserveTabs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :: (S1 (MetaSel (Just "optStandalone") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "optReader") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)))) :: ((S1 (MetaSel (Just "optWriter") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)) :: S1 (MetaSel (Just "optTableOfContents") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :: (S1 (MetaSel (Just "optBaseHeaderLevel") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :: S1 (MetaSel (Just "optTemplate") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath))))) :: (((S1 (MetaSel (Just "optVariables") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, String)]) :: S1 (MetaSel (Just "optMetadata") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, String)])) :: (S1 (MetaSel (Just "optMetadataFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath)) :: S1 (MetaSel (Just "optOutputFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath)))) :: ((S1 (MetaSel (Just "optInputFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :: S1 (MetaSel (Just "optNumberSections") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :: (S1 (MetaSel (Just "optNumberOffset") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Int]) :: (S1 (MetaSel (Just "optSectionDivs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "optIncremental") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))))) :: ((((S1 (MetaSel (Just "optSelfContained") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "optHtmlQTags") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :: (S1 (MetaSel (Just "optHighlightStyle") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Style)) :: S1 (MetaSel (Just "optSyntaxDefinitions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]))) :: ((S1 (MetaSel (Just "optTopLevelDivision") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TopLevelDivision) :: S1 (MetaSel (Just "optHTMLMathMethod") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HTMLMathMethod)) :: (S1 (MetaSel (Just "optAbbreviations") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath)) :: S1 (MetaSel (Just "optReferenceDoc") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath))))) :: (((S1 (MetaSel (Just "optEpubSubdirectory") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :: S1 (MetaSel (Just "optEpubMetadata") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath))) :: (S1 (MetaSel (Just "optEpubFonts") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :: S1 (MetaSel (Just "optEpubChapterLevel") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int))) :: ((S1 (MetaSel (Just "optEpubCoverImage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath)) :: S1 (MetaSel (Just "optTOCDepth") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) :: (S1 (MetaSel (Just "optDumpArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: (S1 (MetaSel (Just "optIgnoreArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "optVerbosity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Verbosity))))))) :: (((((S1 (MetaSel (Just "optTrace") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "optLogFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath))) :: (S1 (MetaSel (Just "optFailIfWarnings") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "optReferenceLinks") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))) :: ((S1 (MetaSel (Just "optReferenceLocation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ReferenceLocation) :: S1 (MetaSel (Just "optDpi") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) :: (S1 (MetaSel (Just "optWrapText") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 WrapOption) :: S1 (MetaSel (Just "optColumns") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))) :: (((S1 (MetaSel (Just "optFilters") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Filter]) :: S1 (MetaSel (Just "optEmailObfuscation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ObfuscationMethod)) :: (S1 (MetaSel (Just "optIdentifierPrefix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :: S1 (MetaSel (Just "optStripEmptyParagraphs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))) :: ((S1 (MetaSel (Just "optIndentedCodeClasses") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :: S1 (MetaSel (Just "optDataDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath))) :: (S1 (MetaSel (Just "optCiteMethod") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CiteMethod) :: (S1 (MetaSel (Just "optListings") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "optPdfEngine") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String))))))) :: ((((S1 (MetaSel (Just "optPdfEngineArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :: S1 (MetaSel (Just "optSlideLevel") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) :: (S1 (MetaSel (Just "optSetextHeaders") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "optAscii") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))) :: ((S1 (MetaSel (Just "optDefaultImageExtension") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :: S1 (MetaSel (Just "optExtractMedia") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath))) :: (S1 (MetaSel (Just "optTrackChanges") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TrackChanges) :: (S1 (MetaSel (Just "optFileScope") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "optTitlePrefix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)))))) :: (((S1 (MetaSel (Just "optCss") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :: S1 (MetaSel (Just "optIpynbOutput") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :: (S1 (MetaSel (Just "optIncludeBeforeBody") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :: S1 (MetaSel (Just "optIncludeAfterBody") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]))) :: ((S1 (MetaSel (Just "optIncludeInHeader") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :: S1 (MetaSel (Just "optResourcePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])) :: (S1 (MetaSel (Just "optRequestHeaders") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, String)]) :: (S1 (MetaSel (Just "optEol") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 LineEnding) :: S1 (MetaSel (Just "optStripComments") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))))))))

data LineEnding Source #

The type of line-endings to be used when writing plain-text.

Constructors

LF
CRLF
Native

Instances

Show LineEnding Source #
Instance details Defined in Text.Pandoc.App.Opt Methods showsPrec :: Int -> LineEnding -> ShowS show :: LineEnding -> String showList :: [LineEnding] -> ShowS
Generic LineEnding Source #
Instance details Defined in Text.Pandoc.App.Opt Associated Types type Rep LineEnding :: Type -> Type Methods from :: LineEnding -> Rep LineEnding x to :: Rep LineEnding x -> LineEnding
FromJSON LineEnding Source #
Instance details Defined in Text.Pandoc.App.Opt Methods parseJSON :: Value -> Parser LineEnding parseJSONList :: Value -> Parser [LineEnding]
ToJSON LineEnding Source #
Instance details Defined in Text.Pandoc.App.Opt Methods toJSON :: LineEnding -> Value toEncoding :: LineEnding -> Encoding toJSONList :: [LineEnding] -> Value toEncodingList :: [LineEnding] -> Encoding
type Rep LineEnding Source #
Instance details Defined in Text.Pandoc.App.Opt type Rep LineEnding = D1 (MetaData "LineEnding" "Text.Pandoc.App.Opt" "pandoc-2.7.3-DE15ah6TH0t2xzy9qLA0Fv" False) (C1 (MetaCons "LF" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "CRLF" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Native" PrefixI False) (U1 :: Type -> Type)))

data Filter Source #

Type of filter and path to filter file.

Constructors

LuaFilter FilePath
JSONFilter FilePath

Instances

Show Filter Source #
Instance details Defined in Text.Pandoc.Filter Methods showsPrec :: Int -> Filter -> ShowS show :: Filter -> String showList :: [Filter] -> ShowS
Generic Filter Source #
Instance details Defined in Text.Pandoc.Filter Associated Types type Rep Filter :: Type -> Type Methods from :: Filter -> Rep Filter x to :: Rep Filter x -> Filter
FromJSON Filter Source #
Instance details Defined in Text.Pandoc.Filter Methods parseJSON :: Value -> Parser Filter parseJSONList :: Value -> Parser [Filter]
ToJSON Filter Source #
Instance details Defined in Text.Pandoc.Filter Methods toJSON :: Filter -> Value toEncoding :: Filter -> Encoding toJSONList :: [Filter] -> Value toEncodingList :: [Filter] -> Encoding
type Rep Filter Source #
Instance details Defined in Text.Pandoc.Filter type Rep Filter = D1 (MetaData "Filter" "Text.Pandoc.Filter" "pandoc-2.7.3-DE15ah6TH0t2xzy9qLA0Fv" False) (C1 (MetaCons "LuaFilter" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :+: C1 (MetaCons "JSONFilter" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)))

defaultOpts :: Opt Source #

Defaults for command-line options.

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

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

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

applyFilters :: ReaderOptions -> [Filter] -> [String] -> Pandoc -> PandocIO Pandoc Source #

Modify the given document using a filter.