<!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>Text.Highlighting.Kate</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_Text-Highlighting-Kate.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Text-Highlighting-Kate.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">highlighting-kate-0.2.9: Syntax highlighting</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>portable</td></tr><tr><th>Stability</th><td>alpha </td></tr><tr><th>Maintainer</th><td>John MacFarlane <jgm@berkeley.edu></td></tr></table><p class="caption">Text.Highlighting.Kate</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This helper module exports the main highlighting and formatting
functions.
</p><p>A typical application will combine a highlighter and a formatter:
</p><pre> main = do
code <- getContents
case highlightAs "ruby" code of
Right result -> putStrLn $ renderHtmlFragment $
formatAsXHtml [OptNumberLines] "ruby" result
Left err -> error $ "Could not parse input: " ++ err
</pre></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"><a href="#v:highlightAs">highlightAs</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> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> [<a href="Text-Highlighting-Kate.html#t:SourceLine">SourceLine</a>]</li><li class="src short"><a href="#v:languages">languages</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>]</li><li class="src short"><a href="#v:languagesByExtension">languagesByExtension</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><li class="src short"><a href="#v:languagesByFilename">languagesByFilename</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a> -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>]</li><li class="src short"><a href="#v:formatAsXHtml">formatAsXHtml</a> :: [<a href="Text-Highlighting-Kate.html#t:FormatOption">FormatOption</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> [<a href="Text-Highlighting-Kate.html#t:SourceLine">SourceLine</a>] -> <a href="/usr/share/doc/ghc/html/libraries/xhtml-3000.2.0.1/Text-XHtml-Strict.html#t:Html">Html</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:FormatOption">FormatOption</a> <ul class="subs"><li>= <a href="#v:OptNumberLines">OptNumberLines</a> </li><li>| <a href="#v:OptNumberFrom">OptNumberFrom</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> </li><li>| <a href="#v:OptLineAnchors">OptLineAnchors</a> </li><li>| <a href="#v:OptTitleAttributes">OptTitleAttributes</a> </li><li>| <a href="#v:OptDetailed">OptDetailed</a> </li><li>| <a href="#v:OptInline">OptInline</a> </li></ul></li><li class="src short"><a href="#v:defaultHighlightingCss">defaultHighlightingCss</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:SourceLine">SourceLine</a> = [<a href="Text-Highlighting-Kate.html#t:LabeledSource">LabeledSource</a>]</li><li class="src short"><span class="keyword">type</span> <a href="#t:LabeledSource">LabeledSource</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><li class="src short"><a href="#v:highlightingKateVersion">highlightingKateVersion</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"><a name="v:highlightAs" class="def">highlightAs</a><a href="src/Text-Highlighting-Kate-Syntax.html#highlightAs" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><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>Language syntax
</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>Source code to highlight
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> [<a href="Text-Highlighting-Kate.html#t:SourceLine">SourceLine</a>]</td><td class="doc"><p>Either error message or result
</p></td></tr></table></div><div class="doc"><p>Highlight source code using a specified syntax definition.
</p></div></div><div class="top"><p class="src"><a name="v:languages" class="def">languages</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>]<a href="src/Text-Highlighting-Kate-Syntax.html#languages" class="link">Source</a></p><div class="doc"><p>List of supported languages.
</p></div></div><div class="top"><p class="src"><a name="v:languagesByExtension" class="def">languagesByExtension</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>]<a href="src/Text-Highlighting-Kate-Syntax.html#languagesByExtension" class="link">Source</a></p><div class="doc"><p>Returns a list of languages appropriate for the given file extension.
</p></div></div><div class="top"><p class="src"><a name="v:languagesByFilename" class="def">languagesByFilename</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a> -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>]<a href="src/Text-Highlighting-Kate-Syntax.html#languagesByFilename" class="link">Source</a></p><div class="doc"><p>Returns a list of languages appropriate for the given filename.
</p></div></div><div class="top"><p class="src"><a name="v:formatAsXHtml" class="def">formatAsXHtml</a><a href="src/Text-Highlighting-Kate-Format.html#formatAsXHtml" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: [<a href="Text-Highlighting-Kate.html#t:FormatOption">FormatOption</a>]</td><td class="doc"><p>Options
</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>Language
</p></td></tr><tr><td class="src">-> [<a href="Text-Highlighting-Kate.html#t:SourceLine">SourceLine</a>]</td><td class="doc"><p>Source lines to format
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/xhtml-3000.2.0.1/Text-XHtml-Strict.html#t:Html">Html</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Format a list of highlighted <code>SourceLine</code>s as XHtml.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:FormatOption" class="def">FormatOption</a> <a href="src/Text-Highlighting-Kate-Format.html#FormatOption" class="link">Source</a></p><div class="doc"><p>Options for formatters.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:OptNumberLines" class="def">OptNumberLines</a></td><td class="doc"><p>Number lines
</p></td></tr><tr><td class="src"><a name="v:OptNumberFrom" class="def">OptNumberFrom</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p>Number of first line
</p></td></tr><tr><td class="src"><a name="v:OptLineAnchors" class="def">OptLineAnchors</a></td><td class="doc"><p>Anchors on each line number
</p></td></tr><tr><td class="src"><a name="v:OptTitleAttributes" class="def">OptTitleAttributes</a></td><td class="doc"><p>Include title attributes
</p></td></tr><tr><td class="src"><a name="v:OptDetailed" class="def">OptDetailed</a></td><td class="doc"><p>Include detailed lexical information in classes.
(By default, only the default style is included. This
option causes output to be more verbose.)
</p></td></tr><tr><td class="src"><a name="v:OptInline" class="def">OptInline</a></td><td class="doc"><p>Format as span-level, not block-level element
</p></td></tr></table></div><div class="subs instances"><p id="control.i:FormatOption" class="caption collapser" onclick="toggleSection('i:FormatOption')">Instances</p><div id="section.i:FormatOption" 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="Text-Highlighting-Kate.html#t:FormatOption">FormatOption</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="Text-Highlighting-Kate.html#t:FormatOption">FormatOption</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="Text-Highlighting-Kate.html#t:FormatOption">FormatOption</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:defaultHighlightingCss" class="def">defaultHighlightingCss</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Text-Highlighting-Kate-Format.html#defaultHighlightingCss" class="link">Source</a></p></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:SourceLine" class="def">SourceLine</a> = [<a href="Text-Highlighting-Kate.html#t:LabeledSource">LabeledSource</a>]<a href="src/Text-Highlighting-Kate-Definitions.html#SourceLine" class="link">Source</a></p><div class="doc"><p>A line of source, list of labeled source items.
</p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:LabeledSource" class="def">LabeledSource</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>)<a href="src/Text-Highlighting-Kate-Definitions.html#LabeledSource" class="link">Source</a></p><div class="doc"><p>A pair consisting of a list of attributes and some text.
</p></div></div><div class="top"><p class="src"><a name="v:highlightingKateVersion" class="def">highlightingKateVersion</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Text-Highlighting-Kate.html#highlightingKateVersion" class="link">Source</a></p></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>
