Hakyll.Web.Template.Internal

Documentation

data Template

Datatype used for template substitutions.

Constructors

Template

Fields

• tplElements :: [TemplateElement]
• tplOrigin :: FilePath

Instances

Eq Template

Defined in Hakyll.Web.Template.Internal

Methods

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

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

Show Template

Defined in Hakyll.Web.Template.Internal

Methods

showsPrec :: Int -> Template -> ShowS

show :: Template -> String

showList :: [Template] -> ShowS

IsString Template

Defined in Hakyll.Web.Template.Internal

Methods

fromString :: String -> Template

Generic Template

Defined in Hakyll.Web.Template.Internal

Associated Types

type Rep Template :: Type -> Type

Methods

from :: Template -> Rep Template x

to :: Rep Template x -> Template

Binary Template

Defined in Hakyll.Web.Template.Internal

Methods

put :: Template -> Put

get :: Get Template

putList :: [Template] -> Put

Writable Template

Defined in Hakyll.Web.Template.Internal

Methods

write :: FilePath -> Item Template -> IO ()

type Rep Template

Defined in Hakyll.Web.Template.Internal

type Rep Template = D1 ('MetaData "Template" "Hakyll.Web.Template.Internal" "hakyll-4.15.1.1-3pKIj5tDqpB5qVmLcBa1rB" 'False) (C1 ('MetaCons "Template" 'PrefixI 'True) (S1 ('MetaSel ('Just "tplElements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TemplateElement]) :*: S1 ('MetaSel ('Just "tplOrigin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)))

template :: FilePath -> [TemplateElement] -> Template

Wrap the constructor to ensure trim is called.

templateBodyCompiler :: Compiler (Item Template)

Read a template, without metadata header

templateCompiler :: Compiler (Item Template)

Read complete file contents as a template

applyTemplate

Arguments

:: Template

Template

-> Context a

Context

-> Item a

Page

-> Compiler (Item String)

Resulting item

Interpolate template expressions from context values in a page

loadAndApplyTemplate

Arguments

:: Identifier

Template identifier

-> Context a

Context

-> Item a

Page

-> Compiler (Item String)

Resulting item

The following pattern is so common:

tpl <- loadBody "templates/foo.html"
someCompiler
    >>= applyTemplate tpl context

That we have a single function which does this:

someCompiler
    >>= loadAndApplyTemplate "templates/foo.html" context

applyAsTemplate

Arguments

:: Context String

Context

-> Item String

Item and template

-> Compiler (Item String)

Resulting item

It is also possible that you want to substitute $key$s within the body of an item. This function does that by interpreting the item body as a template, and then applying it to itself.

readTemplate :: String -> Template

Deprecated: Use templateCompiler instead

Parse a string into a template. You should prefer compileTemplateItem over this.

compileTemplateItem :: Item String -> Compiler Template

Parse an item body into a template. Provides useful error messages in the Compiler monad.

unsafeReadTemplateFile :: FilePath -> Compiler Template

Deprecated: Use templateCompiler

module Hakyll.Web.Template.Internal.Element

module Hakyll.Web.Template.Internal.Trim