TracSyntaxColoring

From Begrid Wiki
Jump to navigationJump to search

Syntax Coloring of Source Code

Trac supports language-specific syntax highlighting of source code within wiki formatted text in [WikiProcessors#CodeHighlightingSupport wiki processors] blocks and in the [TracBrowser repository browser].

To do this, Trac uses external libraries with support for a great number of programming languages.

Currently Trac supports syntax coloring using one or more of the following packages:

  • Pygments, by far the preferred system, as it covers a wide range of programming languages and other structured texts and is actively supported
  • GNU Enscript, commonly available on Unix but somewhat unsupported on Windows
  • SilverCity, legacy system, some versions can be problematic


To activate syntax coloring, simply install either one (or more) of these packages (see [#ExtraSoftware] section below). If none of these packages is available, Trac will display the data as plain text.


About Pygments

Starting with trac 0.11 pygments will be the new default highlighter. It's a highlighting library implemented in pure python, very fast, easy to extend and well documented.

The 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].

It'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 supported lexers on the pygments webpage.


Syntax Coloring Support

=== Known MIME Types

KnownMimeTypes

Note 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.

In 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.

HTML 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.

If mimetype such as 'svn:mime-type' is set to 'text/plain', there is no coloring even if file is known type like 'java'.

=== List of Languages Supported, by Highlighter #language-supported

This list is only indicative.

= SilverCity = = Enscript = = Pygments =
Ada
Asm
Apache Conf
ASP
C
C# [#a1 (1)]
C++
CMake ? ?
Java [#a2 (2)]
Awk
Boo
CSS
Python Doctests
Diff
Eiffel
Elisp
Fortran [#a1 (1)]
Haskell
Genshi
HTML
IDL
INI
Javascript
Lua
m4
Makefile
Mako
Matlab [#a3 (3)]
Mygthy
Objective-C
OCaml
Pascal
Perl
PHP
PSP
Pyrex
Python
Ruby [#a1 (1)]
Scheme
Shell
Smarty
SQL
Troff
TCL
Tex
Verilog [#a2 (2)]
VHDL
Visual Basic
VRML
XML



[=#a1 (1)] Not included in the Enscript distribution. Additional highlighting rules can be obtained for Ruby, C#, Fortran 90x/2003

[=#a2 (2)] since Silvercity 0.9.7 released on 2006-11-23

[=#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 "[mimeviewer section of trac.ini"].

Extra Software


See also: WikiProcessors, WikiFormatting, TracWiki, TracBrowser


Template:TracNotice