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.Filter
Description
Programmatically modifications of pandoc documents.
Synopsis
- data Filter
- = LuaFilter FilePath
- | JSONFilter FilePath
- | CiteprocFilter
- data Environment = Environment {}
- applyFilters :: (PandocMonad m, MonadIO m) => ScriptingEngine -> Environment -> [Filter] -> [String] -> Pandoc -> m Pandoc
- applyJSONFilter :: MonadIO m => Environment -> [String] -> FilePath -> Pandoc -> m Pandoc
Documentation
Type of filter and path to filter file.
Constructors
LuaFilter FilePath | |
JSONFilter FilePath | |
CiteprocFilter |
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))) |
data Environment Source #
Environment in which a filter is run. This includes reader and writer options.
Constructors
Environment | |
Fields |
Instances
Default Environment Source # | |
Defined in Text.Pandoc.Filter.Environment Methods def :: Environment # |
applyFilters :: (PandocMonad m, MonadIO m) => ScriptingEngine -> Environment -> [Filter] -> [String] -> Pandoc -> m Pandoc Source #
Modify the given document using a filter.
applyJSONFilter :: MonadIO m => Environment -> [String] -> FilePath -> Pandoc -> m Pandoc Source #