| 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
- 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 () #
Data structure for command line options.
Constructors
| Opt | |
Fields
| |
Instances
data LineEnding #
The type of line-endings to be used when writing plain-text.
Instances
| Show LineEnding # | |
Defined in Text.Pandoc.App.Opt Methods showsPrec :: Int -> LineEnding -> ShowS # show :: LineEnding -> String # showList :: [LineEnding] -> ShowS # | |
| Generic LineEnding # | |
Defined in Text.Pandoc.App.Opt Associated Types type Rep LineEnding :: Type -> Type # | |
| ToJSON LineEnding # | |
Defined in Text.Pandoc.App.Opt Methods toJSON :: LineEnding -> Value # toEncoding :: LineEnding -> Encoding # toJSONList :: [LineEnding] -> Value # toEncodingList :: [LineEnding] -> Encoding # | |
| FromJSON LineEnding # | |
Defined in Text.Pandoc.App.Opt | |
| type Rep LineEnding # | |
Defined in Text.Pandoc.App.Opt | |
Type of filter and path to filter file.
Constructors
| LuaFilter FilePath | |
| JSONFilter FilePath |
Instances
| Show Filter # | |
| Generic Filter # | |
| ToJSON Filter # | |
Defined in Text.Pandoc.Filter | |
| FromJSON Filter # | |
| type Rep Filter # | |
Defined in Text.Pandoc.Filter type Rep Filter = D1 (MetaData "Filter" "Text.Pandoc.Filter" "pandoc-2.6-ITNphOjEE7b8SFJyDGgyvD" 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 #
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.
applyFilters :: ReaderOptions -> [Filter] -> [String] -> Pandoc -> PandocIO Pandoc #
Modify the given document using a filter.