hamlet-0.6.1.2: Haml-like template files that are compile-time checkedContentsIndex
Text.Hamlet
Contents
Basic quasiquoters
Load from external file
Customized settings
Datatypes
Typeclass
Construction
Rendering
ByteString
Text
Runtime Hamlet
Synopsis
hamlet :: QuasiQuoter
xhamlet :: QuasiQuoter
hamletDebug :: QuasiQuoter
hamletFile :: FilePath -> Q Exp
xhamletFile :: FilePath -> Q Exp
hamletFileDebug :: FilePath -> Q Exp
hamletWithSettings :: HamletSettings -> QuasiQuoter
hamletFileWithSettings :: HamletSettings -> FilePath -> Q Exp
data HamletSettings = HamletSettings {
hamletDoctype :: String
hamletCloseEmpties :: Bool
hamletCloseNewline :: Bool
}
defaultHamletSettings :: HamletSettings
xhtmlHamletSettings :: HamletSettings
newtype Html = Html Builder
type Hamlet url = (url -> [(String, String)] -> String) -> Html
class ToHtml a where
toHtml :: a -> Html
class Monad (HamletMonad a) => HamletValue a where
data HamletMonad a :: * -> *
type HamletUrl a
toHamletValue :: HamletMonad a () -> a
htmlToHamletMonad :: Html -> HamletMonad a ()
urlToHamletMonad :: HamletUrl a -> [(String, String)] -> HamletMonad a ()
fromHamletValue :: a -> HamletMonad a ()
preEscapedString :: String -> Html
string :: String -> Html
unsafeByteString :: ByteString -> Html
cdata :: Html -> Html
renderHamlet :: (url -> [(String, String)] -> String) -> Hamlet url -> ByteString
renderHtml :: Html -> ByteString
renderHamletText :: (url -> [(String, String)] -> String) -> Hamlet url -> Text
renderHtmlText :: Html -> Text
data HamletRT
data HamletData url
= HDHtml Html
| HDUrl url
| HDUrlParams url [(String, String)]
| HDTemplate HamletRT
| HDBool Bool
| HDMaybe (Maybe (HamletMap url))
| HDList [HamletMap url]
data HamletException
= HamletParseException String
| HamletUnsupportedDocException Doc
| HamletRenderException String
parseHamletRT :: Failure HamletException m => HamletSettings -> String -> m HamletRT
renderHamletRT :: Failure HamletException m => HamletRT -> HamletMap url -> (url -> [(String, String)] -> String) -> m Html
Basic quasiquoters
hamlet :: QuasiQuoter
Calls hamletWithSettings with defaultHamletSettings.
xhamlet :: QuasiQuoter
Calls hamletWithSettings using XHTML 1.0 Strict settings.
hamletDebug :: QuasiQuoter
Calls hamletWithSettings with debugHamletSettings.
Load from external file
hamletFile :: FilePath -> Q Exp
Calls hamletFileWithSettings with defaultHamletSettings.
xhamletFile :: FilePath -> Q Exp
Calls hamletFileWithSettings using XHTML 1.0 Strict settings.
hamletFileDebug :: FilePath -> Q Exp
Customized settings
hamletWithSettings :: HamletSettings -> QuasiQuoter

A quasi-quoter that converts Hamlet syntax into a function of form: 

 (url -> String) -> Html

Please see accompanying documentation for a description of Hamlet syntax.

hamletFileWithSettings :: HamletSettings -> FilePath -> Q Exp
data HamletSettings
Settings for parsing of a hamlet document.
Constructors
HamletSettings
hamletDoctype :: StringThe value to replace a "!!!" with. Do not include the trailing newline.
hamletCloseEmpties :: BoolTrue means to close empty tags (eg, img) with a trailing slash, ie XML-style empty tags. False uses HTML-style.
hamletCloseNewline :: BoolShould we put a newline after closing a tag?
defaultHamletSettings :: HamletSettings
Defaults settings: HTML5 doctype and HTML-style empty tags.
xhtmlHamletSettings :: HamletSettings
Datatypes
newtype Html
Constructors
Html Builder
show/hide Instances
type Hamlet url = (url -> [(String, String)] -> String) -> Html
An function generating an Html given a URL-rendering function.
Typeclass
class ToHtml a where
Methods
toHtml :: a -> Html
show/hide Instances
class Monad (HamletMonad a) => HamletValue a where
Associated Types
data HamletMonad a :: * -> *
type HamletUrl a
Methods
toHamletValue :: HamletMonad a () -> a
htmlToHamletMonad :: Html -> HamletMonad a ()
urlToHamletMonad :: HamletUrl a -> [(String, String)] -> HamletMonad a ()
fromHamletValue :: a -> HamletMonad a ()
show/hide Instances
Construction
preEscapedString :: String -> Html
string :: String -> Html
unsafeByteString :: ByteString -> Html
cdata :: Html -> Html
Wrap an Html for embedding in an XML file.
Rendering
ByteString
renderHamlet :: (url -> [(String, String)] -> String) -> Hamlet url -> ByteString
Converts a Hamlet to lazy bytestring.
renderHtml :: Html -> ByteString
Text
renderHamletText :: (url -> [(String, String)] -> String) -> Hamlet url -> Text
renderHtmlText :: Html -> Text
Runtime Hamlet
data HamletRT
data HamletData url
Constructors
HDHtml Html
HDUrl url
HDUrlParams url [(String, String)]
HDTemplate HamletRT
HDBool Bool
HDMaybe (Maybe (HamletMap url))
HDList [HamletMap url]
data HamletException
Constructors
HamletParseException String
HamletUnsupportedDocException Doc
HamletRenderException String
show/hide Instances
parseHamletRT :: Failure HamletException m => HamletSettings -> String -> m HamletRT
renderHamletRT :: Failure HamletException m => HamletRT -> HamletMap url -> (url -> [(String, String)] -> String) -> m Html
Produced by Haddock version 2.6.0