source: wiki/pages/TracSyntaxColoring @ 28823

Last change on this file since 28823 was 26484, checked in by obi, 6 years ago

add wiki pages

File size: 7.4 KB
Line 
1= Syntax Coloring of Source Code =
2Trac supports language-specific syntax highlighting of source code within wiki formatted text in [WikiProcessors#CodeHighlightingSupport wiki processors] blocks and in the [TracBrowser repository browser].
3
4To do this, Trac uses external libraries with support for a great number of programming languages.
5
6Currently Trac supports syntax coloring using one or more of the following packages:
7
8 * [http://pygments.pocoo.org/ Pygments], by far the preferred system, as it covers a wide range of programming languages and other structured texts and is actively supported
9 * [http://www.codento.com/people/mtr/genscript/ GNU Enscript], commonly available on Unix but somewhat unsupported on Windows
10 * [http://silvercity.sourceforge.net/ SilverCity], legacy system, some versions can be [http://trac.edgewall.org/wiki/TracFaq#why-is-my-css-code-not-being-highlighted-even-though-i-have-silvercity-installed problematic]
11
12
13To activate syntax coloring, simply install either one (or more) of these packages (see [#ExtraSoftware] section below).
14If none of these packages is available, Trac will display the data as plain text.
15
16
17=== About Pygments ===
18
19Starting with trac 0.11 [http://pygments.org/ pygments] will be the new default highlighter. It's a highlighting library implemented in pure python, very fast, easy to extend and [http://pygments.org/docs/ well documented].
20
21The Pygments default style can specified in the [TracIni#mimeviewer-section mime-viewer] section of trac.ini. The default style can be overridden by setting a Style preference on the [/prefs/pygments preferences page].
22
23It's very likely that the list below is outdated because the list of supported pygments lexers is growing weekly. Just have a look at the page of [http://pygments.org/docs/lexers/ supported lexers] on the pygments webpage.
24
25
26== Syntax Coloring Support ==
27
28=== Known MIME Types
29
30[[KnownMimeTypes]]
31
32Note that the rich content may be directly //rendered// instead of syntax highlighted. This usually depends on which auxiliary packages are installed and on which components are activated in your setup. For example a `text/x-rst` document will be rendered via `docutils` if it is installed and the `trac.mimeview.rst.ReStructuredTextRenderer` is not disabled, and will be syntax highlighted otherwise.
33
34In a similar way, a document with the mimetype `text/x-trac-wiki` is rendered using the Trac wiki formatter, unless the `trac.mimeview.api.WikiTextRenderer` component is disabled.
35
36HTML documents are directly rendered only if the `render_unsafe_html` settings are enabled in the TracIni (those settings are present in multiple sections, as there are different security concerns depending where the document comes from). If you want to ensure that an HTML document gets syntax highlighted and not rendered, use the `text/xml` mimetype.
37
38If mimetype such as 'svn:mime-type' is set to 'text/plain', there is no coloring even if file is known type like 'java'.
39
40=== List of Languages Supported, by Highlighter #language-supported
41
42This list is only indicative.
43
44||                 ||= !SilverCity   =||= Enscript      =||= Pygments =||
45|| Ada             ||                 ||  ✓              ||     ||
46|| Asm             ||                 ||  ✓              ||     ||
47|| Apache Conf     ||                 ||                 ||  ✓  ||
48|| ASP             ||  ✓              ||  ✓              ||     ||
49|| C               ||  ✓              ||  ✓              ||  ✓  ||
50|| C#              ||                 ||  ✓ ^[#a1 (1)]^  ||  ✓  ||
51|| C++             ||  ✓              ||  ✓              ||  ✓  ||
52|| CMake           ||  ?              ||  ?              ||  ✓  ||
53|| Java            ||  ✓ ^[#a2 (2)]^  ||  ✓              ||  ✓  ||
54|| Awk             ||                 ||  ✓              ||     ||
55|| Boo             ||                 ||                 ||  ✓  ||
56|| CSS             ||  ✓              ||                 ||  ✓  ||
57|| Python Doctests ||                 ||                 ||  ✓  ||
58|| Diff            ||                 ||  ✓              ||  ✓  ||
59|| Eiffel          ||                 ||  ✓              ||     ||
60|| Elisp           ||                 ||  ✓              ||     ||
61|| Fortran         ||                 ||  ✓ ^[#a1 (1)]^  ||  ✓  ||
62|| Haskell         ||                 ||  ✓              ||  ✓  ||
63|| Genshi          ||                 ||                 ||  ✓  ||
64|| HTML            ||  ✓              ||  ✓              ||  ✓  ||
65|| IDL             ||                 ||  ✓              ||     ||
66|| INI             ||                 ||                 ||  ✓  ||
67|| Javascript      ||  ✓              ||  ✓              ||  ✓  ||
68|| Lua             ||                 ||                 ||  ✓  ||
69|| m4              ||                 ||  ✓              ||     ||
70|| Makefile        ||                 ||  ✓              ||  ✓  ||
71|| Mako            ||                 ||                 ||  ✓  ||
72|| Matlab ^[#a3 (3)]^  ||             ||  ✓              ||  ✓  ||
73|| Mygthy          ||                 ||                 ||  ✓  ||
74|| Objective-C     ||                 ||  ✓              ||  ✓  ||
75|| OCaml           ||                 ||                 ||  ✓  ||
76|| Pascal          ||                 ||  ✓              ||  ✓  ||
77|| Perl            ||  ✓              ||  ✓              ||  ✓  ||
78|| PHP             ||  ✓              ||                 ||  ✓  ||
79|| PSP             ||  ✓              ||                 ||     ||
80|| Pyrex           ||                 ||  ✓              ||     ||
81|| Python          ||  ✓              ||  ✓              ||  ✓  ||
82|| Ruby            ||  ✓              ||  ✓ ^[#a1 (1)]^  ||  ✓  ||
83|| Scheme          ||                 ||  ✓              ||  ✓  ||
84|| Shell           ||                 ||  ✓              ||  ✓  ||
85|| Smarty          ||                 ||                 ||  ✓  ||
86|| SQL             ||  ✓              ||  ✓              ||  ✓  ||
87|| Troff           ||                 ||  ✓              ||  ✓  ||
88|| TCL             ||                 ||  ✓              ||     ||
89|| Tex             ||                 ||  ✓              ||  ✓  ||
90|| Verilog         ||  ✓ ^[#a2 (2)]^  ||  ✓              ||     ||
91|| VHDL            ||                 ||  ✓              ||     ||
92|| Visual Basic    ||                 ||  ✓              ||  ✓  ||
93|| VRML            ||                 ||  ✓              ||     ||
94|| XML             ||  ✓              ||                 ||  ✓  ||
95
96
97
98''[=#a1 (1)] Not included in the Enscript distribution.  Additional highlighting rules can be obtained for
99[http://neugierig.org/software/ruby/ Ruby],
100[http://wiki.hasno.info/index.php/Csharp.st C#],
101[http://wiki.hasno.info/index.php/F90.st Fortran 90x/2003]
102
103''[=#a2 (2)] since Silvercity 0.9.7 released on 2006-11-23
104
105''[=#a3 (3)] By default `.m` files are considered Objective-C files. In order to treat `.m` files as MATLAB files, add "text/matlab:m" to the "mime_map" setting in the [wiki:TracIni#mimeviewer-section "[mimeviewer] section of trac.ini"].
106
107== Extra Software ==
108 * GNU Enscript — http://directory.fsf.org/GNU/enscript.html
109 * GNU Enscript for Windows — http://gnuwin32.sourceforge.net/packages/enscript.htm
110 * !SilverCity — http://silvercity.sf.net/
111 * **Pygments — http://pygments.org/**
112
113----
114See also: WikiProcessors, WikiFormatting, TracWiki, TracBrowser
Note: See TracBrowser for help on using the repository browser.