Skip to content
Newer
Older
100644 177 lines (144 sloc) 3.52 KB
ede8650 Initial commit.
jgm@berkeley.edu authored Feb 2, 2008
1 highlighting-kate is a Haskell source code highlighting library, based
9971bc5 Added some references to Kate's website for those who don't know Kate.
jgm@berkeley.edu authored Feb 9, 2008
2 on Kate's syntax description files (http://kate-editor.org/).
ede8650 Initial commit.
jgm@berkeley.edu authored Feb 2, 2008
3
7bd486b @tianyicui Added a bunch of XML grammars from Kate
tianyicui authored Dec 9, 2010
4 Currently, the following languages/formats are supported:
5
693e50c Removed some syntaxes to trim the bloated package.
John MacFarlane authored Nov 26, 2011
6 - Actionscript
7 - Ada
8 - Apache
9 - Asn1
10 - Asp
11 - Awk
12 - Bash
13 - Bibtex
14 - Boo
15 - C
16 - Changelog
7b8b586 Added Clojure on README.
John MacFarlane authored Nov 27, 2011
17 - Clojure
693e50c Removed some syntaxes to trim the bloated package.
John MacFarlane authored Nov 27, 2011
18 - Cmake
19 - Coffeescript
20 - Coldfusion
21 - Commonlisp
22 - Cpp
23 - Cs
24 - Css
25 - D
26 - Diff
27 - Djangotemplate
28 - Doxygen
29 - Dtd
30 - Eiffel
31 - Email
32 - Erlang
33 - Fortran
34 - Fsharp
35 - Gnuassembler
36 - Go
37 - Haskell
38 - Haxe
39 - Html
40 - Ilerpg
41 - Ini
42 - Java
43 - Javadoc
44 - Javascript
45 - Json
46 - Jsp
47 - Latex
48 - Lex
49 - LiterateHaskell
50 - Lua
51 - Makefile
52 - Mandoc
53 - Matlab
54 - Maxima
55 - Mediawiki
56 - Metafont
57 - Mips
58 - Modula2
59 - Modula3
60 - Monobasic
61 - Nasm
62 - Noweb
63 - Objectivec
64 - Objectivecpp
65 - Ocaml
66 - Octave
67 - Pascal
68 - Perl
69 - Php
70 - Pike
71 - Postscript
72 - Prolog
73 - Python
74 - R
75 - Relaxngcompact
76 - Rhtml
77 - Ruby
78 - Scala
79 - Scheme
80 - Sci
81 - Sed
82 - Sgml
83 - Sql
84 - SqlMysql
85 - SqlPostgresql
86 - Tcl
87 - Texinfo
88 - Verilog
89 - Vhdl
90 - Xml
91 - Xorg
92 - Xslt
93 - Xul
94 - Yacc
95 - Yaml
ede8650 Initial commit.
jgm@berkeley.edu authored Feb 2, 2008
96
91188b6 Improved installation instructions.
jgm@berkeley.edu authored Oct 9, 2010
97 To install, use the cabal tool:
ede8650 Initial commit.
jgm@berkeley.edu authored Feb 2, 2008
98
91188b6 Improved installation instructions.
jgm@berkeley.edu authored Oct 9, 2010
99 cabal install
100
101 Note: If you have checked out the source from the darcs repository,
102 you will first need to do:
103
104 make prep
105
106 which generates some of the needed source files from xml syntax
107 definitions.
108
4230e75 @jgm Added note on linking error to readme.
authored Jan 26, 2011
109 If you get a linking error with GHC 7 on Mac OS X, "scattered reloc r_address
110 too large for inferred architecture i386," the workaround is to use the flag
111 `--disable-library-for-ghci` when you `cabal install`.
112
91188b6 Improved installation instructions.
jgm@berkeley.edu authored Oct 9, 2010
113 To generate the documentation:
114
115 cabal haddock
69fc129 Export definitions in Text.Highlighting.Kate.Definitions.
jgm@berkeley.edu authored Feb 2, 2008
116
ede8650 Initial commit.
jgm@berkeley.edu authored Feb 2, 2008
117 For an example of the use of the library, see Highlight.hs.
a000418 Updated README.
jgm@berkeley.edu authored Feb 9, 2008
118 To compile this program along with the library, specify the 'executable'
119 flag in the configure step above:
6ef44ba Added cabal configuration flag for building the Highlight executable.
jgm@berkeley.edu authored Feb 3, 2008
120
91188b6 Improved installation instructions.
jgm@berkeley.edu authored Oct 9, 2010
121 cabal install -fexecutable
6ef44ba Added cabal configuration flag for building the Highlight executable.
jgm@berkeley.edu authored Feb 3, 2008
122
9e76aaf Updated README.
jgm@berkeley.edu authored Feb 3, 2008
123 To run Highlight, specify the language name using -s:
ede8650 Initial commit.
jgm@berkeley.edu authored Feb 2, 2008
124
a000418 Updated README.
jgm@berkeley.edu authored Feb 9, 2008
125 Highlight -s haskell Highlight.hs > example.html
ede8650 Initial commit.
jgm@berkeley.edu authored Feb 2, 2008
126
9e76aaf Updated README.
jgm@berkeley.edu authored Feb 3, 2008
127 If you don't specify a language name, Highlight will try to guess it
a000418 Updated README.
jgm@berkeley.edu authored Feb 9, 2008
128 from the file extension. Highlight can also be used as a pipe, reading
129 input from STDIN. For other options,
9e76aaf Updated README.
jgm@berkeley.edu authored Feb 3, 2008
130
a000418 Updated README.
jgm@berkeley.edu authored Feb 9, 2008
131 Highlight --help
ede8650 Initial commit.
jgm@berkeley.edu authored Feb 2, 2008
132
a000418 Updated README.
jgm@berkeley.edu authored Feb 9, 2008
133 Styling is done using span tags. The Highlight program will include
134 default styles in the generated HTML, unless a link to a CSS file is
135 provided using the '--css' option. Some sample CSS files can be found
136 in the css directory. These use generic class names (Normal, Keyword,
137 DataType, DecVal, BaseN, Float, Char, String, Comment, Function, Others,
138 Alert, Error). For more fine-grained highlighting, users may wish to
139 create their own CSS files that use language-specific classes.
ede8650 Initial commit.
jgm@berkeley.edu authored Feb 2, 2008
140
141 The parsers in Text/Highlighting/Kate/Syntax were automatically generated
3245328 Added notes about xml files that have been modified.
jgm@berkeley.edu authored Feb 2, 2008
142 from the Kate syntax definitions in the xml directory. You may modify
143 the xml files in this directory, or add new ones, and then regenerate
144 the parsers by doing:
ede8650 Initial commit.
jgm@berkeley.edu authored Feb 2, 2008
145
91188b6 Improved installation instructions.
jgm@berkeley.edu authored Oct 9, 2010
146 make prep
147
148 or
149
ede8650 Initial commit.
jgm@berkeley.edu authored Feb 2, 2008
150 runghc ParseSyntaxFiles.hs xml
151
9eb5e60 ParseSyntaxFiles now modifies the cabal file's list of modules.
John MacFarlane authored Dec 22, 2011
152 Note that ParseSyntaxFiles.hs requires the HXT package (>= 9.0.0).
ede8650 Initial commit.
jgm@berkeley.edu authored Feb 2, 2008
153
0b4acae @jgm Fixed links in README - thanks to John Gabriele.
authored Feb 18, 2011
154 To get the current Kate syntax highlighting files, clone the kate
155 repository:
ede8650 Initial commit.
jgm@berkeley.edu authored Feb 2, 2008
156
0b4acae @jgm Fixed links in README - thanks to John Gabriele.
authored Feb 18, 2011
157 git clone git://anongit.kde.org/kate
ede8650 Initial commit.
jgm@berkeley.edu authored Feb 2, 2008
158
0b4acae @jgm Fixed links in README - thanks to John Gabriele.
authored Feb 18, 2011
159 The syntax definitions can then be found in
ede8650 Initial commit.
jgm@berkeley.edu authored Feb 2, 2008
160
0b4acae @jgm Fixed links in README - thanks to John Gabriele.
authored Feb 18, 2011
161 kate/part/syntax/data
ede8650 Initial commit.
jgm@berkeley.edu authored Feb 2, 2008
162
163 There is information on the syntax highlighting definitions at
164
0b4acae @jgm Fixed links in README - thanks to John Gabriele.
authored Feb 18, 2011
165 http://docs.kde.org/stable/en/kdesdk/kate/highlight.html
ede8650 Initial commit.
jgm@berkeley.edu authored Feb 2, 2008
166
a000418 Updated README.
jgm@berkeley.edu authored Feb 9, 2008
167 Thanks are due to all the authors of these syntax definitions.
168
169 Changes have been made to the following xml files (the originals have
170 been left in the directory, with .bkp extensions):
3245328 Added notes about xml files that have been modified.
jgm@berkeley.edu authored Feb 2, 2008
171
172 - javascript.xml: Fixed regex \s* (which matches empty string) by changes to DetectSpaces
173 - perl.xml: Fixed regexes - needed backslash-escapes before ] and ^
2826451 Removed BUGS; added link to github issue tracker in README.
John MacFarlane authored Dec 26, 2011
174 - base report bugs on the github issue tracker:
175 <https://github.com/jgm/highlighting-kate/issues>.
ede8650 Initial commit.
jgm@berkeley.edu authored Feb 2, 2008
176
Something went wrong with that request. Please try again.