Changes between Version 3 and Version 4 of TracSyntaxColoring


Ignore:
Timestamp:
Apr 24, 2017, 10:36:12 AM (4 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracSyntaxColoring

    v3 v4  
    1 = Syntax Coloring of Source Code =
     1[[PageOutline(2-5,Contents,pullout)]]
     2
     3= Syntax Coloring of Source Code
     4
     5
    26Trac supports language-specific syntax highlighting of source code within wiki formatted text in [WikiProcessors#CodeHighlightingSupport wiki processors] blocks and in the [TracBrowser repository browser].
    37
     
    610Currently Trac supports syntax coloring using one or more of the following packages:
    711
    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]
     12 * '''[http://pygments.org/ Pygments]''', the preferred system, as it covers a wide range of programming languages and other structured texts and is actively supported.
     13 * [http://www.codento.com/people/mtr/genscript/ GNU Enscript], commonly available on Unix, and has an [http://gnuwin32.sourceforge.net/packages/enscript.htm unsupported version] on Windows; use is deprecated.
     14 * [http://silvercity.sourceforge.net/ SilverCity], legacy system, some versions can be problematic; use is deprecated.
    1115
     16To activate syntax coloring, simply install either one (or more) of these packages. If none of these packages is available, Trac will display the data as plain text.
    1217
    13 To activate syntax coloring, simply install either one (or more) of these packages (see [#ExtraSoftware] section below).
    14 If none of these packages is available, Trac will display the data as plain text.
     18== About Pygments
    1519
     20Pygments is a highlighting library implemented in pure Python, very fast, easy to extend and [http://pygments.org/docs/ well documented].
    1621
    17 === About Pygments ===
     22The Pygments default style can specified in the [TracIni#mimeviewer-section mime-viewer] section of your TracIni file. The default style can be overridden by setting a Style preference on the [/prefs/pygments preferences page].
    1823
    19 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].
     24The list below contains only the most commonly used processors and the [http://pygments.org/docs/lexers/ list of supported Pygments lexers] is growing weekly.
    2025
    21 The 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 
    23 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.
    24 
    25 
    26 == Syntax Coloring Support ==
     26== Syntax Coloring Support
    2727
    2828=== Known MIME Types
     
    3030[[KnownMimeTypes]]
    3131
     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.
     33
     34Similarly, 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 your TracIni file. 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 the file is of a known type, like `java`.
    3239
    3340=== List of Languages Supported, by Highlighter #language-supported
     
    4350|| C#              ||                 ||  ✓ ^[#a1 (1)]^  ||  ✓  ||
    4451|| C++             ||  ✓              ||  ✓              ||  ✓  ||
     52|| CMake           ||  ?              ||  ?              ||  ✓  ||
    4553|| Java            ||  ✓ ^[#a2 (2)]^  ||  ✓              ||  ✓  ||
    4654|| Awk             ||                 ||  ✓              ||     ||
     
    8795
    8896
    89 
    9097''[=#a1 (1)] Not included in the Enscript distribution.  Additional highlighting rules can be obtained for
    9198[http://neugierig.org/software/ruby/ Ruby],
    9299[http://wiki.hasno.info/index.php/Csharp.st C#],
    93 [http://wiki.hasno.info/index.php/F90.st Fortran 90x/2003]
     100[http://wiki.hasno.info/index.php/F90.st Fortran 90x/2003].
    94101
    95 ''[=#a2 (2)] since Silvercity 0.9.7 released on 2006-11-23
     102''[=#a2 (2)] since Silvercity 0.9.7 released on 2006-11-23.
    96103
    97104''[=#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"].
    98105
    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/
    104 
    105106----
    106107See also: WikiProcessors, WikiFormatting, TracWiki, TracBrowser