This module contains the core definitions for the Heist template system.
The Heist template system is based on XML/xhtml. It allows you to build
custom XML-based markup languages. With Heist you can define your own
domain-specific XML tags implemented with Haskell and use them in your
The most important concept in Heist is the Splice. Splices can be thought
of as functions that transform a node into a list of nodes. Heist then
substitutes the resulting list of nodes into your template in place of the
input node. Splice is implemented as a type synonym type Splice m =
TemplateMonad m [Node], and TemplateMonad has a function getParamNode
that lets you get the input node.
Suppose you have a place on your page where you want to display a link with
the text "Logout username" if the user is currently logged in or a link to
the login page if no user is logged in. Assume you have a function
getUser :: MyAppMonad (Maybe ByteString) that gets the current user.
You can implement this functionality with a Splice as follows:
link :: ByteString -> ByteString -> Node
link target text = X.Element "a" [("href", target)] [X.Text text]
loginLink :: Node
loginLink = link "/login" "Login"
logoutLink :: ByteString -> Node
logoutLink user = link "/logout" (B.append "Logout " user)
loginLogoutSplice :: Splice MyAppMonad
loginLogoutSplice = do
user <- lift getUser
return $ [maybe loginLink logoutLink user]
Next, you need to bind that splice to an XML tag. Heist stores information
about splices and templates in the TemplateState data structure. The
following code demonstrates how this splice would be used.
mySplices = [ ("loginLogout", loginLogoutSplice) ]
main = do
ets <- loadTemplates "templates" $
foldr (uncurry bindSplice) emptyTemplateState mySplices
let ts = either error id ets
t <- runMyAppMonad $ renderTemplate ts "index"
print $ maybe "Page not found" id t
Here we build up our TemplateState by starting with emptyTemplateState and
applying bindSplice for all the splices we want to add. Then we pass this
to loadTemplates our final TemplateState wrapped in an Either to handle
errors. Then we use this TemplateState to render our templates.
|Heist templates are XML documents. The hexpat library is polymorphic over
the type of strings, so here we define a Node alias to fix the string
types of the tag names and tag bodies to ByteString.
|A Template is a forest of XML nodes. Here we deviate from the single
root node constraint of well-formed XML because we want to allow templates
to contain fragments of a document that may not have a single root.
|A Splice is a TemplateMonad computation that returns a Template.
|TemplateMonad is the monad used for Splice processing. TemplateMonad
provides "passthrough" instances for many of the monads you might use in
the inner monad.
|Holds all the state information needed for template processing. You will
build a TemplateState using any of Heist's TemplateState m ->
TemplateState m "filter" functions. Then you use the resulting
TemplateState in calls to renderTemplate.
|Functions and declarations on TemplateState values
|Adds a template to the template state.
|An empty template state, with Heist's default splices (<apply>,
<bind>, <ignore>, and <markdown>) mapped. The static tag is
not mapped here because it must be mapped manually in your application.
|Convenience function for looking up a splice.
|Sets the templateMap in a TemplateState.
|Traverses the specified directory structure and builds a
TemplateState by loading all the files with a .tpl extension.
|Returns True if the given template can be found in the template state.
Heist hooks allow you to modify templates when they are loaded and before
and after they are run. Every time you call one of the addAbcHook
functions the hook is added to onto the processing pipeline. The hooks
processes the template in the order that they were added to the
The pre-run and post-run hooks are run before and after every template is
run/rendered. You should be careful what code you put in these hooks
because it can significantly affect the performance of your site.
|Adds an on-load hook to a TemplateState.
|Adds a pre-run hook to a TemplateState.
|Adds a post-run hook to a TemplateState.
Stops the recursive processing of splices. Consider the following
Assume that "foo" is bound to a splice procedure. Running the foo
splice will result in a list of nodes L. Normally foo will recursively
scan L for splices and run them. If foo calls stopRecursion, L
will be included in the output verbatim without running any splices.
Gets the node currently being processed.
To sleep, perchance to dream.
When you call getParamNode inside the code for the speech splice, it
returns the Node for the speech tag and its children. getParamNode >>=
getChildren returns a list containing one Text node containing part of
Hamlet's speech. getParamNode >>= getAttribute "author" would return
|Performs splice processing on a list of nodes.
|Gets the current context
|Restores the components of TemplateState that can get modified in
template calls. You should use this function instead of putTS to restore
an old state. Thas was needed because doctypes needs to be in a global
scope as opposed to the template call local scope of state items such
as recursionDepth, curContext, and spliceMap.
|Functions for running splices and templates
|Looks up a template name evaluates it by calling runNodeList.
|Renders a template from the specified TemplateState.
|Binds a list of constant string splices
|Reads an XML document from disk.
|Turns an in-memory XML/XHTML bytestring into a (doctype,'[Node]') pair.
|Modifies a TemplateState to include a "static" tag. The static tag is
not bound automatically with the other default Heist tags. This is because
this function also returns StaticTagState, so the user will be able to
clear it with the clearStaticTagCache function.
|Produced by Haddock version 2.6.1|