Modulepandoc-3.12

Text.Pandoc.Templates

Synopsis

value renderTemplate
value compileTemplate
value compileDefaultTemplate
value getDefaultTemplate
value getTemplate
data Template
newtype WithDefaultPartials
newtype WithPartials

Packagepandoc-3.12
Exports8
LicenceGPL-2.0-or-later
SourceInternal.hs

valuerenderTemplate

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

Source#

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

valuecompileTemplate

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

Source#

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.

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

valuegetDefaultTemplate :: PandocMonad m => Text -> m Text

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

datadata Template a

Source#

A template.

Instances12Functor, Foldable, Traversable, Eq, Data, Ord, …

Functor TemplateDefined in doctemplates-0.11.1 · Text.DocTemplates.Internal
Foldable TemplateDefined in doctemplates-0.11.1 · Text.DocTemplates.Internal
Traversable TemplateDefined in doctemplates-0.11.1 · Text.DocTemplates.Internal
Eq a => Eq (Template a)Defined in doctemplates-0.11.1 · Text.DocTemplates.Internal
Data a => Data (Template a)Defined in doctemplates-0.11.1 · Text.DocTemplates.Internal
Ord a => Ord (Template a)Defined in doctemplates-0.11.1 · Text.DocTemplates.Internal
Read a => Read (Template a)Defined in doctemplates-0.11.1 · Text.DocTemplates.Internal
Show a => Show (Template a)Defined in doctemplates-0.11.1 · Text.DocTemplates.Internal
Generic (Template a)Defined in doctemplates-0.11.1 · Text.DocTemplates.Internal
Semigroup a => Semigroup (Template a)Defined in doctemplates-0.11.1 · Text.DocTemplates.Internal
Semigroup a => Monoid (Template a)Defined in doctemplates-0.11.1 · Text.DocTemplates.Internal
type Rep (Template a) = D1 ('MetaData "Template" "Text.DocTemplates.Internal" "doctemplates-0.11.1-9vwTVmpBbnZC5t9RN0nhSv" 'False) (((C1 ('MetaCons "Interpolate" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Variable)) :+: C1 ('MetaCons "Conditional" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Variable) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a))))) :+: (C1 ('MetaCons "Iterate" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Variable) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a)))) :+: C1 ('MetaCons "Nested" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a))))) :+: ((C1 ('MetaCons "Partial" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Pipe]) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a))) :+: C1 ('MetaCons "Literal" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Doc a)))) :+: (C1 ('MetaCons "Concat" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a))) :+: C1 ('MetaCons "Empty" 'PrefixI 'False) U1)))Defined in doctemplates-0.11.1 · Text.DocTemplates.Internal

newtypenewtype WithDefaultPartials (m :: Type -> Type) a

Constructors

WithDefaultPartials
- runWithDefaultPartials :: m a

Instances4Monad, Functor, Applicative, TemplateMonad

Monad m => Monad (WithDefaultPartials m)Defined in pandoc-3.12 · Text.Pandoc.Templates
Functor m => Functor (WithDefaultPartials m)Defined in pandoc-3.12 · Text.Pandoc.Templates
Applicative m => Applicative (WithDefaultPartials m)Defined in pandoc-3.12 · Text.Pandoc.Templates
PandocMonad m => TemplateMonad (WithDefaultPartials m)Defined in pandoc-3.12 · Text.Pandoc.Templates

newtypenewtype WithPartials (m :: Type -> Type) a

Constructors

WithPartials
- runWithPartials :: m a

Instances4Monad, Functor, Applicative, TemplateMonad

Monad m => Monad (WithPartials m)Defined in pandoc-3.12 · Text.Pandoc.Templates
Functor m => Functor (WithPartials m)Defined in pandoc-3.12 · Text.Pandoc.Templates
Applicative m => Applicative (WithPartials m)Defined in pandoc-3.12 · Text.Pandoc.Templates
PandocMonad m => TemplateMonad (WithPartials m)Defined in pandoc-3.12 · Text.Pandoc.Templates