| 1 | | = Syntax Coloring of Source Code = |
| 2 | | Trac supports language-specific syntax highlighting of source code in [wiki:WikiFormatting wiki formatted] text and the [wiki:TracBrowser repository browser]. |
| 3 | | |
| 4 | | To do this, Trac uses external libraries with support for a great number of programming languages. |
| 5 | | |
| 6 | | Currently Trac supports syntax coloring using one or more of the following packages: |
| 7 | | |
| 8 | | * [http://www.codento.com/people/mtr/genscript/ GNU Enscript] |
| 9 | | * [http://silvercity.sourceforge.net/ SilverCity] |
| 10 | | * [http://pygments.pocoo.org/ Pygments] (but needs a plugin for 0.10, see [#AboutPygments below]) |
| 11 | | |
| 12 | | To activate syntax coloring, simply install either one (or more) of these packages. No additional configuration is required, however to modify the colors, have a look at `trac/htdocs/css/code.css`. |
| 13 | | |
| 14 | | If you don't know why trac isnt detecting an installed library, try turning on Trac logging. It actually appears that Trac is broken with SilverCity 0.9.6. Either use the current 0.9.7 or the older 0.9.5 http://trac.edgewall.org/wiki/TracFaq#why-is-my-css-code-not-being-highlighted-even-though-i-have-silvercity-installed |
| 15 | | |
| 16 | | When in use, Trac will automatically prioritize !SilverCity highlighting over Enscript if possible, (see note below). |
| 17 | | |
| 18 | | If neither package is available, Trac will display the data as plain text. |
| 19 | | |
| 20 | | '''Note:''' Enscript supports a greater number of languages, however !SilverCity is generally faster since it is a library and isn't executed in an external process. |
| 21 | | |
| 22 | | === About SilverCity === |
| 23 | | !SilverCity uses the lexer from [http://www.scintilla.org/ Scintilla]. Scintilla supports more languages than !SilverCity implements. If you want to add a language to !SilverCity supported by Scintilla, it's not very difficult. See [http://trac.edgewall.org/wiki/SilverCityAddLanguage SilverCityAddLanguage] for some information how. |
| 24 | | |
| 25 | | === About Pygments === |
| 26 | | |
| 27 | | Starting 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]. While it does not support as many languages as Enscript or Scintilla the overall output quality is much better. |
| 28 | | |
| 29 | | To use pygments trac 0.11 you just have to install pygments 0.5.1 or higher. If you want to use it in trac 0.10 too you have to install the [http://trac-hacks.org/wiki/TracPygmentsPlugin TracPygmentsPlugin] from trac hacks. If you encounter any bugs, please file tickets regarding Pygments in [http://dev.pocoo.org/projects/pygments/ the pygments trac]. |
| 30 | | |
| 31 | | 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 [http://pygments.org/docs/lexers/ supported lexers] on the pygments webpage. |
| | 1 | = Syntax Coloring of Source Code |
| | 2 | 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]. Syntax coloring is provided using [http://pygments.org/ 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. |
| 36 | | || || !SilverCity || Enscript || Pygments || |
| 37 | | || Ada || || X || || |
| 38 | | || Asm || || X || || |
| 39 | | || Apache Conf (htaccess)) || || || X || |
| 40 | | || * ASP || X || X || || |
| 41 | | || * C || X || X || X || |
| 42 | | || * C# || || X(2) || X || |
| 43 | | || * C++ || X || X || X || |
| 44 | | || * Java || X(4)|| X || X || |
| 45 | | || Awk || || X || || |
| 46 | | || Boo || || || X || |
| 47 | | || CSS || X || || X || |
| 48 | | || Python Doctests || || || X || |
| 49 | | || Diff || || X || X || |
| 50 | | || Eiffel || || X || || |
| 51 | | || Elisp || || X || || |
| 52 | | || Fortran || || X(3) || || |
| 53 | | || Haskell || || X || X || |
| 54 | | || Genshi || || || X || |
| 55 | | || HTML || X || X || X || |
| 56 | | || IDL || || X || || |
| 57 | | || INI || || || X || |
| 58 | | || Javascript || X || X || X || |
| 59 | | || Lua || || || X || |
| 60 | | || m4 || || X || || |
| 61 | | || Makefile || || X || X || |
| 62 | | || Mako || || || X || |
| 63 | | || Matlab || || X (5) || || |
| 64 | | || Mygthy || || || X || |
| 65 | | || Objective-C|| || X || || |
| 66 | | || OCaml || || || X || |
| 67 | | || Pascal || || X || X || |
| 68 | | || * Perl || X || X || X || |
| 69 | | || * PHP || X || || X || |
| 70 | | || PSP || X || || || |
| 71 | | || Pyrex || || X || || |
| 72 | | || * Python || X || X || X || |
| 73 | | || * Ruby || X || X (1) || X || |
| 74 | | || Scheme || || X || X || |
| 75 | | || Shell || || X || X || |
| 76 | | || Smarty || || || X || |
| 77 | | || SQL || X || X || X || |
| 78 | | || Troff || || X || X || |
| 79 | | || TCL || || X || || |
| 80 | | || Tex || || X || X || |
| 81 | | || Verilog || X(4) || X || || |
| 82 | | || VHDL || || X || || |
| 83 | | || Visual Basic |||| X || X || |
| 84 | | || VRML || || X || || |
| 85 | | || XML || X || || X || |
| | 7 | [http://pygments.org/ Pygments] is a highlighting library implemented in pure python, very fast, easy to extend and [http://pygments.org/docs/ well documented]. |
| 99 | | == Extra Software == |
| 100 | | * GNU Enscript -- http://directory.fsf.org/GNU/enscript.html |
| 101 | | * GNU Enscript for Windows -- http://gnuwin32.sourceforge.net/packages/enscript.htm |
| 102 | | * !SilverCity -- http://silvercity.sf.net/ |
| 103 | | * Pygments -- http://pygments.org/ |
| | 21 | 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`. |
| | 22 | |
| | 23 | === Direct Rendering |
| | 24 | |
| | 25 | 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. |
| | 26 | |
| | 27 | 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. |
| | 28 | |
| | 29 | 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. |
| | 30 | |
| | 31 | === Known MIME types |
| | 32 | |
| | 33 | [[KnownMimeTypes]] |
