Syntax Coloring of Source Code
Trac supports language-specific syntax highlighting of source code within wiki formatted text in wiki processors blocks and in the repository browser. Syntax coloring is provided using Pygments, which covers a wide range of programming languages and other structured texts, and is actively supported. If Pygments is not available, Trac will display the content as plain text.
About Pygments
Pygments is a highlighting library implemented in pure python, very fast, easy to extend and well documented.
The Pygments default style can specified in the mime-viewer section of trac.ini. The default style can be overridden by setting a Style preference on the preferences page.
Pygments lexer options can be specified as WikiProcessor arguments and defaults can be set in the environment configuration.
Syntax Coloring Support
Supported languages
The list of currently supported languages can be found on the supported languages page. The list represents the languages supported in the most recent version of Pygments, so the languages actually supported in your installation could differ if you have an older version installed. The listing of supported lexers provides additional information about the default mime type to keyword mappings.
Explicit control of the mime type associated with a WikiProcessor and file extension is available through the mime_map setting. For example, by default .m files are considered Objective-C files. In order to treat .m files as MATLAB files, add text/matlab:m to the [mimeviewer] mime_map option.
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.
Direct Rendering
Rich content may be directly rendered instead of syntax highlighted. This usually depends on which auxiliary packages are installed and 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. It will be syntax highlighted otherwise.
Similarly, 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. If you want to ensure that an HTML document gets syntax highlighted and not rendered, use the text/xml mimetype.
HTML documents are directly rendered only if the render_unsafe_html settings are enabled in your TracIni file. See [attachment] render_unsafe_content, [browser] render_unsafe_content and [wiki] render_unsafe_content. The setting is present in multiple sections because there are different security concerns depending on where the document comes from.
Known MIME types
| MIME Types | WikiProcessors |
|---|---|
| application/atom+xml | xml |
| application/json | json |
| application/msword | doc dot |
| application/pdf | pdf |
| application/postscript | postscript ps |
| application/rss+xml | rss |
| application/rtf | rtf |
| application/x-awk | awk gawk mawk nawk |
| application/x-befunge | befunge |
| application/x-brainfuck | bf brainfuck |
| application/x-clojure | clj clojure |
| application/x-coldfusion | cfm |
| application/x-csh | csh tcsh |
| application/x-cython | cython pyx |
| application/x-dos-batch | bat |
| application/x-ecl | ecl |
| application/x-evoque | evoque |
| application/x-fantom | fan |
| application/x-gooddata-maql | maql |
| application/x-httpd-php5 | html+php |
| application/x-hybris | hy hybris |
| application/x-jinja | django jinja |
| application/x-jsp | jsp |
| application/x-kid | genshi kid xml+genshi xml+kid |
| application/x-lua | lua |
| application/x-mako | mako |
| application/x-mason | mason |
| application/x-moonscript | moon moonscript |
| application/x-myghty | myghty |
| application/x-newlisp | newlisp |
| application/x-openedge | abl openedge progress |
| application/x-perl | perl pl |
| application/x-pygments-tokens | raw |
| application/x-pypylog | pypy pypylog |
| application/x-python | py python |
| application/x-python3 | py3 python3 |
| application/x-ruby | duby rb ruby |
| application/x-ruby-templating | erb |
| application/x-scheme | scheme scm |
| application/x-shell-session | console |
| application/x-shellscript | bash ksh sh |
| application/x-smarty | smarty |
| application/x-spitfire | cheetah spitfire |
| application/x-ssp | ssp |
| application/x-standardml | sml |
| application/x-tcl | tcl |
| application/x-troff | roff troff |
| application/x-urbiscript | urbiscript |
| application/x-yaml | yml |
| application/xhtml+xml | html |
| application/xml+evoque | xml+evoque |
| application/xml+jinja | xml+django xml+jinja |
| application/xml+mako | xml+mako |
| application/xml+myghty | xml+myghty |
| application/xml+php | xml+php |
| application/xml+ruby | xml+erb xml+ruby |
| application/xml+smarty | xml+smarty |
| application/xml+spitfire | xml+cheetah xml+spitfire |
| application/xml+velocity | xml+velocity |
| application/xml-dtd | dtd |
| application/xquery | xquery xqy |
| application/xsl+xml | xsl |
| application/xslt+xml | xslt |
| image/svg+xml | svg |
| image/x-icon | ico |
| model/vrml | vrml wrl |
| text/R | r s splus |
| text/actionscript | actionscript3 as3 |
| text/actionscript3 | actionscript as |
| text/coffeescript | coffee-script coffeescript |
| text/css | css |
| text/css+genshi | css+genshi css+genshitext |
| text/css+jinja | css+django css+jinja |
| text/css+mako | css+mako |
| text/css+myghty | css+myghty |
| text/css+php | css+php |
| text/css+ruby | css+erb css+ruby |
| text/css+smarty | css+smarty |
| text/gettext | po pot |
| text/haxe | haXe hx |
| text/html | htm |
| text/html+evoque | html+evoque |
| text/html+genshi | html+genshi html+kid |
| text/html+jinja | html+django html+jinja |
| text/html+mako | html+mako |
| text/html+myghty | html+myghty |
| text/html+ruby | html+erb html+ruby rhtml |
| text/html+smarty | html+smarty |
| text/html+spitfire | html+cheetah html+spitfire |
| text/html+velocity | html+velocity |
| text/javascript | javascript js |
| text/javascript+genshi | javascript+genshi javascript+genshitext js+genshi js+genshitext |
| text/javascript+jinja | javascript+django javascript+jinja js+django js+jinja |
| text/javascript+mako | javascript+mako js+mako |
| text/javascript+mygthy | javascript+myghty js+myghty |
| text/javascript+php | javascript+php js+php |
| text/javascript+ruby | javascript+erb javascript+ruby js+erb js+ruby |
| text/javascript+smarty | javascript+smarty js+smarty |
| text/javascript+spitfire | javascript+cheetah javascript+spitfire js+cheetah js+spitfire |
| text/matlab | matlab |
| text/octave | octave |
| text/plain | AUTHORS COPYING ChangeLog INSTALL README RELEASE TXT text txt |
| text/prs.fallenstein.rst | rest restructuredtext rst |
| text/scilab | scilab |
| text/troff | groff man nroff |
| text/x-abap | abap |
| text/x-ada | ada ada95ada2005 adb ads |
| text/x-apacheconf | aconf apache apacheconf |
| text/x-asm | asm |
| text/x-asp | asp |
| text/x-asymptote | asy asymptote |
| text/x-autohotkey | ahk |
| text/x-bbcode | bbcode |
| text/x-bmx | blitzmax bmax |
| text/x-boo | boo |
| text/x-c++hdr | H HH c++hdr hh hpp |
| text/x-c++src | C C++ CC c++ c++src cc cpp |
| text/x-c-objdump | c-objdump |
| text/x-chdr | chdr h |
| text/x-cmake | cmake |
| text/x-common-lisp | cl common-lisp |
| text/x-coq | coq |
| text/x-cpp-objdump | c++-objdumb cpp-objdump cxx-objdump |
| text/x-csharp | C# c# cs csharp |
| text/x-csrc | c csrc xs |
| text/x-d-objdump | d-objdump |
| text/x-dart | dart |
| text/x-diff | patch |
| text/x-dsrc | d |
| text/x-dylan | dylan |
| text/x-ecsrc | ec |
| text/x-eiffel | e eiffel |
| text/x-elisp | el elisp |
| text/x-elixir | elixir ex exs |
| text/x-elixir-shellsession | iex |
| text/x-erl-shellsession | erl |
| text/x-erlang | erlang |
| text/x-factor | factor |
| text/x-fancysrc | fancy fy |
| text/x-felix | felix flx |
| text/x-fortran | f fortran |
| text/x-fsharp | fsharp |
| text/x-gas | gas |
| text/x-genshi | genshitext |
| text/x-gherkin | Cucumber Gherkin cucumber gherkin |
| text/x-glslsrc | glsl |
| text/x-gnuplot | gnuplot |
| text/x-gooddata-cl | gooddata-cl |
| text/x-gosrc | go |
| text/x-gosu | gosu |
| text/x-gosu-template | gst |
| text/x-groovy | groovy |
| text/x-haml | HAML haml |
| text/x-haskell | haskell hs |
| text/x-idl | ice idl |
| text/x-inf | inf |
| text/x-ini | cfg ini |
| text/x-iokesrc | ik ioke |
| text/x-iosrc | io |
| text/x-irclog | irc |
| text/x-jade | JADE jade |
| text/x-java | java |
| text/x-java-properties | properties |
| text/x-jbst | Duel Engine Duel View JBST JsonML+BST duel jbst |
| text/x-kotlin | kotlin |
| text/x-latex | latex tex |
| text/x-lighttpd-conf | lighttpd lighty |
| text/x-literate-haskell | lhs literate-haskell |
| text/x-llvm | llvm |
| text/x-logtalk | logtalk |
| text/x-m4 | m4 |
| text/x-mail | mail |
| text/x-makefile | GNUMakefile Makefile bsdmake make makefile mf mk |
| text/x-minidsrc | minid |
| text/x-modelica | modelica |
| text/x-modula2 | m2 modula2 |
| text/x-moocode | moocode |
| text/x-mysql | mysql |
| text/x-nasm | nasm |
| text/x-nemerle | nemerle |
| text/x-newspeak | newspeak |
| text/x-nginx-conf | nginx |
| text/x-nimrod | nim nimrod |
| text/x-objc | m mm |
| text/x-objdump | objdump |
| text/x-objective-c | obj-c objc objective-c objectivec |
| text/x-objective-j | obj-j objective-j objectivej objj |
| text/x-ocaml | ml mli ocaml |
| text/x-ooc | ooc |
| text/x-opa | opa |
| text/x-pascal | delphi objectpascal pas pascal |
| text/x-patch | diff udiff |
| text/x-perl | PL pm |
| text/x-php | php php3 php4 php5 |
| text/x-plpgsql | plpgsql |
| text/x-postgresql | postgres postgresql |
| text/x-postgresql-psql | postgres-console postgresql-console psql |
| text/x-povray | pov |
| text/x-powershell | posh powershell ps1 |
| text/x-prolog | prolog |
| text/x-psp | psp |
| text/x-pyrex | pyrex |
| text/x-python-doctest | pycon |
| text/x-python-traceback | pytb |
| text/x-python3-traceback | py3tb |
| text/x-rebol | rebol |
| text/x-rfc | rfc |
| text/x-ruby-shellsession | irb rbcon |
| text/x-sass | SASS sass |
| text/x-scala | scala |
| text/x-scaml | SCAML scaml |
| text/x-scss | scss |
| text/x-smalltalk | smalltalk squeak |
| text/x-snobol | snobol |
| text/x-sql | sql |
| text/x-sqlite3-console | sqlite3 |
| text/x-squidconf | squid squid.conf squidconf |
| text/x-systemverilog | sv |
| text/x-tea | tea |
| text/x-textile | textile txtl |
| text/x-trac-wiki | moin trac-wiki |
| text/x-vala | vala vapi |
| text/x-vba | bas vb vb.net vba vbnet |
| text/x-verilog | v verilog |
| text/x-vhdl | vhd vhdl |
| text/x-vim | vim |
| text/x-yaml | yaml |
| text/x-zsh | zsh |
See also: WikiProcessors, WikiFormatting, TracWiki, TracBrowser
