The highlighting-kate package

[ Tags: deprecated, gpl, library, text ] [ Propose Tags ]
Deprecated. in favor of skylighting

highlighting-kate is a syntax highlighting library with support for over 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]


Versions 0.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, 0.6.1, 0.6.2,, 0.6.3, 0.6.4
Change log changelog
Dependencies base (<5), containers, filepath, parsec, pcre-light, regex-pcre-builtin, xhtml [details]
License GPL
Author John MacFarlane
Category Text
Home page
Uploaded Sun Jan 2 19:41:10 UTC 2011 by JohnMacFarlane
Distributions Debian:0.6.1, Fedora:0.6.4, FreeBSD:0.6, LTSHaskell:0.6.4, NixOS:0.6.4, Stackage:0.6.4, openSUSE:0.6.4
Executables Highlight
Downloads 87214 total (440 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]
Hackage Matrix CI





Choose the new, smaller, split-up base package.


Build the Highlight executable.


Use the pcre-light library instead of regex-pcre-builtin


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


Maintainer's Corner

For package maintainers and hackage trustees

Readme for highlighting-kate-

[back to package description]
highlighting-kate is a Haskell source code highlighting library, based
on Kate's syntax description files (

Currently, the following languages/formats are supported:

Actionscript, Ada, Alert, Alert_indent, Ansys, Apache, Asn1, Asp, Awk,
Bash, Bibtex, Boo, C, Changelog, Cisco, Cmake, Coldfusion, Commonlisp,
Cpp, Cs, Css, Cue, D, Desktop, Diff, Djangotemplate, Doxygen, Doxygenlua,
Dtd, Eiffel, Email, Erlang, Fortran, Fstab, Gap, Gdb, Gettext, Gnuassembler,
Go, Haskell, Haxe, Html, Idl, Ilerpg, Ini, Java, Javadoc, Javascript,
Json, Jsp, Latex, Lex, LiterateHaskell, Lua, M3u, Makefile, Mandoc,
Matlab, Maxima, Mediawiki, Metafont, Mips, Modula2, Modula3, Monobasic,
Nasm, Noweb, Objectivec, Objectivecpp, Ocaml, Octave, Pango, Pascal, Perl,
Php, Pike, Postscript, Prolog, Python, R, Relaxngcompact, Rhtml, Ruby,
Scala, Scheme, Sci, Sed, Sgml, Sql, SqlMysql, SqlPostgresql, Tcl, Texinfo,
Verilog, Vhdl, Winehq, Wml, Xharbour, Xml, Xorg, Xslt, Xul, Yacc, Yaml

To install, use the cabal tool:

    cabal install

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

    make prep

which generates some of the needed source files from xml syntax

To generate the documentation:

    cabal haddock

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

    cabal install -fexecutable

To run Highlight, specify the language name using -s:

    Highlight -s haskell Highlight.hs > example.html

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

    Highlight --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). If you
added or removed a syntax definition, you will also need to
update the Extra-Source-Files and Exposed-Modules sections of
highlighting-kate.cabal before recompiling using 'cabal install'.

You can browse the available Kate syntax highlighting files at

or retrieve them all using Subversion:

    svn co svn:// kate-data 

There is information on the syntax highlighting definitions at

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

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

- javascript.xml:  Fixed regex \s* (which matches empty string) by changes to DetectSpaces
- perl.xml:  Fixed regexes - needed backslash-escapes before ] and ^
- bash.xml: Changed "\\" to "\" in two Detect2Char rules in FindString

NOTE: Known bugs are recorded in the file BUGS. Please send bug reports (or
better, patches) to the author (jgm at berkeley dot edu).