haddock

Portability | portable
Stability | experimental
Maintainer | haddock@projects.haskell.org
Safe Haskell | Safe-Infered

Haddock.Backends.Xhtml.Utils

Description

Synopsis

- renderToString :: Bool -> Html -> String
- namedAnchor :: String -> Html -> Html
- linkedAnchor :: String -> Html -> Html
- spliceURL :: Maybe FilePath -> Maybe Module -> Maybe Name -> Maybe SrcSpan -> String -> String
- groupId :: String -> String
- (<+>) :: Html -> Html -> Html
- char :: Char -> Html
- nonEmpty :: (Html -> Html) -> Html -> Html
- keyword :: String -> Html
- punctuate :: Html -> [Html] -> [Html]
- parens, braces, pabrackets, brackets :: Html -> Html
- parenList :: [Html] -> Html
- ubxParenList :: [Html] -> Html
- dcolon, forallSymbol, darrow, arrow :: Bool -> Html
- equals, comma :: Html
- dot :: Html
- quote :: Html -> Html
- hsep :: [Html] -> Html
- collapseSection :: String -> Bool -> String -> [HtmlAttr]
- collapseToggle :: String -> [HtmlAttr]
- collapseControl :: String -> Bool -> String -> [HtmlAttr]

# Documentation

renderToString :: Bool -> Html -> String

namedAnchor :: String -> Html -> Html

Generate a named anchor

linkedAnchor :: String -> Html -> Html

spliceURL :: Maybe FilePath -> Maybe Module -> Maybe Name -> Maybe SrcSpan -> String -> String

groupId :: String -> String

generate an anchor identifier for a group

(<+>) :: Html -> Html -> Html

char :: Char -> Html

nonEmpty :: (Html -> Html) -> Html -> Html

Make an element that always has at least something (a non-breaking space) If it would have otherwise been empty, then give it the class .empty

keyword :: String -> Html

punctuate :: Html -> [Html] -> [Html]

parens, braces, pabrackets, brackets :: Html -> Html

parenList :: [Html] -> Html

ubxParenList :: [Html] -> Html

dcolon, forallSymbol, darrow, arrow :: Bool -> Html

equals, comma :: Html

dot :: Html

quote :: Html -> Html

hsep :: [Html] -> Html

collapseSection :: String -> Bool -> String -> [HtmlAttr]

Attributes for an area that can be collapsed

collapseToggle :: String -> [HtmlAttr]

Attributes for an area that toggles a collapsed area

collapseControl :: String -> Bool -> String -> [HtmlAttr]

Attributes for an area that toggles a collapsed area, and displays a control.