Changes between Version 1 and Version 2 of TracSyntaxColoring


Ignore:
Timestamp:
Aug 15, 2016, 5:36:15 PM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracSyntaxColoring

    v1 v2  
    11= 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].
     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].
    33
    44To do this, Trac uses external libraries with support for a great number of programming languages.
    … …  
    66Currently Trac supports syntax coloring using one or more of the following packages:
    77
    8  * [http://people.ssh.fi/mtr/genscript/ GNU Enscript]
    9  * [http://silvercity.sourceforge.net/ SilverCity]
     8 * [http://pygments.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 //(use is deprecated)//
     10 * [http://silvercity.sourceforge.net/ SilverCity], legacy system, some versions can be problematic //(use is deprecated)//
    1011
    11 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`.
    1212
    13 When in use, Trac will automatically prioritize !SilverCity highlighting over Enscript if possible, (see note below).
     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.
    1415
    15 If neither package is available, Trac will display the data as plain text.
    1616
    17 '''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.
     17=== About Pygments ===
    1818
    19 === About SilverCity ===
    20 !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://projects.edgewall.com/trac/wiki/SilverCityAddLanguage SilverCityAddLanguage] for some information how.
     19[http://pygments.org/ Pygments] is 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.
    2124
    2225
    2326== Syntax Coloring Support ==
    2427
    25 || || !SilverCity || Enscript ||
    26 || Ada      ||   || X ||
    27 || Asm      ||   || X ||
    28 || * ASP    || X || X ||
    29 || * C      || X || X ||
    30 || * C++    || X || X ||
    31 || * Java   ||   || X ||
    32 || Awk      ||   || X ||
    33 || CSS      || X ||   ||
    34 || Diff     ||   || X ||
    35 || Eiffel   ||   || X ||
    36 || Elisp    ||   || X ||
    37 || Fortran  ||   || X ||
    38 || Haskell  ||   || X ||
    39 || HTML     || X || X ||
    40 || IDL      ||   || X ||
    41 || Javascript || X || X ||
     28=== Known MIME Types
    4229
    43 || m4       ||   || X ||
    44 || Makefile ||   || X ||
    45 || Matlab   ||   || X ||
    46 || Objective-C|| || X ||
    47 || Pascal   ||   || X ||
    48 || * Perl   || X || X ||
    49 || * PHP    || X || X ||
    50 || PSP      || X ||   ||
    51 || Pyrex    ||   || X ||
    52 || * Python || X || X ||
    53 || * Ruby   || X || X (1) ||
    54 || Scheme   ||   || X ||
    55 || Shell    ||   || X ||
    56 || SQL      || X || X ||
    57 || Troff    ||   || X ||
    58 || TCL      ||   || X ||
    59 || Tex      ||   || X ||
    60 || Verilog  ||   || X ||
    61 || VHDL     ||   || X ||
    62 || Visual Basic |||| X ||
    63 || VRML     ||   || X ||
    64 || XML      || X || X ||
     30[[KnownMimeTypes]]
    6531
    66 ''(*) Supported as inline code blocks in [wiki:WikiFormatting Wiki text] using WikiProcessors.''
     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.
    6733
    68 ''(1) Ruby highlighting is not included in the Enscript distribution.  Highlighting rules for Ruby can be obtained from: http://neugierig.org/software/ruby/
     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 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'.
     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"].
    69106
    70107== Extra Software ==
    71  * GNU Enscript -- http://people.ssh.fi/mtr/genscript/
    72  * !SilverCity -- http://silvercity.sf.net/
     108 * GNU Enscript — http://www.gnu.org/software/enscript/
     109 * GNU Enscript for Windows — http://gnuwin32.sourceforge.net/packages/enscript.htm
     110 * !SilverCity — http://silvercity.sf.net/
     111 * **Pygments — http://pygments.org/**
    73112
    74113----