Text.Pandoc.Templates

Utility functions for working with pandoc templates.

Documentation

data Template a

A template.

Instances

Functor Template

Defined in Text.DocTemplates.Internal

Methods

fmap :: (a -> b) -> Template a -> Template b

(<$) :: a -> Template b -> Template a

Foldable Template

Defined in Text.DocTemplates.Internal

Methods

fold :: Monoid m => Template m -> m

foldMap :: Monoid m => (a -> m) -> Template a -> m

foldMap' :: Monoid m => (a -> m) -> Template a -> m

foldr :: (a -> b -> b) -> b -> Template a -> b

foldr' :: (a -> b -> b) -> b -> Template a -> b

foldl :: (b -> a -> b) -> b -> Template a -> b

foldl' :: (b -> a -> b) -> b -> Template a -> b

foldr1 :: (a -> a -> a) -> Template a -> a

foldl1 :: (a -> a -> a) -> Template a -> a

toList :: Template a -> [a]

null :: Template a -> Bool

length :: Template a -> Int

elem :: Eq a => a -> Template a -> Bool

maximum :: Ord a => Template a -> a

minimum :: Ord a => Template a -> a

sum :: Num a => Template a -> a

product :: Num a => Template a -> a

Traversable Template

Defined in Text.DocTemplates.Internal

Methods

traverse :: Applicative f => (a -> f b) -> Template a -> f (Template b)

sequenceA :: Applicative f => Template (f a) -> f (Template a)

mapM :: Monad m => (a -> m b) -> Template a -> m (Template b)

sequence :: Monad m => Template (m a) -> m (Template a)

Eq a => Eq (Template a)

Defined in Text.DocTemplates.Internal

Methods

(==) :: Template a -> Template a -> Bool

(/=) :: Template a -> Template a -> Bool

Data a => Data (Template a)

Defined in Text.DocTemplates.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Template a -> c (Template a)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Template a)

toConstr :: Template a -> Constr

dataTypeOf :: Template a -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Template a))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Template a))

gmapT :: (forall b. Data b => b -> b) -> Template a -> Template a

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Template a -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Template a -> r

gmapQ :: (forall d. Data d => d -> u) -> Template a -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Template a -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Template a -> m (Template a)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Template a -> m (Template a)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Template a -> m (Template a)

Ord a => Ord (Template a)

Defined in Text.DocTemplates.Internal

Methods

compare :: Template a -> Template a -> Ordering

(<) :: Template a -> Template a -> Bool

(<=) :: Template a -> Template a -> Bool

(>) :: Template a -> Template a -> Bool

(>=) :: Template a -> Template a -> Bool

max :: Template a -> Template a -> Template a

min :: Template a -> Template a -> Template a

Read a => Read (Template a)

Defined in Text.DocTemplates.Internal

Methods

readsPrec :: Int -> ReadS (Template a)

readList :: ReadS [Template a]

readPrec :: ReadPrec (Template a)

readListPrec :: ReadPrec [Template a]

Show a => Show (Template a)

Defined in Text.DocTemplates.Internal

Methods

showsPrec :: Int -> Template a -> ShowS

show :: Template a -> String

showList :: [Template a] -> ShowS

Generic (Template a)

Defined in Text.DocTemplates.Internal

Associated Types

type Rep (Template a) :: Type -> Type

Methods

from :: Template a -> Rep (Template a) x

to :: Rep (Template a) x -> Template a

Semigroup a => Semigroup (Template a)

Defined in Text.DocTemplates.Internal

Methods

(<>) :: Template a -> Template a -> Template a

sconcat :: NonEmpty (Template a) -> Template a

stimes :: Integral b => b -> Template a -> Template a

Semigroup a => Monoid (Template a)

Defined in Text.DocTemplates.Internal

Methods

mempty :: Template a

mappend :: Template a -> Template a -> Template a

mconcat :: [Template a] -> Template a

type Rep (Template a)

Defined in Text.DocTemplates.Internal

type Rep (Template a) = D1 ('MetaData "Template" "Text.DocTemplates.Internal" "doctemplates-0.10-1uHdo3kF1HeGMJUbuDAqil" 'False) (((C1 ('MetaCons "Interpolate" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Variable)) :+: C1 ('MetaCons "Conditional" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Variable) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a))))) :+: (C1 ('MetaCons "Iterate" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Variable) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a)))) :+: C1 ('MetaCons "Nested" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a))))) :+: ((C1 ('MetaCons "Partial" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Pipe]) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a))) :+: C1 ('MetaCons "Literal" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Doc a)))) :+: (C1 ('MetaCons "Concat" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a))) :+: C1 ('MetaCons "Empty" 'PrefixI 'False) (U1 :: Type -> Type))))

newtype WithDefaultPartials m a

Wrap a Monad in this if you want partials to be taken only from the default data files.

Constructors

WithDefaultPartials

Fields

• runWithDefaultPartials :: m a

Instances

Monad m => Monad (WithDefaultPartials m)

Defined in Text.Pandoc.Templates

Methods

(>>=) :: WithDefaultPartials m a -> (a -> WithDefaultPartials m b) -> WithDefaultPartials m b

(>>) :: WithDefaultPartials m a -> WithDefaultPartials m b -> WithDefaultPartials m b

return :: a -> WithDefaultPartials m a

Functor m => Functor (WithDefaultPartials m)

Defined in Text.Pandoc.Templates

Methods

fmap :: (a -> b) -> WithDefaultPartials m a -> WithDefaultPartials m b

(<$) :: a -> WithDefaultPartials m b -> WithDefaultPartials m a

Applicative m => Applicative (WithDefaultPartials m)

Defined in Text.Pandoc.Templates

Methods

pure :: a -> WithDefaultPartials m a

(<*>) :: WithDefaultPartials m (a -> b) -> WithDefaultPartials m a -> WithDefaultPartials m b

liftA2 :: (a -> b -> c) -> WithDefaultPartials m a -> WithDefaultPartials m b -> WithDefaultPartials m c

(*>) :: WithDefaultPartials m a -> WithDefaultPartials m b -> WithDefaultPartials m b

(<*) :: WithDefaultPartials m a -> WithDefaultPartials m b -> WithDefaultPartials m a

PandocMonad m => TemplateMonad (WithDefaultPartials m)

Defined in Text.Pandoc.Templates

Methods

getPartial :: FilePath -> WithDefaultPartials m Text

newtype WithPartials m a

Wrap a Monad in this if you want partials to be looked for locally (or, when the main template is at a URL, via HTTP), falling back to default data files.

Constructors

WithPartials

Fields

• runWithPartials :: m a

Instances

Monad m => Monad (WithPartials m)

Defined in Text.Pandoc.Templates

Methods

(>>=) :: WithPartials m a -> (a -> WithPartials m b) -> WithPartials m b

(>>) :: WithPartials m a -> WithPartials m b -> WithPartials m b

return :: a -> WithPartials m a

Functor m => Functor (WithPartials m)

Defined in Text.Pandoc.Templates

Methods

fmap :: (a -> b) -> WithPartials m a -> WithPartials m b

(<$) :: a -> WithPartials m b -> WithPartials m a

Applicative m => Applicative (WithPartials m)

Defined in Text.Pandoc.Templates

Methods

pure :: a -> WithPartials m a

(<*>) :: WithPartials m (a -> b) -> WithPartials m a -> WithPartials m b

liftA2 :: (a -> b -> c) -> WithPartials m a -> WithPartials m b -> WithPartials m c

(*>) :: WithPartials m a -> WithPartials m b -> WithPartials m b

(<*) :: WithPartials m a -> WithPartials m b -> WithPartials m a

PandocMonad m => TemplateMonad (WithPartials m)

Defined in Text.Pandoc.Templates

Methods

getPartial :: FilePath -> WithPartials m Text

compileTemplate :: (TemplateMonad m, TemplateTarget a) => FilePath -> Text -> m (Either String (Template a))

Compile a template. The FilePath parameter is used to determine a default path and extension for partials and may be left empty if partials are not used.

renderTemplate :: (TemplateTarget a, ToContext a b) => Template a -> b -> Doc a

Render a compiled template in a "context" which provides values for the template's variables.

getTemplate :: PandocMonad m => FilePath -> m Text

Retrieve text for a template.

getDefaultTemplate

Arguments

:: PandocMonad m

=> Text

Name of writer

-> m Text

Get default template for the specified writer.

compileDefaultTemplate :: PandocMonad m => Text -> m (Template Text)

Get and compile default template for the specified writer. Raise an error on compilation failure.