Text.Pandoc.Filter

Programmatically modifications of pandoc documents.

Documentation

data Filter

Type of filter and path to filter file.

Constructors

LuaFilter FilePath

JSONFilter FilePath

CiteprocFilter

Instances

FromJSON Filter

Defined in Text.Pandoc.Filter

Methods

parseJSON :: Value -> Parser Filter

parseJSONList :: Value -> Parser [Filter]

omittedField :: Maybe Filter

ToJSON Filter

Defined in Text.Pandoc.Filter

Methods

toJSON :: Filter -> Value

toEncoding :: Filter -> Encoding

toJSONList :: [Filter] -> Value

toEncodingList :: [Filter] -> Encoding

omitField :: Filter -> Bool

Generic Filter

Defined in Text.Pandoc.Filter

Associated Types

type Rep Filter :: Type -> Type

Methods

from :: Filter -> Rep Filter x

to :: Rep Filter x -> Filter

Show Filter

Defined in Text.Pandoc.Filter

Methods

showsPrec :: Int -> Filter -> ShowS

show :: Filter -> String

showList :: [Filter] -> ShowS

type Rep Filter

Defined in Text.Pandoc.Filter

type Rep Filter = D1 ('MetaData "Filter" "Text.Pandoc.Filter" "pandoc-3.2.1-I5S7xLkxSFnKjd9CAMtVvj" '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

Environment in which a filter is run. This includes reader and writer options.

Constructors

Environment

Fields

• envReaderOptions :: ReaderOptions
• envWriterOptions :: WriterOptions

Instances

Default Environment

Defined in Text.Pandoc.Filter.Environment

Methods

def :: Environment

applyFilters :: (PandocMonad m, MonadIO m) => ScriptingEngine -> Environment -> [Filter] -> [String] -> Pandoc -> m Pandoc

Modify the given document using a filter.

applyJSONFilter :: MonadIO m => Environment -> [String] -> FilePath -> Pandoc -> m Pandoc