shakespeare

A toolkit for making compile-time interpolated templates

http://www.yesodweb.com/book/shakespearean-templates

Version on this page:	2.0.7@rev:2
LTS Haskell 20.25:	2.0.30
Stackage Nightly 2023-06-08:	2.1.0
Latest on Hackage:	2.1.0

See all snapshots shakespeare appears in

MIT licensed and maintained by Michael Snoyman

This version can be pinned in stack with:shakespeare-2.0.7@sha256:ff8eb61962780146539bd26b3c836b25c3a7d7a70b2eed44a233032d6aa7b250,5846

Module documentation for 2.0.7

Text

Depends on 18 packages(full list with versions):

aeson, base, blaze-html, blaze-markup, bytestring, containers, directory, exceptions, ghc-prim, parsec, process, scientific, template-haskell, text, time, transformers, unordered-containers, vector

Used by 19 packages in lts-3.22(full list with versions):

country-codes, git-annex, hackage-mirror, hamlet, hledger, hledger-web, xml-hamlet, yackage, yesod, yesod-auth, yesod-auth-fb, yesod-bin, yesod-core, yesod-fay, yesod-form, yesod-mangopay, yesod-newsfeed, yesod-static-angular, yesod-text-markdown

Shakespeare is a family of type-safe, efficient template languages. Shakespeare templates are expanded at compile-time, ensuring that all interpolated variables are in scope. Variables are interpolated according to their type through a typeclass.

Shakespeare templates can be used inline with a quasi-quoter or in an external file.

Note there is no dependency on haskell-src-extras. Instead Shakespeare believes logic should stay out of templates and has its own minimal Haskell parser.

Packages that use this: shakespeare-js, shakespeare-css, shakespeare-text, hamlet, and xml-hamlet

Please see the documentation at http://www.yesodweb.com/book/shakespearean-templates for more details.

Changes

2.0.7

Include aeson’s JSON encoding and escape <, > and & to avoid XSS attacks

2.0.6

Provide the Text.Hamlet.Runtime module

2.0.5

Drop system-filepath

2.0.4.1

Fix build for GHC 7.10 #151

2.0.4

Add multiline literal aligned with bar #148

2.0.3

cassiusMixin added

2.0.2.2

GHC 7.10 support

shakesepare 2.0.2

shakespeare-i18n supports message directories.

Hamlet 0.5.0 (August 29, 2010)

Use can use parantheses when referencing variables. This allows you to have functions applied to multiple arguments.
Added the hamlet’ and xhamlet’ quasiquoters for generating plain Html values.
Added runtime Hamlet support.
Added “file debug” support. This is a mode that is a drop-in replacement for external files compiled via template haskell. However, this mode also has a runtime component, in that is reads your templates at runtime, thus avoiding the need to a recompile for each template change. This takes a runtime hit obviously, so it’s recommended that you switch back to the compile-time templates for production systems.
Added the Cassius and Julius template languages for CSS and Javascript, respectively. The former is white-space sensitive, whereas the latter is just a passthrough for raw Javascript code. The big feature in both of them is that they support variable interpolation just like Hamlet does.

New in Hamlet 0.4.0

Internal template parsing is now done via Parsec. This opened the doors for the other changes mentioned below, but also hopefully gives more meaningful error messages. There’s absolutely no runtime performance hit for this change, since all parsing is done at compile time, and if there is any compile-time hit, it’s too negligible to be noticed.
Attribute values can now be quoted. This allows you to embed spaces, periods and pounds in an attribute value. For example: [$hamlet|%input!type=submit!value=“Add new value”|].
Space-delimited references in addition to period-delimited ones. This only applies to references in content, not in statements. For example, you could write [$hamlet|$foo bar baz$|].
Dollar-sign interpolation is now polymorphic, based on the ToHtml typeclass. You can now do away with $string.var$ and simply type $var$. Currently, the ToHtml typeclass is not exposed, and it only provides instances for String and Html, though this is open for discussion.
Added hamletFile and xhamletFile which loads a Hamlet template from an external file. The file is parsed at compile time, just like a quasi-quoted template, and must be UTF-8 encoded. Additionally, be warned that the compiler won’t automatically know to recompile a module if the template file gets changed.