Changes between Version 1 and Version 2 of TracSyntaxColoring


Ignore:
Timestamp:
Apr 13, 2011, 9:00:09 PM (14 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://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])
     8 * [http://pygments.pocoo.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
     10 * [http://silvercity.sourceforge.net/ SilverCity], legacy system, some versions can be [http://trac.edgewall.org/wiki/TracFaq#why-is-my-css-code-not-being-highlighted-even-though-i-have-silvercity-installed problematic]
    1111
    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`.
    1312
    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
     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.
    1515
    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.
    2416
    2517=== About Pygments ===
    2618
    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.
     19Starting 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].
    2820
    29 To use pygments in trac 0.11 you just have to install pygments 0.6 or higher.  If you want to use it in trac 0.10 too you have to install the [th:TracPygmentsPlugin TracPygmentsPlugin] from trac hacks. If you encounter any bugs, please file tickets regarding Pygments at [http://dev.pocoo.org/projects/pygments/ the Pygments Trac site].
    30 
    31 The Pygments default style can specified in the [TracIni#mimeviewer-section mime-viewer] section of trac.ini. The default style can be over-ridden by setting a Style preference on the [/prefs/pygments preferences page].
     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].
    3222
    3323It'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.
    … …  
    3626== Syntax Coloring Support ==
    3727
    38 || || !SilverCity || Enscript || Pygments ||
    39 || Ada      ||   || X || ||
    40 || Asm      ||   || X || ||
    41 || Apache Conf (htaccess)) || || || X ||
    42 || * ASP    || X || X || ||
    43 || * C      || X || X || X ||
    44 || * C#     ||   || X(2) || X ||
    45 || * C++    || X || X || X ||
    46 || * Java   || X(4)|| X || X ||
    47 || Awk      ||   || X || ||
    48 || Boo || || || X ||
    49 || CSS      || X ||   || X ||
    50 || Python Doctests || || || X ||
    51 || Diff     ||   || X || X ||
    52 || Eiffel   ||   || X || ||
    53 || Elisp    ||   || X || ||
    54 || Fortran  ||   || X(3) || X ||
    55 || Haskell  ||   || X || X ||
    56 || Genshi || || || X ||
    57 || HTML     || X || X || X ||
    58 || IDL      ||   || X || ||
    59 || INI || || || X ||
    60 || Javascript || X || X || X ||
    61 || Lua || || || X ||
    62 || m4       ||   || X || ||
    63 || Makefile ||   || X || X ||
    64 || Mako || || || X ||
    65 || Matlab   ||   || X (5) || ||
    66 || Mygthy || || || X ||
    67 || Objective-C|| || X ||X ||
    68 || OCaml    ||   ||   || X ||
    69 || Pascal   ||   || X || X ||
    70 || * Perl   || X || X || X ||
    71 || * PHP    || X ||   || X ||
    72 || PSP      || X ||   || ||
    73 || Pyrex    ||   || X || ||
    74 || * Python || X || X || X ||
    75 || * Ruby   || X || X (1) || X ||
    76 || Scheme   ||   || X || X ||
    77 || Shell    ||   || X || X ||
    78 || Smarty || || || X ||
    79 || SQL      || X || X || X ||
    80 || Troff    ||   || X || X ||
    81 || TCL      ||   || X || ||
    82 || Tex      ||   || X || X ||
    83 || Verilog  || X(4) || X || ||
    84 || VHDL     ||   || X || ||
    85 || Visual Basic |||| X || X ||
    86 || VRML     ||   || X || ||
    87 || XML      || X ||  || X ||
     28=== Known MIME Types
    8829
    89 ''(*) Supported as inline code blocks in [wiki:WikiFormatting Wiki text] using WikiProcessors.''
     30[[KnownMimeTypes]]
    9031
    91 ''(1) Ruby highlighting is not included in the Enscript distribution.  Highlighting rules for Ruby can be obtained from: http://neugierig.org/software/ruby/
    9232
    93 ''(2) C# highlighting is not included in the Enscript distribution.  Highlighting rules for C# can be obtained from: http://wiki.hasno.info/index.php/Csharp.st
     33=== List of Languages Supported, by Highlighter #language-supported
    9434
    95 ''(3) Fortran: as packaged, Enscript only supports the fixed source form. Highlighting rules for Fortran 90x/2003 can be obtained from: http://wiki.hasno.info/index.php/F90.st
     35This list is only indicative.
    9636
    97 ''(4) since Silvercity 0.9.7 released on 2006-11-23
     37||                 ||= !SilverCity   =||= Enscript      =||= Pygments =||
     38|| Ada             ||                 ||  ✓              ||     ||
     39|| Asm             ||                 ||  ✓              ||     ||
     40|| Apache Conf     ||                 ||                 ||  ✓  ||
     41|| ASP             ||  ✓              ||  ✓              ||     ||
     42|| C               ||  ✓              ||  ✓              ||  ✓  ||
     43|| C#              ||                 ||  ✓ ^[#a1 (1)]^  ||  ✓  ||
     44|| C++             ||  ✓              ||  ✓              ||  ✓  ||
     45|| Java            ||  ✓ ^[#a2 (2)]^  ||  ✓              ||  ✓  ||
     46|| Awk             ||                 ||  ✓              ||     ||
     47|| Boo             ||                 ||                 ||  ✓  ||
     48|| CSS             ||  ✓              ||                 ||  ✓  ||
     49|| Python Doctests ||                 ||                 ||  ✓  ||
     50|| Diff            ||                 ||  ✓              ||  ✓  ||
     51|| Eiffel          ||                 ||  ✓              ||     ||
     52|| Elisp           ||                 ||  ✓              ||     ||
     53|| Fortran         ||                 ||  ✓ ^[#a1 (1)]^  ||  ✓  ||
     54|| Haskell         ||                 ||  ✓              ||  ✓  ||
     55|| Genshi          ||                 ||                 ||  ✓  ||
     56|| HTML            ||  ✓              ||  ✓              ||  ✓  ||
     57|| IDL             ||                 ||  ✓              ||     ||
     58|| INI             ||                 ||                 ||  ✓  ||
     59|| Javascript      ||  ✓              ||  ✓              ||  ✓  ||
     60|| Lua             ||                 ||                 ||  ✓  ||
     61|| m4              ||                 ||  ✓              ||     ||
     62|| Makefile        ||                 ||  ✓              ||  ✓  ||
     63|| Mako            ||                 ||                 ||  ✓  ||
     64|| Matlab ^[#a3 (3)]^  ||             ||  ✓              ||  ✓  ||
     65|| Mygthy          ||                 ||                 ||  ✓  ||
     66|| Objective-C     ||                 ||  ✓              ||  ✓  ||
     67|| OCaml           ||                 ||                 ||  ✓  ||
     68|| Pascal          ||                 ||  ✓              ||  ✓  ||
     69|| Perl            ||  ✓              ||  ✓              ||  ✓  ||
     70|| PHP             ||  ✓              ||                 ||  ✓  ||
     71|| PSP             ||  ✓              ||                 ||     ||
     72|| Pyrex           ||                 ||  ✓              ||     ||
     73|| Python          ||  ✓              ||  ✓              ||  ✓  ||
     74|| Ruby            ||  ✓              ||  ✓ ^[#a1 (1)]^  ||  ✓  ||
     75|| Scheme          ||                 ||  ✓              ||  ✓  ||
     76|| Shell           ||                 ||  ✓              ||  ✓  ||
     77|| Smarty          ||                 ||                 ||  ✓  ||
     78|| SQL             ||  ✓              ||  ✓              ||  ✓  ||
     79|| Troff           ||                 ||  ✓              ||  ✓  ||
     80|| TCL             ||                 ||  ✓              ||     ||
     81|| Tex             ||                 ||  ✓              ||  ✓  ||
     82|| Verilog         ||  ✓ ^[#a2 (2)]^  ||  ✓              ||     ||
     83|| VHDL            ||                 ||  ✓              ||     ||
     84|| Visual Basic    ||                 ||  ✓              ||  ✓  ||
     85|| VRML            ||                 ||  ✓              ||     ||
     86|| XML             ||  ✓              ||                 ||  ✓  ||
    9887
    99 ''(5) By default `.m` files are considered Objective-C files. In order to treat `.m` files as MATLAB files, add "text/x-matlab:m" to the "mime_map" setting in the [wiki:TracIni#mimeviewer-section "[mimeviewer] section of trac.ini"].
     88
     89
     90''[=#a1 (1)] Not included in the Enscript distribution.  Additional highlighting rules can be obtained for
     91[http://neugierig.org/software/ruby/ Ruby],
     92[http://wiki.hasno.info/index.php/Csharp.st C#],
     93[http://wiki.hasno.info/index.php/F90.st Fortran 90x/2003]
     94
     95''[=#a2 (2)] since Silvercity 0.9.7 released on 2006-11-23
     96
     97''[=#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"].
    10098
    10199== Extra Software ==
    … …  
    107105----
    108106See also: WikiProcessors, WikiFormatting, TracWiki, TracBrowser
    109