Changes between Version 5 and Version 6 of TracSyntaxColoring


Ignore:
Timestamp:
01/24/11 13:44:26 (15 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracSyntaxColoring

    v5 v6  
    1  
    21= Syntax Coloring of Source Code = 
    32Trac supports language-specific syntax highlighting of source code in [wiki:WikiFormatting wiki formatted] text and the [wiki:TracBrowser repository browser]. 
    … …  
    98 * [http://www.codento.com/people/mtr/genscript/ GNU Enscript]  
    109 * [http://silvercity.sourceforge.net/ SilverCity] 
     10 * [http://pygments.pocoo.org/ Pygments] (but needs a plugin for 0.10, see [#AboutPygments below]) 
    1111 
    1212To 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 
     14If 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 
    1315 
    1416When in use, Trac will automatically prioritize !SilverCity highlighting over Enscript if possible, (see note below).  
    … …  
    1820'''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. 
    1921 
    20 === About SilverCity === 
    21 !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. 
     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 
     27Starting 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 
     29To 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 
     31The 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].  
     32 
     33It'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. 
    2234 
    2335 
    2436== Syntax Coloring Support == 
    2537 
    26 || || !SilverCity || Enscript || 
    27 || Ada      ||   || X || 
    28 || Asm      ||   || X || 
    29 || * ASP    || X || X || 
    30 || * C      || X || X || 
    31 || * C#     ||   || X(2) || 
    32 || * C++    || X || X || 
    33 || * Java   ||   || X || 
    34 || Awk      ||   || X || 
    35 || CSS      || X ||   || 
    36 || Diff     ||   || X || 
    37 || Eiffel   ||   || X || 
    38 || Elisp    ||   || X || 
    39 || Fortran  ||   || X || 
    40 || Haskell  ||   || X || 
    41 || HTML     || X || X || 
    42 || IDL      ||   || X || 
    43 || Javascript || X || X || 
    44 || m4       ||   || X || 
    45 || Makefile ||   || X || 
    46 || Matlab   ||   || X || 
    47 || Objective-C|| || X || 
    48 || Pascal   ||   || X || 
    49 || * Perl   || X || X || 
    50 || * PHP    || X || X || 
    51 || PSP      || X ||   || 
    52 || Pyrex    ||   || X || 
    53 || * Python || X || X || 
    54 || * Ruby   || X || X (1) || 
    55 || Scheme   ||   || X || 
    56 || Shell    ||   || X || 
    57 || SQL      || X || X || 
    58 || Troff    ||   || X || 
    59 || TCL      ||   || X || 
    60 || Tex      ||   || X || 
    61 || Verilog  ||   || X || 
    62 || VHDL     ||   || X || 
    63 || Visual Basic |||| X || 
    64 || VRML     ||   || X || 
    65 || XML      || X ||  || 
     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) || 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 || 
    6688 
    6789''(*) Supported as inline code blocks in [wiki:WikiFormatting Wiki text] using WikiProcessors.'' 
    … …  
    7193''(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 
    7294 
     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 
     96 
     97''(4) since Silvercity 0.9.7 released on 2006-11-23 
     98 
     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"]. 
     100 
    73101== Extra Software == 
    74102 * GNU Enscript -- http://directory.fsf.org/GNU/enscript.html 
    75103 * GNU Enscript for Windows -- http://gnuwin32.sourceforge.net/packages/enscript.htm 
    76104 * !SilverCity -- http://silvercity.sf.net/ 
     105 * Pygments -- http://pygments.org/ 
    77106 
    78107---- 
    79108See also: WikiProcessors, WikiFormatting, TracWiki, TracBrowser 
     109