-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Haml-like template files that are compile-time checked
--   
--   Hamlet gives you a type-safe tool for generating HTML code. It works
--   via Quasi-Quoting, and generating extremely efficient output code. The
--   syntax is white-space sensitive, and it helps you avoid cross-site
--   scripting issues and 404 errors. Please see the documentation at
--   <a>http://docs.yesodweb.com/hamlet/</a> for more details.
--   
--   As a quick overview, here is a sample Hamlet template:
--   
--   <pre>
--   !!!
--   %html
--       %head
--           %title Hamlet Demo
--       %body
--           %h1 Information on $name.person$
--           %p $*name.person$ is $age.person$ years old.
--           %h2
--               $if isMarried.person
--                   Married
--               $else
--                   Not married
--           %ul
--               $forall children.person child
--                   %li $child$
--           %p
--               %a!href=@page.person@ See the page.
--           ^footer^
--   </pre>
@package hamlet
@version 0.4.0

module Text.Hamlet

-- | Calls <a>hamletWithSettings</a> with <a>defaultHamletSettings</a>.
hamlet :: QuasiQuoter

-- | Calls <a>hamletWithSettings</a> using XHTML 1.0 Strict settings.
xhamlet :: QuasiQuoter

-- | Calls <a>hamletFileWithSettings</a> with <a>defaultHamletSettings</a>.
hamletFile :: FilePath -> Q Exp

-- | Calls <a>hamletFileWithSettings</a> using XHTML 1.0 Strict settings.
xhamletFile :: FilePath -> Q Exp

-- | A quasi-quoter that converts Hamlet syntax into a function of form:
--   
--   <pre>
--   (url -&gt; String) -&gt; Html
--   </pre>
--   
--   Please see accompanying documentation for a description of Hamlet
--   syntax.
hamletWithSettings :: HamletSettings -> QuasiQuoter
hamletFileWithSettings :: HamletSettings -> FilePath -> Q Exp

-- | Settings for parsing of a hamlet document.
data HamletSettings
HamletSettings :: String -> Bool -> HamletSettings

-- | The value to replace a "!!!" with. Do not include the trailing
--   newline.
hamletDoctype :: HamletSettings -> String

-- | <a>True</a> means to close empty tags (eg, img) with a trailing slash,
--   ie XML-style empty tags. <a>False</a> uses HTML-style.
hamletCloseEmpties :: HamletSettings -> Bool

-- | Defaults settings: HTML5 doctype and HTML-style empty tags.
defaultHamletSettings :: HamletSettings

-- | The core HTML datatype.
data Html a :: * -> *

-- | An function generating an <a>Html</a> given a URL-rendering function.
type Hamlet url = (url -> String) -> Html ()

-- | Converts a <a>Hamlet</a> to lazy bytestring.
renderHamlet :: (url -> String) -> Hamlet url -> ByteString

-- | <i>O(n).</i> Render the HTML fragment to lazy <a>ByteString</a>.
renderHtml :: Html a -> ByteString

-- | Create an HTML snippet from a <a>String</a> without escaping
preEscapedString :: String -> Html a

-- | Create an HTML snippet from a <a>String</a>.
string :: String -> Html a

-- | Insert a <a>ByteString</a>. This is an unsafe operation:
--   
--   <ul>
--   <li>The <a>ByteString</a> could have the wrong encoding.</li>
--   <li>The <a>ByteString</a> might contain illegal HTML characters (no
--   escaping is done).</li>
--   </ul>
unsafeByteString :: ByteString -> Html a

-- | Wrap an <a>Html</a> for embedding in an XML file.
cdata :: Html () -> Html ()