Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Tree: ec9f2a6316
Fetching contributors…

Cannot retrieve contributors at this time

98 lines (65 sloc) 3.773 kB
highlighting-kate is a Haskell source code highlighting library, based
on Kate's syntax description files (http://kate-editor.org/).
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
definitions.
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
or
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
http://kate-editor.org/downloads/syntax_highlighting
or retrieve them all using Subversion:
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs/kate/syntax/data kate-data
There is information on the syntax highlighting definitions at
http://kate-editor.org/article/writing_a_kate_highlighting_xml_file
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).
Jump to Line
Something went wrong with that request. Please try again.