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


-- | multi-line string / here document using QuasiQuotes
--   
--   multi-line string / here document using QuasiQuotes
@package heredoc
@version 0.2.0.0

module Text.Heredoc

-- | Create a string-literal expression from the string being quoted.
--   
--   Newline literals are normalized to UNIX newlines (one '\n' character).
here :: QuasiQuoter

-- | Create a string-literal expression from the contents of the file at
--   the filepath being quoted.
--   
--   Newline literals are normalized to UNIX newlines (one '\n' character).
there :: QuasiQuoter

-- | Create a multi-line string literal whose left edge is demarcated by
--   the "pipe" character ('|'). For example,
--   
--   <pre>
--   famousQuote = [str|Any dictator would admire the
--                     |uniformity and obedience of the U.S. media.
--                     |
--                     |    -- Noam Chomsky
--                     |]
--   </pre>
--   
--   is functionally equivalent to
--   
--   <pre>
--   famousQuote = "Any dictator would admire the\n" ++
--                 "uniformity and obedience of the U.S. media.\n" ++
--                 "\n" ++
--                 "    -- Noam Chomsky\n"
--   </pre>
--   
--   If desired, you can have a ragged left-edge, so
--   
--   <pre>
--   myHtml = [str|&lt;html&gt;
--                    |&lt;body&gt;
--                        |&lt;h1&gt;My home page&lt;/h1&gt;
--                    |&lt;/body&gt;
--                |&lt;/html&gt;
--                |]
--   </pre>
--   
--   is functionally equivalent to
--   
--   <pre>
--   myHtml = "&lt;html&gt;\n" ++
--            "&lt;body&gt;\n" ++
--            "&lt;h1&gt;My home page&lt;/h1&gt;\n" ++
--             "&lt;/body&gt;\n" ++
--            "&lt;/html&gt;\n"
--   </pre>
str :: QuasiQuoter
