The highlighting-kate package

[Tags: gpl, library]

highlighting-kate is a syntax highlighting library with support for nearly one hundred languages. The syntax parsers are automatically generated from Kate syntax descriptions (, so any syntax supported by Kate can be added. An (optional) command-line program is provided, along with a utility for generating new parsers from Kate XML syntax descriptions.

[Skip to ReadMe]


Versions0.2, 0.2.1, 0.2.3, 0.2.4, 0.2.5,, 0.2.6,,, 0.2.7,,,, 0.2.9, 0.2.10, 0.3, 0.3.1, 0.4, 0.5,,,,,,, 0.5.1, 0.5.2, 0.5.3,,,,,,,,,, 0.5.4, 0.5.5,, 0.5.6,, 0.5.7,, 0.5.8,,,,,, 0.5.9, 0.5.10, 0.5.11,, 0.5.12, 0.5.13, 0.5.14, 0.5.15, 0.6
Change logchangelog
Dependenciesbase (<3 || >=4.4 && <5), blaze-html (>=0.4.2 && <0.9), containers, filepath, highlighting-kate, mtl, parsec, pcre-light (==0.4.*), regex-pcre-builtin (>=, utf8-string [details]
AuthorJohn MacFarlane
Home page
Source repositoryhead: git clone git://
UploadedWed May 27 00:01:40 UTC 2015 by JohnMacFarlane
UpdatedMon Jun 15 14:17:01 UTC 2015 by AdamBergmark to revision 1
DistributionsDebian:0.6, Fedora:, FreeBSD:0.6, LTSHaskell:0.6, NixOS:0.6, Stackage:0.6
Downloads69443 total (935 in last 30 days)
0 []
StatusDocs available [build log]
Last success reported on 2015-05-27 [all 1 reports]




splitbaseChoose the new, smaller, split-up base package.EnabledAutomatic
executableBuild the highlighting-kate executable.DisabledAutomatic
pcre-lightUse the pcre-light library instead of regex-pcre-builtinDisabledAutomatic

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info


Maintainers' corner

For package maintainers and hackage trustees

Readme for highlighting-kate-0.6


A Haskell source code highlighting library, based on Kate's syntax description files (, now part of the KDE Framework's "KTextEditor" component. It can produce both HTML and LaTeX output.

Currently, the following languages/formats are supported:

To install, use the cabal tool:

cabal install

Note: If you have checked out the source from the git repository, you will first need to do:

make prep

which generates some of the needed source files from xml syntax definitions.

To generate the documentation:

cabal haddock

To run the test suite:

cabal test

For an example of the use of the library, see highlighting-kate.hs. To compile this program along with the library, specify the 'executable' flag in the configure step above:

cabal install -fexecutable

To run highlighting-kate, specify the language name using -s:

highlighting-kate -s haskell highlighting-kate.hs > example.html

If you don't specify a language name, highlighting-kate will try to guess it from the file extension.highlighting-kate can also be used as a pipe, reading input from STDIN. For other options,

highlighting-kate --help

Styling is done using span tags. The Highlight program will include default styles in the generated HTML, unless a link to a CSS file is provided using the '--css' option. Some sample CSS files can be found in the css directory. These use generic class names (Normal, Keyword, DataType, DecVal, BaseN, Float, Char, String, Comment, Function, Others, Alert, Error). For more fine-grained highlighting, users may wish to create their own CSS files that use language-specific classes.

The parsers in Text/Highlighting/Kate/Syntax were automatically generated from the Kate syntax definitions in the xml directory. You may modify the xml files in this directory, or add new ones, and then regenerate the parsers by doing:

make prep


runghc ParseSyntaxFiles.hs xml

Note that ParseSyntaxFiles.hs requires the HXT package (>= 9.0.0).

To get the current Kate syntax highlighting files, clone the ktexteditor repository:

git clone git://

The syntax definitions can then be found in


There is information on the syntax highlighting definitions at See also

Thanks are due to all the authors of these syntax definitions.

Changes have been made to the following xml files (diffs have been left in the directory, with .patch extensions):