Changes between Version 1 and Version 2 of TracSyntaxColoring


Ignore:
Timestamp:
07/30/08 10:19:04 (16 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracSyntaxColoring

    v1 v2  
    11= Syntax Coloring of Source Code = 
    2 Trac supports language-specific colorization (syntax highlighting) of source code in [wiki:WikiFormatting WikiFormatted] text and the [wiki:TracBrowser Source Browser]. 
     2Trac supports language-specific syntax highlighting of source code in [wiki:WikiFormatting wiki formatted] text and the [wiki: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] 
     8 * [http://www.codento.com/people/mtr/genscript/ GNU Enscript]  
    99 * [http://silvercity.sourceforge.net/ SilverCity] 
     10 * [http://pygments.pocoo.org/ Pygments] (but needs a plugin for 0.10, see [#AboutPygments below]) 
    1011 
    11 To activate syntax coloring, simply install either one (or more) of these packages. No additional configuration is needed. 
     12To 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 
    1215 
    1316When in use, Trac will automatically prioritize !SilverCity highlighting over Enscript if possible, (see note below).  
    … …  
    1821 
    1922=== 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. 
     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 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 
     31It'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. 
    2132 
    2233 
    2334== Syntax Coloring Support == 
    2435 
    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 || 
    42 || m4       ||   || X || 
    43 || Makefile ||   || X || 
    44 || Matlab   ||   || X || 
    45 || Objective-C|| || X || 
    46 || Pascal   ||   || X || 
    47 || * Perl   || X || X || 
    48 || * PHP    || X || X || 
    49 || PSP      || X ||   || 
    50 || Pyrex    ||   || X || 
    51 || * Python || X || X || 
    52 || * Ruby   || X || X || 
    53 || Scheme   ||   || X || 
    54 || Shell    ||   || X || 
    55 || SQL      || X || X || 
    56 || Troff    ||   || X || 
    57 || TCL      ||   || X || 
    58 || Tex      ||   || X || 
    59 || Verilog  ||   || X || 
    60 || VHDL     ||   || X || 
    61 || Visual Basic |||| X || 
    62 || VRML     ||   || X || 
    63 || XML      || X || X || 
     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 || 
    6486 
    6587''(*) Supported as inline code blocks in [wiki:WikiFormatting Wiki text] using WikiProcessors.'' 
    6688 
     89''(1) Ruby highlighting is not included in the Enscript distribution.  Highlighting rules for Ruby can be obtained from: http://neugierig.org/software/ruby/ 
     90 
     91''(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 
     92 
     93''(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 
     94 
     95''(4) since Silvercity 0.9.7 released on 2006-11-23 
     96 
     97''(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"]. 
     98 
    6799== Extra Software == 
    68  * GNU Enscript -- http://people.ssh.fi/mtr/genscript/ 
     100 * GNU Enscript -- http://directory.fsf.org/GNU/enscript.html 
     101 * GNU Enscript for Windows -- http://gnuwin32.sourceforge.net/packages/enscript.htm 
    69102 * !SilverCity -- http://silvercity.sf.net/ 
     103 * Pygments -- http://pygments.org/ 
    70104 
    71105---- 
    72106See also: WikiProcessors, WikiFormatting, TracWiki, TracBrowser 
     107