|Version 1 (modified by 5 years ago) ( diff ),|
Syntax Coloring of Source Code
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 (use is deprecated)
- SilverCity, legacy system, some versions can be problematic (use is deprecated)
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.
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
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
If a mimetype property 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
This list is only indicative.
(2) since Silvercity 0.9.7 released on 2006-11-23
(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.
- GNU Enscript — http://www.gnu.org/software/enscript/
- GNU Enscript for Windows — http://gnuwin32.sourceforge.net/packages/enscript.htm
- SilverCity — http://silvercity.sf.net/
- Pygments — http://pygments.org/