Changes between Version 2 and Version 3 of TracSyntaxColoring


Ignore:
Timestamp:
11/14/18 14:30:18 (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracSyntaxColoring

    v2 v3  
    1 = Syntax Coloring of Source Code =
    2 Trac supports language-specific syntax highlighting of source code in [wiki:WikiFormatting wiki formatted] text and the [wiki:TracBrowser repository browser].
     1= Syntax Coloring of Source Code
     2Trac supports language-specific syntax highlighting of source code within wiki formatted text in [WikiProcessors#CodeHighlightingSupport wiki processors] blocks and in the [TracBrowser repository browser]. Syntax coloring is provided using [http://pygments.org/ Pygments], which covers a wide range of programming languages and other structured texts, and is actively supported. If Pygments is not available, Trac will display the content as plain text.
    33
    4 To do this, Trac uses external libraries with support for a great number of programming languages.
     4== About Pygments
    55
    6 Currently Trac supports syntax coloring using one or more of the following packages:
     6[http://pygments.org/ Pygments] is a highlighting library implemented in pure python, very fast, easy to extend and [http://pygments.org/docs/ well documented].
    77
    8  * [http://www.codento.com/people/mtr/genscript/ GNU Enscript]
    9  * [http://silvercity.sourceforge.net/ SilverCity]
    10  * [http://pygments.pocoo.org/ Pygments] (but needs a plugin for 0.10, see [#AboutPygments below])
     8The 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].
    119
    12 To 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`.
     10[http://pygments.org/docs/lexers/ Pygments lexer] options can be specified as [WikiProcessors WikiProcessor] arguments and defaults can be set in the [TracIni#pygments-lexer-section environment configuration].
    1311
    14 If 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
     12== Syntax Coloring Support
    1513
    16 When in use, Trac will automatically prioritize !SilverCity highlighting over Enscript if possible, (see note below).
     14=== Supported languages
    1715
    18 If neither package is available, Trac will display the data as plain text.
     16The list of currently supported languages can be found on the [http://pygments.org/languages/ supported languages] page. The list represents the languages supported in the most recent version of Pygments, so the languages actually supported in your installation could differ if you have an older version installed. The listing of [http://pygments.org/docs/lexers/ supported lexers] provides additional information about the default mime type to keyword mappings.
    1917
    20 '''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.
     18Explicit control of the mime type associated with a [WikiProcessors WikiProcessor] and file extension is available through the `mime_map` setting. For example, by default `.m` files are considered Objective-C files. In order to treat `.m` files as MATLAB files, add `text/matlab:m` to the [wiki:TracIni#mimeviewer-mime_map-option "[mimeviewer] mime_map"] option.
    2119
    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.
     20If 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`.
    2421
    25 === About Pygments ===
     22=== Direct Rendering
    2623
    27 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]. While it does not support as many languages as Enscript or Scintilla the overall output quality is much better.
     24Rich content may be directly //rendered// instead of syntax highlighted. This usually depends on which auxiliary packages are installed and 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. It will be syntax highlighted otherwise.
    2825
    29 To 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].
     26Similarly, 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. If you want to ensure that an HTML document gets syntax highlighted and not rendered, use the `text/xml` mimetype.
    3027
    31 The 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].
     28HTML documents are directly rendered only if the `render_unsafe_html` settings are enabled in your TracIni file. See [TracIni#attachment-render_unsafe_content-option "[attachment] render_unsafe_content"], [TracIni#browser-render_unsafe_content-option "[browser] render_unsafe_content"] and [TracIni#wiki-render_unsafe_content-option "[wiki] render_unsafe_content"]. The setting is present in multiple sections because there are different security concerns depending on where the document comes from.
    3229
    33 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.
     30=== Known MIME types
    3431
    35 
    36 == Syntax Coloring Support ==
    37 
    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) || ||
    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 ||
    88 
    89 ''(*) Supported as inline code blocks in [wiki:WikiFormatting Wiki text] using WikiProcessors.''
    90 
    91 ''(1) Ruby highlighting is not included in the Enscript distribution.  Highlighting rules for Ruby can be obtained from: http://neugierig.org/software/ruby/
    92 
    93 ''(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
    94 
    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 
    101 == Extra Software ==
    102  * GNU Enscript -- http://directory.fsf.org/GNU/enscript.html
    103  * GNU Enscript for Windows -- http://gnuwin32.sourceforge.net/packages/enscript.htm
    104  * !SilverCity -- http://silvercity.sf.net/
    105  * Pygments -- http://pygments.org/
     32[[KnownMimeTypes]]
    10633
    10734----
    10835See also: WikiProcessors, WikiFormatting, TracWiki, TracBrowser
    109