Copyright | Copyright (C) 2006-2024 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 :: ScriptingEngine -> Opt -> IO ()
- handleOptInfo :: ScriptingEngine -> OptInfo -> IO ()
- data Opt = Opt {
- optTabStop :: Int
- optPreserveTabs :: Bool
- optStandalone :: Bool
- optFrom :: Maybe Text
- optTo :: Maybe Text
- optTableOfContents :: Bool
- optShiftHeadingLevelBy :: Int
- optTemplate :: Maybe FilePath
- optVariables :: Context Text
- optMetadata :: Meta
- optMetadataFiles :: [FilePath]
- optOutputFile :: Maybe FilePath
- optInputFiles :: Maybe [FilePath]
- optNumberSections :: Bool
- optNumberOffset :: [Int]
- optSectionDivs :: Bool
- optIncremental :: Bool
- optSelfContained :: Bool
- optEmbedResources :: Bool
- optHtmlQTags :: Bool
- optHighlightStyle :: Maybe Text
- optSyntaxDefinitions :: [FilePath]
- optTopLevelDivision :: TopLevelDivision
- optHTMLMathMethod :: HTMLMathMethod
- optAbbreviations :: Maybe FilePath
- optReferenceDoc :: Maybe FilePath
- optSplitLevel :: Int
- optChunkTemplate :: Maybe Text
- optEpubSubdirectory :: String
- optEpubMetadata :: Maybe FilePath
- optEpubFonts :: [FilePath]
- optEpubCoverImage :: Maybe FilePath
- optEpubTitlePage :: Bool
- optTOCDepth :: Int
- optDumpArgs :: Bool
- optIgnoreArgs :: Bool
- optVerbosity :: Verbosity
- optTrace :: Bool
- optLogFile :: Maybe FilePath
- optFailIfWarnings :: Bool
- optReferenceLinks :: Bool
- optReferenceLocation :: ReferenceLocation
- optDpi :: Int
- optWrap :: WrapOption
- optColumns :: Int
- optFilters :: [Filter]
- optEmailObfuscation :: ObfuscationMethod
- optIdentifierPrefix :: Text
- optIndentedCodeClasses :: [Text]
- optDataDir :: Maybe FilePath
- optCiteMethod :: CiteMethod
- optListings :: Bool
- optPdfEngine :: Maybe String
- optPdfEngineOpts :: [String]
- optSlideLevel :: Maybe Int
- optSetextHeaders :: Bool
- optListTables :: Bool
- optAscii :: Bool
- optDefaultImageExtension :: Text
- optExtractMedia :: Maybe FilePath
- optTrackChanges :: TrackChanges
- optFileScope :: Bool
- optTitlePrefix :: Maybe Text
- optCss :: [FilePath]
- optIpynbOutput :: IpynbOutput
- optIncludeBeforeBody :: [FilePath]
- optIncludeAfterBody :: [FilePath]
- optIncludeInHeader :: [FilePath]
- optResourcePath :: [FilePath]
- optRequestHeaders :: [(Text, Text)]
- optNoCheckCertificate :: Bool
- optEol :: LineEnding
- optStripComments :: Bool
- optCSL :: Maybe FilePath
- optBibliography :: [FilePath]
- optCitationAbbreviations :: Maybe FilePath
- optSandbox :: Bool
- data OptInfo
- = BashCompletion
- | ListInputFormats
- | ListOutputFormats
- | ListExtensions (Maybe Text)
- | ListHighlightLanguages
- | ListHighlightStyles
- | PrintDefaultTemplate (Maybe FilePath) Text
- | PrintDefaultDataFile (Maybe FilePath) Text
- | PrintHighlightStyle (Maybe FilePath) Text
- | VersionInfo
- | Help
- | OptError PandocError
- data LineEnding
- data IpynbOutput
- data Filter
- = LuaFilter FilePath
- | JSONFilter FilePath
- defaultOpts :: Opt
- parseOptions :: [OptDescr (Opt -> ExceptT OptInfo IO Opt)] -> Opt -> IO (Either OptInfo Opt)
- parseOptionsFromArgs :: [OptDescr (Opt -> ExceptT OptInfo IO Opt)] -> Opt -> String -> [String] -> IO (Either OptInfo Opt)
- options :: [OptDescr (Opt -> ExceptT OptInfo IO Opt)]
- applyFilters :: (PandocMonad m, MonadIO m) => ScriptingEngine -> Environment -> [Filter] -> [String] -> Pandoc -> m Pandoc
Documentation
convertWithOpts :: ScriptingEngine -> Opt -> IO () Source #
handleOptInfo :: ScriptingEngine -> OptInfo -> IO () Source #
React to an OptInfo
by printing the requested information
and exiting or (if there was a parsing error) raising an error.
Data structure for command line options.
Constructors
Opt | |
Fields
|
Instances
FromJSON Opt Source # | |||||
Defined in Text.Pandoc.App.Opt Methods parseJSON :: Value -> Parser Opt parseJSONList :: Value -> Parser [Opt] omittedField :: Maybe Opt | |||||
ToJSON Opt Source # | |||||
Defined in Text.Pandoc.App.Opt | |||||
Generic Opt Source # | |||||
Defined in Text.Pandoc.App.Opt Associated Types
| |||||
Show Opt Source # | |||||
FromJSON (Opt -> Opt) Source # | |||||
Defined in Text.Pandoc.App.Opt Methods parseJSON :: Value -> Parser (Opt -> Opt) parseJSONList :: Value -> Parser [Opt -> Opt] omittedField :: Maybe (Opt -> Opt) | |||||
type Rep Opt Source # | |||||
Defined in Text.Pandoc.App.Opt type Rep Opt = D1 ('MetaData "Opt" "Text.Pandoc.App.Opt" "pandoc-3.2-Ep7nD1upkrK3zzBEgrEbVv" '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 "optFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "optTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "optTableOfContents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "optShiftHeadingLevelBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: (S1 ('MetaSel ('Just "optTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 ('MetaSel ('Just "optVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Context Text)))))) :*: (((S1 ('MetaSel ('Just "optMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Meta) :*: S1 ('MetaSel ('Just "optMetadataFiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath])) :*: (S1 ('MetaSel ('Just "optOutputFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :*: (S1 ('MetaSel ('Just "optInputFiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [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 "optEmbedResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))))) :*: ((((S1 ('MetaSel ('Just "optHtmlQTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "optHighlightStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (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 "optSplitLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "optChunkTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))) :*: (((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 "optEpubCoverImage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 ('MetaSel ('Just "optEpubTitlePage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))) :*: ((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 "optWrap") '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 Text) :*: S1 ('MetaSel ('Just "optIndentedCodeClasses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])) :*: (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 "optPdfEngineOpts") '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 "optListTables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))))) :*: ((((S1 ('MetaSel ('Just "optAscii") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "optDefaultImageExtension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (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 Text)) :*: S1 ('MetaSel ('Just "optCss") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath])) :*: (S1 ('MetaSel ('Just "optIpynbOutput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IpynbOutput) :*: (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 [(Text, Text)]) :*: (S1 ('MetaSel ('Just "optNoCheckCertificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "optEol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LineEnding)))) :*: ((S1 ('MetaSel ('Just "optStripComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "optCSL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath))) :*: (S1 ('MetaSel ('Just "optBibliography") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath]) :*: (S1 ('MetaSel ('Just "optCitationAbbreviations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 ('MetaSel ('Just "optSandbox") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))))))) |
Option parser results requesting informational output.
Constructors
BashCompletion | |
ListInputFormats | |
ListOutputFormats | |
ListExtensions (Maybe Text) | |
ListHighlightLanguages | |
ListHighlightStyles | |
PrintDefaultTemplate (Maybe FilePath) Text | |
PrintDefaultDataFile (Maybe FilePath) Text | |
PrintHighlightStyle (Maybe FilePath) Text | |
VersionInfo | |
Help | |
OptError PandocError |
Instances
Generic OptInfo Source # | |||||
Defined in Text.Pandoc.App.Opt Associated Types
| |||||
Show OptInfo Source # | |||||
type Rep OptInfo Source # | |||||
Defined in Text.Pandoc.App.Opt type Rep OptInfo = D1 ('MetaData "OptInfo" "Text.Pandoc.App.Opt" "pandoc-3.2-Ep7nD1upkrK3zzBEgrEbVv" 'False) (((C1 ('MetaCons "BashCompletion" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ListInputFormats" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ListOutputFormats" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "ListExtensions" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :+: (C1 ('MetaCons "ListHighlightLanguages" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ListHighlightStyles" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "PrintDefaultTemplate" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "PrintDefaultDataFile" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "PrintHighlightStyle" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) :+: (C1 ('MetaCons "VersionInfo" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Help" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OptError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PandocError)))))) |
data LineEnding Source #
The type of line-endings to be used when writing plain-text.
Instances
FromJSON LineEnding Source # | |||||
Defined in Text.Pandoc.App.Opt Methods parseJSON :: Value -> Parser LineEnding parseJSONList :: Value -> Parser [LineEnding] omittedField :: Maybe LineEnding | |||||
ToJSON LineEnding Source # | |||||
Defined in Text.Pandoc.App.Opt Methods toJSON :: LineEnding -> Value toEncoding :: LineEnding -> Encoding toJSONList :: [LineEnding] -> Value toEncodingList :: [LineEnding] -> Encoding omitField :: LineEnding -> Bool | |||||
Generic LineEnding Source # | |||||
Defined in Text.Pandoc.App.Opt Associated Types
| |||||
Show LineEnding Source # | |||||
Defined in Text.Pandoc.App.Opt Methods showsPrec :: Int -> LineEnding -> ShowS show :: LineEnding -> String showList :: [LineEnding] -> ShowS | |||||
type Rep LineEnding Source # | |||||
Defined in Text.Pandoc.App.Opt type Rep LineEnding = D1 ('MetaData "LineEnding" "Text.Pandoc.App.Opt" "pandoc-3.2-Ep7nD1upkrK3zzBEgrEbVv" '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 IpynbOutput Source #
How to handle output blocks in ipynb.
Constructors
IpynbOutputAll | |
IpynbOutputNone | |
IpynbOutputBest |
Instances
FromJSON IpynbOutput Source # | |||||
Defined in Text.Pandoc.App.Opt Methods parseJSON :: Value -> Parser IpynbOutput parseJSONList :: Value -> Parser [IpynbOutput] omittedField :: Maybe IpynbOutput | |||||
ToJSON IpynbOutput Source # | |||||
Defined in Text.Pandoc.App.Opt Methods toJSON :: IpynbOutput -> Value toEncoding :: IpynbOutput -> Encoding toJSONList :: [IpynbOutput] -> Value toEncodingList :: [IpynbOutput] -> Encoding omitField :: IpynbOutput -> Bool | |||||
Generic IpynbOutput Source # | |||||
Defined in Text.Pandoc.App.Opt Associated Types
| |||||
Show IpynbOutput Source # | |||||
Defined in Text.Pandoc.App.Opt Methods showsPrec :: Int -> IpynbOutput -> ShowS show :: IpynbOutput -> String showList :: [IpynbOutput] -> ShowS | |||||
type Rep IpynbOutput Source # | |||||
Defined in Text.Pandoc.App.Opt type Rep IpynbOutput = D1 ('MetaData "IpynbOutput" "Text.Pandoc.App.Opt" "pandoc-3.2-Ep7nD1upkrK3zzBEgrEbVv" 'False) (C1 ('MetaCons "IpynbOutputAll" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "IpynbOutputNone" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IpynbOutputBest" 'PrefixI 'False) (U1 :: Type -> Type))) |
Type of filter and path to filter file.
Constructors
LuaFilter FilePath | |
JSONFilter FilePath |
Instances
FromJSON Filter Source # | |||||
Defined in Text.Pandoc.Filter Methods parseJSON :: Value -> Parser Filter parseJSONList :: Value -> Parser [Filter] omittedField :: Maybe Filter | |||||
ToJSON Filter Source # | |||||
Defined in Text.Pandoc.Filter Methods toEncoding :: Filter -> Encoding toJSONList :: [Filter] -> Value toEncodingList :: [Filter] -> Encoding | |||||
Generic Filter Source # | |||||
Defined in Text.Pandoc.Filter Associated Types
| |||||
Show Filter Source # | |||||
type Rep Filter Source # | |||||
Defined in Text.Pandoc.Filter type Rep Filter = D1 ('MetaData "Filter" "Text.Pandoc.Filter" "pandoc-3.2-Ep7nD1upkrK3zzBEgrEbVv" '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)) :+: C1 ('MetaCons "CiteprocFilter" 'PrefixI 'False) (U1 :: Type -> Type))) |
defaultOpts :: Opt Source #
Defaults for command-line options.
parseOptions :: [OptDescr (Opt -> ExceptT OptInfo IO Opt)] -> Opt -> IO (Either OptInfo Opt) Source #
parseOptionsFromArgs :: [OptDescr (Opt -> ExceptT OptInfo IO Opt)] -> Opt -> String -> [String] -> IO (Either OptInfo Opt) Source #
options :: [OptDescr (Opt -> ExceptT OptInfo IO Opt)] Source #
A list of functions, each transforming the options data structure in response to a command-line option.
applyFilters :: (PandocMonad m, MonadIO m) => ScriptingEngine -> Environment -> [Filter] -> [String] -> Pandoc -> m Pandoc Source #
Modify the given document using a filter.