Changes between Version 1 and Version 2 of TracSyntaxColoring


Ignore:
Timestamp:
24 May 2018, 12:41:09 (6 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracSyntaxColoring

    v1 v2  
    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.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)//
     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 [http://pygments.org/ Pygments] is 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
     
    3232Note 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.
    3333
    34 In 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.
     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.
    3535
    36 HTML 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.
     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.
    3737
    38 If 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'.
     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`.
    3939
    4040=== List of Languages Supported, by Highlighter #language-supported
     
    9595
    9696
    97 
    9897''[=#a1 (1)] Not included in the Enscript distribution.  Additional highlighting rules can be obtained for
    9998[http://neugierig.org/software/ruby/ Ruby],
    10099[http://wiki.hasno.info/index.php/Csharp.st C#],
    101 [http://wiki.hasno.info/index.php/F90.st Fortran 90x/2003]
     100[http://wiki.hasno.info/index.php/F90.st Fortran 90x/2003].
    102101
    103 ''[=#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.
    104103
    105104''[=#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"].
    106105
    107 == Extra Software ==
    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/**
    112 
    113106----
    114107See also: WikiProcessors, WikiFormatting, TracWiki, TracBrowser