Edgewall Software

Changes between Version 60 and Version 61 of TracSyntaxColoring


Ignore:
Timestamp:
Jan 26, 2016, 10:16:26 AM (8 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • TracSyntaxColoring

    v60 v61  
    1 = Syntax Coloring of Source Code =
     1[[PageOutline(2-5,Contents,pullout)]]
     2
     3= Syntax Coloring of Source Code
     4
    25[[TranslatedPages]]
     6
    37Trac supports language-specific syntax highlighting of source code within wiki formatted text in [WikiProcessors#CodeHighlightingSupport wiki processors] blocks and in the [TracBrowser repository browser].
    48
     
    711Currently Trac supports syntax coloring using one or more of the following packages:
    812
    9  * [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
    10  * [http://www.codento.com/people/mtr/genscript/ GNU Enscript], commonly available on Unix but somewhat unsupported on Windows //(use is deprecated)//
    11  * [http://silvercity.sourceforge.net/ SilverCity], legacy system, some versions can be problematic //(use is deprecated)//
     13 * '''[http://pygments.org/ Pygments]''', the preferred system, as it covers a wide range of programming languages and other structured texts and is actively supported.
     14 * [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.
     15 * [http://silvercity.sourceforge.net/ SilverCity], legacy system, some versions can be problematic; use is deprecated.
    1216
     17To 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.
    1318
    14 To activate syntax coloring, simply install either one (or more) of these packages (see [#ExtraSoftware] section below).
    15 If none of these packages is available, Trac will display the data as plain text.
     19== About Pygments
    1620
     21Pygments is a highlighting library implemented in pure Python, very fast, easy to extend and [http://pygments.org/docs/ well documented].
    1722
    18 === About Pygments ===
     23The 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].
    1924
    20 [http://pygments.org/ Pygments] is a highlighting library implemented in pure python, very fast, easy to extend and [http://pygments.org/docs/ well documented].
     25The list below contains only the most commonly used processors and the [http://pygments.org/docs/lexers/ list of supported Pygments lexers] is growing weekly.
    2126
    22 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].
    23 
    24 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.
    25 
    26 
    27 == Syntax Coloring Support ==
     27== Syntax Coloring Support
    2828
    2929=== Known MIME Types
     
    3333Note 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.
    3434
    35 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.
     35Similarly, 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.
    3636
    37 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.
     37HTML 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.
    3838
    39 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'.
     39If 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`.
    4040
    4141=== List of Languages Supported, by Highlighter #language-supported
     
    9696
    9797
    98 
    9998''[=#a1 (1)] Not included in the Enscript distribution.  Additional highlighting rules can be obtained for
    10099[http://neugierig.org/software/ruby/ Ruby],
    101100[http://wiki.hasno.info/index.php/Csharp.st C#],
    102 [http://wiki.hasno.info/index.php/F90.st Fortran 90x/2003]
     101[http://wiki.hasno.info/index.php/F90.st Fortran 90x/2003].
    103102
    104 ''[=#a2 (2)] since Silvercity 0.9.7 released on 2006-11-23
     103''[=#a2 (2)] since Silvercity 0.9.7 released on 2006-11-23.
    105104
    106105''[=#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"].
    107106
    108 == Extra Software ==
    109  * GNU Enscript — http://www.gnu.org/software/enscript/
    110  * GNU Enscript for Windows — http://gnuwin32.sourceforge.net/packages/enscript.htm
    111  * !SilverCity — http://silvercity.sf.net/
    112  * **Pygments — http://pygments.org/**
    113 
    114107----
    115108See also: WikiProcessors, WikiFormatting, TracWiki, TracBrowser