Copyright | Copyright (C) 2006-2018 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]
- optIncludeBeforeBody :: [FilePath]
- optIncludeAfterBody :: [FilePath]
- optIncludeInHeader :: [FilePath]
- optResourcePath :: [FilePath]
- optRequestHeaders :: [(String, String)]
- optEol :: LineEnding
- optStripComments :: Bool
- data LineEnding
- 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 structure for command line options.
Constructors
Opt | |
Fields
|
Instances
Show Opt Source # | |
Generic Opt Source # | |
FromJSON Opt Source # | |
Defined in Text.Pandoc.App.Opt | |
ToJSON Opt Source # | |
Defined in Text.Pandoc.App.Opt | |
type Rep Opt Source # | |
Defined in Text.Pandoc.App.Opt type Rep Opt = D1 (MetaData "Opt" "Text.Pandoc.App.Opt" "pandoc-2.5-8IppWWeCHn0DBB5KpCvHTk" 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 "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.
Instances
Show LineEnding Source # | |
Defined in Text.Pandoc.App.Opt Methods showsPrec :: Int -> LineEnding -> ShowS show :: LineEnding -> String showList :: [LineEnding] -> ShowS | |
Generic LineEnding Source # | |
Defined in Text.Pandoc.App.Opt Associated Types type Rep LineEnding :: Type -> Type | |
FromJSON LineEnding Source # | |
Defined in Text.Pandoc.App.Opt | |
ToJSON LineEnding Source # | |
Defined in Text.Pandoc.App.Opt Methods toJSON :: LineEnding -> Value toEncoding :: LineEnding -> Encoding toJSONList :: [LineEnding] -> Value toEncodingList :: [LineEnding] -> Encoding | |
type Rep LineEnding Source # | |
Defined in Text.Pandoc.App.Opt type Rep LineEnding = D1 (MetaData "LineEnding" "Text.Pandoc.App.Opt" "pandoc-2.5-8IppWWeCHn0DBB5KpCvHTk" 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))) |
Type of filter and path to filter file.
Constructors
LuaFilter FilePath | |
JSONFilter FilePath |
Instances
Show Filter Source # | |
Generic Filter Source # | |
FromJSON Filter Source # | |
Defined in Text.Pandoc.Filter | |
ToJSON Filter Source # | |
Defined in Text.Pandoc.Filter Methods toEncoding :: Filter -> Encoding toJSONList :: [Filter] -> Value toEncodingList :: [Filter] -> Encoding | |
type Rep Filter Source # | |
Defined in Text.Pandoc.Filter type Rep Filter = D1 (MetaData "Filter" "Text.Pandoc.Filter" "pandoc-2.5-8IppWWeCHn0DBB5KpCvHTk" 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.
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.