Text.Pandoc.Templates

A simple templating system with variable substitution and conditionals.

Documentation

applyTemplate :: (ToJSON a, TemplateTarget b) => Text -> a -> Either String b

Combines renderTemplate and compileTemplate.

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

Render a compiled template using context to resolve variables.

compileTemplate :: Text -> Either String Template

Compile a template.

varListToJSON :: [(String, String)] -> Value

A convenience function for passing in an association list of string values instead of a JSON Value.

data Template

A Template is essentially a function that takes a JSON Value and produces Text.

Instances

Semigroup Template

Defined in Text.DocTemplates

Methods

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

sconcat :: NonEmpty Template -> Template

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

Monoid Template

Defined in Text.DocTemplates

Methods

mempty :: Template

mappend :: Template -> Template -> Template

mconcat :: [Template] -> Template

class TemplateTarget a

Minimal complete definition

toTarget

Instances

TemplateTarget String

Defined in Text.DocTemplates

Methods

toTarget :: Text -> String

TemplateTarget ByteString

Defined in Text.DocTemplates

Methods

toTarget :: Text -> ByteString

TemplateTarget Text

Defined in Text.DocTemplates

Methods

toTarget :: Text -> Text

TemplateTarget Html

Defined in Text.DocTemplates

Methods

toTarget :: Text -> Html

renderTemplate' :: (PandocMonad m, ToJSON a, TemplateTarget b) => String -> a -> m b

Like applyTemplate, but runs in PandocMonad and raises an error if compilation fails.

getDefaultTemplate

Arguments

:: PandocMonad m

=> String

Name of writer

-> m String

Get default template for the specified writer.