pandoc-2.9.2.1: Conversion between markup formats

Copyright | Copyright (C) 2006-2020 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
- applyFilters :: ReaderOptions -> [Filter] -> [String] -> Pandoc -> PandocIO Pandoc

# Documentation

data Filter Source #

Type of filter and path to filter file.

Constructors

LuaFilter FilePath |
JSONFilter FilePath |

#### Instances

Instances details

Show Filter Source # |
Instance details Defined in Text.Pandoc.Filter Methods showsPrec :: Int -> Filter -> ShowS Source # show :: Filter -> String Source # showList :: [Filter] -> ShowS Source #
Generic Filter Source # |
Instance details Defined in Text.Pandoc.Filter Associated Types type Rep Filter :: Type -> Type Source # Methods from :: Filter -> Rep Filter x Source # to :: Rep Filter x -> Filter Source #
FromYAML Filter Source # |
Instance details Defined in Text.Pandoc.Filter Methods parseYAML :: Node Pos -> Parser Filter Source #
ToJSON Filter Source # |
Instance details Defined in Text.Pandoc.Filter Methods toJSON :: Filter -> Value Source # toEncoding :: Filter -> Encoding Source # toJSONList :: [Filter] -> Value Source # toEncodingList :: [Filter] -> Encoding Source #
FromJSON Filter Source # |
Instance details Defined in Text.Pandoc.Filter Methods parseJSON :: Value -> Parser Filter Source # parseJSONList :: Value -> Parser [Filter] Source #
type Rep Filter Source # |

Instance details

Defined in Text.Pandoc.Filter

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

applyFilters :: ReaderOptions -> [Filter] -> [String] -> Pandoc -> PandocIO Pandoc Source #

Modify the given document using a filter.