<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Language.Haskell.HsColour</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Language-Haskell-HsColour.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Language-Haskell-HsColour.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">hscolour-1.17: Colourise Haskell code.</p></div><div id="content"><div id="module-header"><p class="caption">Language.Haskell.HsColour</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This is a library which colourises Haskell code.
It currently has six output formats:
</p><ul><li> ANSI terminal codes
</li><li> LaTeX macros
</li><li> HTML 3.2 with font tags
</li><li> HTML 4.01 with external CSS.
</li><li> XHTML 1.0 with internal CSS.
</li><li> mIRC chat client colour codes.
</li></ul></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:Output">Output</a> <ul class="subs"><li>= <a href="#v:TTY">TTY</a> </li><li>| <a href="#v:LaTeX">LaTeX</a> </li><li>| <a href="#v:HTML">HTML</a> </li><li>| <a href="#v:CSS">CSS</a> </li><li>| <a href="#v:ICSS">ICSS</a> </li><li>| <a href="#v:MIRC">MIRC</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:ColourPrefs">ColourPrefs</a> = <a href="#v:ColourPrefs">ColourPrefs</a> {<ul class="subs"><li><a href="#v:keyword">keyword</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</li><li><a href="#v:keyglyph">keyglyph</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</li><li><a href="#v:layout">layout</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</li><li><a href="#v:comment">comment</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</li><li><a href="#v:conid">conid</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</li><li><a href="#v:varid">varid</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</li><li><a href="#v:conop">conop</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</li><li><a href="#v:varop">varop</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</li><li><a href="#v:string">string</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</li><li><a href="#v:char">char</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</li><li><a href="#v:number">number</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</li><li><a href="#v:cpp">cpp</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</li><li><a href="#v:selection">selection</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</li><li><a href="#v:variantselection">variantselection</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</li><li><a href="#v:definition">definition</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</li></ul>}</li><li class="src short"><a href="#v:hscolour">hscolour</a> :: <a href="Language-Haskell-HsColour.html#t:Output">Output</a> -> <a href="Language-Haskell-HsColour.html#t:ColourPrefs">ColourPrefs</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Output" class="def">Output</a> <a href="src/Language-Haskell-HsColour-Output.html#Output" class="link">Source</a></p><div class="doc"><p>The supported output formats.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:TTY" class="def">TTY</a></td><td class="doc"><p>ANSI terminal codes
</p></td></tr><tr><td class="src"><a name="v:LaTeX" class="def">LaTeX</a></td><td class="doc"><p>TeX macros
</p></td></tr><tr><td class="src"><a name="v:HTML" class="def">HTML</a></td><td class="doc"><p>HTML with font tags
</p></td></tr><tr><td class="src"><a name="v:CSS" class="def">CSS</a></td><td class="doc"><p>HTML with CSS.
</p></td></tr><tr><td class="src"><a name="v:ICSS" class="def">ICSS</a></td><td class="doc"><p>HTML with inline CSS.
</p></td></tr><tr><td class="src"><a name="v:MIRC" class="def">MIRC</a></td><td class="doc"><p>mIRC chat clients
</p></td></tr></table></div><div class="subs instances"><p id="control.i:Output" class="caption collapser" onclick="toggleSection('i:Output')">Instances</p><div id="section.i:Output" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Language-Haskell-HsColour.html#t:Output">Output</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> <a href="Language-Haskell-HsColour.html#t:Output">Output</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ColourPrefs" class="def">ColourPrefs</a> <a href="src/Language-Haskell-HsColour-Colourise.html#ColourPrefs" class="link">Source</a></p><div class="doc"><p>Colour preferences.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ColourPrefs" class="def">ColourPrefs</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:keyword" class="def">keyword</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:keyglyph" class="def">keyglyph</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:layout" class="def">layout</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:comment" class="def">comment</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:conid" class="def">conid</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:varid" class="def">varid</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:conop" class="def">conop</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:varop" class="def">varop</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:string" class="def">string</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:char" class="def">char</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:number" class="def">number</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:cpp" class="def">cpp</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:selection" class="def">selection</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:variantselection" class="def">variantselection</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:definition" class="def">definition</a> :: [<a href="Language-Haskell-HsColour-ColourHighlight.html#t:Highlight">Highlight</a>]</dt><dd class="doc empty"> </dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:ColourPrefs" class="caption collapser" onclick="toggleSection('i:ColourPrefs')">Instances</p><div id="section.i:ColourPrefs" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Language-Haskell-HsColour.html#t:ColourPrefs">ColourPrefs</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Read.html#t:Read">Read</a> <a href="Language-Haskell-HsColour.html#t:ColourPrefs">ColourPrefs</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> <a href="Language-Haskell-HsColour.html#t:ColourPrefs">ColourPrefs</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:hscolour" class="def">hscolour</a><a href="src/Language-Haskell-HsColour.html#hscolour" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Language-Haskell-HsColour.html#t:Output">Output</a></td><td class="doc"><p>Output format.
</p></td></tr><tr><td class="src">-> <a href="Language-Haskell-HsColour.html#t:ColourPrefs">ColourPrefs</a></td><td class="doc"><p>Colour preferences (for formats that support them).
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p>Whether to include anchors.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p>Whether output document is partial or complete.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p>Title for output.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p>Whether input document is literate haskell or not
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p>Haskell source code.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p>Coloured Haskell source code.
</p></td></tr></table></div><div class="doc"><p>Colourise Haskell source code with the given output format.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
